Class RcsbFvConfig

Board track configuration manager className

Hierarchy

  • RcsbFvConfig

Implements

Constructors

constructor

Properties

boardId displayColor? displayConfig? displayDomain? displayType dynamicDisplay? elementClickCallback? elementEnterCallback? elementId? elementLeaveCallback? hideEmptyTrackFlag? hideInnerBorder? hideRowGlow? highlightHoverCallback? highlightHoverElement? highlightHoverPosition? includeTooltip? interpolationType? length minRatio? nonEmptyDisplay? overlap range selectDataInRangeFlag? tooltipGenerator? trackColor? trackData? trackHeight? trackId trackWidth? updateDataOnMove?

Methods

addTrackData configCheck getInterpolationType resetTrackData updateConfig updateTrackData

Constructors

constructor

Properties

boardId

boardId: string

DOM element Id where the PFV will be rendered

Optional displayColor

displayColor?: string | RcsbFvColorGradient

Annotation elements color

Optional displayConfig

displayConfig?: RcsbFvDisplayConfigInterface[]

Array of display configurations in composite displays

Optional displayDomain

displayDomain?: [number, number]

Y scale domain range

displayType

displayType: RcsbFvDisplayTypes

Type of data representation

Optional dynamicDisplay

dynamicDisplay?: boolean

Type of data representation

Optional elementClickCallback

elementClickCallback?: ((d?, e?) => void)

Type declaration

Optional elementEnterCallback

elementEnterCallback?: ((d?, e?) => void)

Type declaration

Optional elementId

elementId?: string

DOM element Id where the board track is displayed

Optional elementLeaveCallback

elementLeaveCallback?: ((d?, e?) => void)

Type declaration

Optional hideEmptyTrackFlag

hideEmptyTrackFlag?: boolean

Hide tracks with no visible data. Needs selectDataInRangeFlag = true

Optional hideInnerBorder

hideInnerBorder?: boolean

Hide bottom border (last row is ignored)

Optional hideRowGlow

hideRowGlow?: boolean

Hide row hover glow

Optional highlightHoverCallback

highlightHoverCallback?: ((n) => void)

Type declaration

Optional highlightHoverElement

highlightHoverElement?: boolean

Set highlight hover track elements

Optional highlightHoverPosition

highlightHoverPosition?: boolean

Set highlight hover position

Optional includeTooltip

includeTooltip?: boolean

Show tooltip when hovering annotations in this specific track

Optional interpolationType

interpolationType?: string

Interpolation type for sequence scalar annotations

length

length: number

Length of the track. If length is provided the track coordinates will range from 1 to

Optional minRatio

minRatio?: number

Residue density threshold used to display/hide annotations

Optional nonEmptyDisplay

nonEmptyDisplay?: boolean

Flag used in sequence display type to force displaying a line when sequence objects are not visible

overlap

overlap: boolean = false

If true, track annotations can overlap

range

range: {
    max: number;
    min: number;
}

Range of the track. If range is provided the track coordinates will range from to

Type declaration

  • max: number
  • min: number

Optional selectDataInRangeFlag

selectDataInRangeFlag?: boolean

Only data that fall in the current feature viewer range in rendered

Optional tooltipGenerator

tooltipGenerator?: RcsbFvTooltipInterface

Tooltip generation

Optional trackColor

trackColor?: string

Background color of the track

Optional trackData

trackData?: RcsbFvTrackData<{
    [k: string]: any;
}>

Data structure containing the annotations

Type declaration

  • [k: string]: any

Optional trackHeight

trackHeight?: number

Full length of the track

trackId

trackId: string

Id used to identify the board track

Optional trackWidth

trackWidth?: number

Full length of the track

Optional updateDataOnMove

updateDataOnMove?: ((d) => Promise<RcsbFvTrackData<{
    [k: string]: any;
}>>)

Type declaration

Methods

addTrackData

configCheck

getInterpolationType

resetTrackData

updateConfig

updateTrackData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc