Interface RcsbFvDisplayConfigInterface

Display config object for composite displays

Hierarchy

Properties

displayColor? displayData? displayId? displayType dynamicDisplay? elementClickCallback? elementEnterCallback? elementLeaveCallback? hideEmptyTrackFlag? includeTooltip? minRatio? nonEmptyDisplay? selectDataInRangeFlag? updateDataOnMove?

Properties

Optional displayColor

displayColor?: string | RcsbFvColorGradient

Annotation elements color

Optional displayData

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

Data structure containing the annotations for the display

Type declaration

  • [k: string]: any

Optional displayId

displayId?: string

Id used to identify the display

displayType

displayType: RcsbFvDisplayTypes

Type of data representation

Optional dynamicDisplay

dynamicDisplay?: boolean

Type of data representation

Optional elementClickCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when annotations in this track are clicked

      Parameters

      Returns void

Optional elementEnterCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when clicking annotations in this track

      Parameters

      Returns void

Optional elementLeaveCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when mouse-leaving a track annotation

      Parameters

      Returns void

Optional hideEmptyTrackFlag

hideEmptyTrackFlag?: boolean

Hide tracks with no visible data. Needs selectDataInRangeFlag = true

Optional includeTooltip

includeTooltip?: boolean

Show tooltip when hovering annotations in this specific track

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

Optional selectDataInRangeFlag

selectDataInRangeFlag?: boolean

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

Optional updateDataOnMove

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

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc