Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RcsbFvTrackDataElementInterface

Annotation Element Interface

Hierarchy

  • RcsbFvTrackDataElementInterface

Index

Properties

Methods

Properties

begin

begin: number

Annotation start position

Optional beginName

beginName?: string

Name of the start position. This information might be displayed in the annotation tooltip

Optional color

color?: string

Annotation displayed color

Optional description

description?: string[]

Description associated to the annotation. This information might be displayed in the annotation tooltip

Optional end

end?: number

Annotation end position

Optional endName

endName?: string

Name of the end position. This information might be displayed in the annotation tooltip

Optional featureId

featureId?: string

Annotation Id

Optional gValue

gValue?: string | number

Annotation global value. E.g. whole interface energy

Optional gaps

gaps?: RcsbFvTrackDataElementGapInterface[]

Annotation gaps that should be displayed as a dashed line

Optional indexName

indexName?: string

Name of the original reference. This information might be displayed in the annotation tooltip

Optional isEmpty

isEmpty?: boolean

Annotation inner region should not be highlighted

Optional label

label?: string

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

Optional name

name?: string

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

Optional nonSpecific

nonSpecific?: boolean

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

Optional openBegin

openBegin?: boolean

Draw a circle on the start side of blocks

Optional openEnd

openEnd?: boolean

Draw a circle on the end side of blocks

Optional oriBegin

oriBegin?: number

Annotation original reference start position. This information might be displayed in the annotation tooltip

Optional oriBeginName

oriBeginName?: string

Name of the original reference start position. This information might be displayed in the annotation tooltip

Optional oriEnd

oriEnd?: number

Annotation original reference end position. This information might be displayed in the annotation tooltip

Optional oriEndName

oriEndName?: string

Name of the original reference end position. This information might be displayed in the annotation tooltip

Optional provenanceColor

provenanceColor?: string

color associated to the resource that dispatched the data

Optional provenanceName

provenanceName?: string

Name of the resource that dispatched the data

Optional rectBegin

rectBegin?: number

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

Optional rectEnd

rectEnd?: number

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

Optional source

source?: string

Source reference database name

Optional sourceId

sourceId?: string

Id of the annotation element (protein or gene) source

Optional title

title?: string

Track title. This information might be displayed in the annotation tooltip

Optional type

type?: string

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

Optional value

value?: string | number

Annotation local value. E.g. interface residue energy

Optional values

values?: number[]

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

Methods

Optional elementClickCallBack

  • Callback when the annotation is clicked

    Parameters

    Returns void

Generated using TypeDoc