Interface RcsbFvBoardConfigInterface

Main PFV board configuration

Hierarchy

  • RcsbFvBoardConfigInterface

Properties

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

Properties

Optional borderColor

borderColor?: string

Feature cells border color

Optional borderWidth

borderWidth?: number

Feature cells border width

Optional disableMenu

disableMenu?: boolean

Disable UI menu

Optional elementClickCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when a track annotation is clicked

      Parameters

      Returns void

Optional elementEnterCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when hovering a track annotation

      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 hideInnerBorder

hideInnerBorder?: boolean

Hide all row bottom border except for the last one

Optional hideRowGlow

hideRowGlow?: boolean

Hide row hover glow

Optional hideTrackFrameGlow

hideTrackFrameGlow?: boolean

Hide PFV tracks main frame border glow

Optional highlightHoverCallback

highlightHoverCallback?: ((n) => void)

Type declaration

Optional highlightHoverElement

highlightHoverElement?: boolean

Set highlight hover track elements

Optional highlightHoverPosition

highlightHoverPosition?: boolean

Set highlight hover position

Optional includeAxis

includeAxis?: boolean

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

Optional includeTooltip

includeTooltip?: boolean

Show tooltip when hovering track annotations

Optional length

length?: number

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

Optional onFvRenderStartsCallback

onFvRenderStartsCallback?: (() => void)

Type declaration

    • (): void

    • Callback function called when the feature viewer rendering starts

      Returns void

Optional range

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

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

Type declaration

  • max: number
  • min: number

Optional rowTitleWidth

rowTitleWidth?: number

Width of the track title cells

Optional selectionChangeCallback

selectionChangeCallback?: ((selection) => void)

Type declaration

Optional tooltipGenerator

tooltipGenerator?: RcsbFvTooltipInterface

Tooltip generation

Optional trackWidth

trackWidth?: number

Width of the track annotation cells

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc