Interface RcsbFvRowExtendedConfigInterface<P, S, R, M>

Board track configuration object

interface RcsbFvRowExtendedConfigInterface<
    P extends { [k: string]: any } = {},
    S extends { [k: string]: any } = {},
    R extends { [k: string]: any } = {},
    M extends { [k: string]: any } = {},
> {
    boardId: string;
    borderColor?: string;
    borderWidth?: number;
    displayColor?: string | RcsbFvColorGradient;
    displayConfig?: RcsbFvDisplayConfigInterface[];
    displayDomain?: [number, number];
    displayType: RcsbFvDisplayTypes;
    dynamicDisplay?: boolean;
    elementClickCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementEnterCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementId?: string;
    elementLeaveCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    externalRowTitle?: {
        rowTitleAdditionalProps: P;
        rowTitleComponent: RowTitleComponentType<P, S>;
    };
    fitTitleWidth?: boolean;
    hideEmptyTrackFlag?: boolean;
    hideInnerBorder?: boolean;
    hideRowGlow?: boolean;
    highlightHoverCallback?: (n: RcsbFvTrackDataElementInterface[]) => void;
    highlightHoverElement?: boolean;
    highlightHoverPosition?: boolean;
    includeTooltip?: boolean;
    interpolationType?: string;
    length?: number;
    metadata?: M;
    minRatio?: number;
    nonEmptyDisplay?: boolean;
    overlap?: boolean;
    range?: { max: number; min: number };
    rowMark?: RcsbFvRowMarkPublicInterface<R>;
    rowPrefix?: string;
    rowTitle?: string | RcsbFvLink;
    rowTitleWidth?: number;
    selectDataInRangeFlag?: boolean;
    titleFlagColor?: string;
    tooltipGenerator?: RcsbFvTooltipInterface;
    trackColor?: string;
    trackData?: RcsbFvTrackData<{ [k: string]: any }>;
    trackHeight?: number;
    trackId: string;
    trackVisibility?: boolean;
    trackWidth?: number;
    updateDataOnMove?: (
        d: LocationViewInterface,
    ) => Promise<RcsbFvTrackData<{ [k: string]: any }>>;
}

Type Parameters

  • P extends { [k: string]: any } = {}
  • S extends { [k: string]: any } = {}
  • R extends { [k: string]: any } = {}
  • M extends { [k: string]: any } = {}

Hierarchy (View Summary)

Implemented by

Properties

boardId borderColor? borderWidth? displayColor? displayConfig? displayDomain? displayType dynamicDisplay? elementClickCallback? elementEnterCallback? elementId? elementLeaveCallback? externalRowTitle? fitTitleWidth? hideEmptyTrackFlag? hideInnerBorder? hideRowGlow? highlightHoverCallback? highlightHoverElement? highlightHoverPosition? includeTooltip? interpolationType? length? metadata? minRatio? nonEmptyDisplay? overlap? range? rowMark? rowPrefix? rowTitle? rowTitleWidth? selectDataInRangeFlag? titleFlagColor? tooltipGenerator? trackColor? trackData? trackHeight? trackId trackVisibility? trackWidth? updateDataOnMove?

Properties

boardId

boardId: string

DOM element Id where the PFV will be rendered

OptionalborderColor

borderColor?: string

Sequence feature cell Border color

OptionalborderWidth

borderWidth?: number

Feature cell border width

OptionaldisplayColor

displayColor?: string | RcsbFvColorGradient

Annotation elements color

OptionaldisplayConfig

displayConfig?: RcsbFvDisplayConfigInterface[]

Array of display configurations in composite displays

OptionaldisplayDomain

displayDomain?: [number, number]

Y scale domain range

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

OptionalelementId

elementId?: string

DOM element Id where the board track is displayed

OptionalelementLeaveCallback

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

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

OptionalexternalRowTitle

externalRowTitle?: {
    rowTitleAdditionalProps: P;
    rowTitleComponent: RowTitleComponentType<P, S>;
}

Custom row title react component

OptionalfitTitleWidth

fitTitleWidth?: boolean

Compute the title/prefix width based on the relative proportion length

OptionalhideEmptyTrackFlag

hideEmptyTrackFlag?: boolean

Hide tracks with no visible data. Needs selectDataInRangeFlag = true

OptionalhideInnerBorder

hideInnerBorder?: boolean

Hide bottom border (last row is ignored)

OptionalhideRowGlow

hideRowGlow?: boolean

Hide row hover glow

OptionalhighlightHoverCallback

highlightHoverCallback?: (n: RcsbFvTrackDataElementInterface[]) => void

Function call on hover event

OptionalhighlightHoverElement

highlightHoverElement?: boolean

Set highlight hover track elements

OptionalhighlightHoverPosition

highlightHoverPosition?: boolean

Set highlight hover position

OptionalincludeTooltip

includeTooltip?: boolean

Show tooltip when hovering annotations in this specific track

OptionalinterpolationType

interpolationType?: string

Interpolation type for sequence scalar annotations

Optionallength

length?: number

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

Optionalmetadata

metadata?: M

External metadata

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

Optionaloverlap

overlap?: boolean

If true, track annotations can overlap

Optionalrange

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

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

OptionalrowMark

rowMark?: RcsbFvRowMarkPublicInterface<R>

Track mark events callbacks

OptionalrowPrefix

rowPrefix?: string

Row title txt prefix

OptionalrowTitle

rowTitle?: string | RcsbFvLink

Row title text or link

OptionalrowTitleWidth

rowTitleWidth?: number

Length of the track title cell

OptionalselectDataInRangeFlag

selectDataInRangeFlag?: boolean

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

OptionaltitleFlagColor

titleFlagColor?: string

Color displayed between track title and track annotations

OptionaltooltipGenerator

tooltipGenerator?: RcsbFvTooltipInterface

Tooltip generation

OptionaltrackColor

trackColor?: string

Background color of the track

OptionaltrackData

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

Data structure containing the annotations

OptionaltrackHeight

trackHeight?: number

Full length of the track

trackId

trackId: string

Id used to identify the board track

OptionaltrackVisibility

trackVisibility?: boolean

The track must dbe hide

OptionaltrackWidth

trackWidth?: number

Full length of the track

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