Interface RcsbFvBlockDataElementInterface

Annotation Element Interface

interface RcsbFvBlockDataElementInterface {
    begin: number;
    color?: string;
    elementClickCallback?: (
        x: RcsbFvTrackDataElementInterface,
        e?: MouseEvent,
    ) => void;
    end?: number;
    gaps?: RcsbFvTrackDataElementGapInterface[];
    isEmpty?: boolean;
    label?: string;
    nonSpecific?: boolean;
    openBegin?: boolean;
    openEnd?: boolean;
    rectBegin?: number;
    rectEnd?: number;
    value?: number;
    values?: number[];
}

Hierarchy (View Summary)

Properties

begin color? elementClickCallback? end? gaps? isEmpty? label? nonSpecific? openBegin? openEnd? rectBegin? rectEnd? value? values?

Properties

begin

begin: number

Annotation start position

Optionalcolor

color?: string

Annotation displayed color

OptionalelementClickCallback

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

Callback when the annotation is clicked

Optionalend

end?: number

Annotation end position

Optionalgaps

gaps?: RcsbFvTrackDataElementGapInterface[]

Annotation gaps that should be displayed as a dashed line

OptionalisEmpty

isEmpty?: boolean

Annotation inner region should not be highlighted

Optionallabel

label?: string

Annotation label. This information might be displayed in the annotation tooltip

OptionalnonSpecific

nonSpecific?: boolean

Annotation object is not a real annotation but a selected area from the user

OptionalopenBegin

openBegin?: boolean

Draw a circle on the start side of blocks

OptionalopenEnd

openEnd?: boolean

Draw a circle on the end side of blocks

OptionalrectBegin

rectBegin?: number

Alternative begin position for rects in block displays. It is used to split annotation into multiple rects when gaps are included

OptionalrectEnd

rectEnd?: number

Alternative begin position for rects in block displays. It is used to split annotation into multiple rects when gaps are included

Optionalvalue

value?: number

Annotation local value. E.g. interface residue energy

Optionalvalues

values?: number[]

Annotation local multidimensional value. E.g. Surface normal vector

Settings

Member Visibility

On This Page

Properties