@rcsb/rcsb-saguaro
    Preparing search index...

    Interface CommonConfigInterface

    interface CommonConfigInterface {
        displayColor?: string | RcsbFvColorGradient;
        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)

    Index

    Properties

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

    Properties

    displayColor?: string | RcsbFvColorGradient

    Annotation elements color

    displayType: RcsbFvDisplayTypes

    Type of data representation

    dynamicDisplay?: boolean

    Type of data representation

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

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

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

    Function that will be called when clicking annotations in this track

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

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

    hideEmptyTrackFlag?: boolean

    Hide tracks with no visible data. Needs selectDataInRangeFlag = true

    includeTooltip?: boolean

    Show tooltip when hovering annotations in this specific track

    minRatio?: number

    Residue density threshold used to display/hide annotations

    nonEmptyDisplay?: boolean

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

    selectDataInRangeFlag?: boolean

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

    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