Interface RcsbFvDisplayConfigInterface

Display config object for composite displays

interface RcsbFvDisplayConfigInterface {
    displayColor?: string | RcsbFvColorGradient;
    displayData?: RcsbFvTrackData<{ [k: string]: any }>;
    displayId?: string;
    displayType: RcsbFvDisplayTypes;
    dynamicDisplay?: boolean;
    elementClickCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementEnterCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementLeaveCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    hideEmptyTrackFlag?: boolean;
    includeTooltip?: boolean;
    minRatio?: number;
    nonEmptyDisplay?: boolean;
    selectDataInRangeFlag?: boolean;
    updateDataOnMove?: (
        d: LocationViewInterface,
    ) => Promise<RcsbFvTrackData<{ [k: string]: any }>>;
}

Hierarchy (View Summary)

Properties

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

Properties

OptionaldisplayColor

displayColor?: string | RcsbFvColorGradient

Annotation elements color

OptionaldisplayData

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

Data structure containing the annotations for the display

OptionaldisplayId

displayId?: string

Id used to identify the display

displayType

displayType: RcsbFvDisplayTypes

Type of data representation

OptionaldynamicDisplay

dynamicDisplay?: boolean

Type of data representation

OptionalelementClickCallback

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

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

OptionalelementEnterCallback

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

Function that will be called when clicking annotations in this track

OptionalelementLeaveCallback

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

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

OptionalhideEmptyTrackFlag

hideEmptyTrackFlag?: boolean

Hide tracks with no visible data. Needs selectDataInRangeFlag = true

OptionalincludeTooltip

includeTooltip?: boolean

Show tooltip when hovering annotations in this specific track

OptionalminRatio

minRatio?: number

Residue density threshold used to display/hide annotations

OptionalnonEmptyDisplay

nonEmptyDisplay?: boolean

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

OptionalselectDataInRangeFlag

selectDataInRangeFlag?: boolean

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

OptionalupdateDataOnMove

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

Function that will be called to update track displayed data when the board is moved or zoomed

Settings

Member Visibility

On This Page

Properties