Interface RcsbFvBoardConfigInterface

Main PFV board configuration

interface RcsbFvBoardConfigInterface {
    borderColor?: string;
    borderWidth?: number;
    disableMenu?: boolean;
    elementClickCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementEnterCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    elementLeaveCallback?: (
        d?: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    hideInnerBorder?: boolean;
    hideRowGlow?: boolean;
    hideTrackFrameGlow?: boolean;
    highlightHoverCallback?: (n: RcsbFvTrackDataElementInterface[]) => void;
    highlightHoverElement?: boolean;
    highlightHoverPosition?: boolean;
    includeAxis?: boolean;
    includeTooltip?: boolean;
    length?: number;
    onFvRenderStartsCallback?: () => void;
    range?: { max: number; min: number };
    rowTitleWidth?: number;
    selectionChangeCallback?: (
        selection: RcsbFvTrackDataElementInterface[],
    ) => void;
    tooltipGenerator?: RcsbFvTooltipInterface;
    trackWidth?: number;
}

Properties

borderColor? borderWidth? disableMenu? elementClickCallback? elementEnterCallback? elementLeaveCallback? hideInnerBorder? hideRowGlow? hideTrackFrameGlow? highlightHoverCallback? highlightHoverElement? highlightHoverPosition? includeAxis? includeTooltip? length? onFvRenderStartsCallback? range? rowTitleWidth? selectionChangeCallback? tooltipGenerator? trackWidth?

Properties

OptionalborderColor

borderColor?: string

Feature cells border color

OptionalborderWidth

borderWidth?: number

Feature cells border width

OptionaldisableMenu

disableMenu?: boolean

Disable UI menu

OptionalelementClickCallback

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

Function that will be called when a track annotation is clicked

OptionalelementEnterCallback

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

Function that will be called when hovering a track annotation

OptionalelementLeaveCallback

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

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

OptionalhideInnerBorder

hideInnerBorder?: boolean

Hide all row bottom border except for the last one

OptionalhideRowGlow

hideRowGlow?: boolean

Hide row hover glow

OptionalhideTrackFrameGlow

hideTrackFrameGlow?: boolean

Hide PFV tracks main frame border 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

OptionalincludeAxis

includeAxis?: boolean

Include axis track. It will be displayed in the first board track

OptionalincludeTooltip

includeTooltip?: boolean

Show tooltip when hovering track annotations

Optionallength

length?: number

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

OptionalonFvRenderStartsCallback

onFvRenderStartsCallback?: () => void

Callback function called when the feature viewer rendering starts

Optionalrange

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

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

OptionalrowTitleWidth

rowTitleWidth?: number

Width of the track title cells

OptionalselectionChangeCallback

selectionChangeCallback?: (selection: RcsbFvTrackDataElementInterface[]) => void

Function that will be called when selection changes

OptionaltooltipGenerator

tooltipGenerator?: RcsbFvTooltipInterface

Tooltip generation

OptionaltrackWidth

trackWidth?: number

Width of the track annotation cells

Settings

Member Visibility

On This Page

Properties