Interface RcsbFvRowExtendedConfigInterface<P, S, R, M>

Board track configuration object

Type Parameters

  • P extends {
        [k: string]: any;
    } = {}

  • S extends {
        [k: string]: any;
    } = {}

  • R extends {
        [k: string]: any;
    } = {}

  • M extends {
        [k: string]: any;
    } = {}

Hierarchy

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

Optional borderColor

borderColor?: string

Sequence feature cell Border color

Optional borderWidth

borderWidth?: number

Feature cell border width

Optional displayColor

displayColor?: string | RcsbFvColorGradient

Annotation elements color

Optional displayConfig

displayConfig?: RcsbFvDisplayConfigInterface[]

Array of display configurations in composite displays

Optional displayDomain

displayDomain?: [number, number]

Y scale domain range

displayType

displayType: RcsbFvDisplayTypes

Type of data representation

Optional dynamicDisplay

dynamicDisplay?: boolean

Type of data representation

Optional elementClickCallback

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

Type declaration

    • (d?, e?): void

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

      Parameters

      Returns void

Optional elementEnterCallback

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

Type declaration

    • (d?, e?): void

    • Function that will be called when clicking annotations in this track

      Parameters

      Returns void

Optional elementId

elementId?: string

DOM element Id where the board track is displayed

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 externalRowTitle

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

Custom row title react component

Type declaration

Optional fitTitleWidth

fitTitleWidth?: boolean

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

Optional hideEmptyTrackFlag

hideEmptyTrackFlag?: boolean

Hide tracks with no visible data. Needs selectDataInRangeFlag = true

Optional hideInnerBorder

hideInnerBorder?: boolean

Hide bottom border (last row is ignored)

Optional hideRowGlow

hideRowGlow?: boolean

Hide row hover 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 includeTooltip

includeTooltip?: boolean

Show tooltip when hovering annotations in this specific track

Optional interpolationType

interpolationType?: string

Interpolation type for sequence scalar annotations

Optional length

length?: number

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

Optional metadata

metadata?: M

External metadata

Optional minRatio

minRatio?: number

Residue density threshold used to display/hide annotations

Optional nonEmptyDisplay

nonEmptyDisplay?: boolean

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

Optional overlap

overlap?: boolean

If true, track annotations can overlap

Optional range

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

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

Type declaration

  • max: number
  • min: number

Optional rowMark

rowMark?: RcsbFvRowMarkPublicInterface<R>

Track mark events callbacks

Optional rowPrefix

rowPrefix?: string

Row title txt prefix

Optional rowTitle

rowTitle?: string | RcsbFvLink

Row title text or link

Optional rowTitleWidth

rowTitleWidth?: number

Length of the track title cell

Optional selectDataInRangeFlag

selectDataInRangeFlag?: boolean

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

Optional titleFlagColor

titleFlagColor?: string

Color displayed between track title and track annotations

Optional tooltipGenerator

tooltipGenerator?: RcsbFvTooltipInterface

Tooltip generation

Optional trackColor

trackColor?: string

Background color of the track

Optional trackData

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

Data structure containing the annotations

Type declaration

  • [k: string]: any

Optional trackHeight

trackHeight?: number

Full length of the track

trackId

trackId: string

Id used to identify the board track

Optional trackVisibility

trackVisibility?: boolean

The track must dbe hide

Optional trackWidth

trackWidth?: number

Full length of the track

Optional updateDataOnMove

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

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc