Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RcsbFv

Protein Feature Viewer entry point

Hierarchy

  • RcsbFv

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns RcsbFv

Properties

Private boardConfigData

boardConfigData: any

Global board configuration

Private checkFvTrackConfig

checkFvTrackConfig: any

Method used to check data config properties

param rowConfigData

Array of track configurations

Private Readonly contextManager

contextManager: any

rxjs event based handler used to communicate events (click, highlight, move) between board tracks

Private elementId

elementId: any

DOM elemnt id where the board will be displayed

Private identifyFvTracks

identifyFvTracks: any

Method used to check and force the identification for each track

param rowConfigData

Array of track configurations

Private mounted

mounted: any

Flag indicating that the React component has been mounted

Private rcsbFvPromise

rcsbFvPromise: any

Private resolveOnReady

resolveOnReady: any

Private rowConfigData

rowConfigData: any

Configuration for each board track

Private Readonly selection

selection: any

Global selection shared among all tracks

Private trackIds

trackIds: any

Array storing board tracks ids

Private Readonly xScale

xScale: any

Global d3 Xscale object shaed among all board tracks

Static Private checkTrackVisibility

checkTrackVisibility: any

Checks track visibility attribute, if undefined it is set to true

param rowConfigData

Array of track configurations

Methods

addSelection

  • Add selection to board

    Parameters

    Returns void

addTrack

  • Adds a new track to the board

    Parameters

    Returns Promise<void>

addTrackData

  • Adds new annotations for a particular board track

    Parameters

    • trackId: string

      Id that identifies the track

    • data: RcsbFvTrackData

      Annotations to be added in the track

    Returns Promise<void>

catch

  • Parameters

    • f: () => void
        • (): void

        • Returns void

    Returns RcsbFv

changeTrackVisibility

  • Changes track visibility (true/false)

    Parameters

    Returns void

clearSelection

  • clearSelection(mode?: "select" | "hover"): void

  • Clear Selection

    Parameters

    • Optional mode: "select" | "hover"

    Returns void

getBoardConfig

getDomain

  • getDomain(): [number, number]

  • Get board view range

    Returns [number, number]

getSelection

  • Get selected board ranges

    Parameters

    • mode: "select" | "hover"

      selection type

    Returns SelectionInterface[]

getTrackIds

  • getTrackIds(): string[]

  • Returns all track Ids in the same order that are visualised in the board

    Returns string[]

init

  • init(): Promise<void>

  • Renders the board

    Returns Promise<void>

resetTrack

  • resetTrack(trackId: string): void

  • Rerender the board track

    Parameters

    • trackId: string

      Id that identifies the track

    Returns void

setBoardConfig

  • Loads the configuration of the board

    Parameters

    Returns void

setBoardData

  • Loads the configuration for each row of the board

    Parameters

    Returns void

setDomain

  • setDomain(domain: [number, number]): void

  • Change board view range

    Parameters

    • domain: [number, number]

      new xScale domain

    Returns void

setSelection

  • Select board range

    Parameters

    Returns void

then

  • Parameters

    • f: () => void
        • (): void

        • Returns void

    Returns RcsbFv

unmount

  • unmount(): void

  • Unmount the board

    Returns void

updateBoardConfig

  • Method used to update board global and all-tracks configuration

    Parameters

    Returns Promise<void>

updateTrackData

  • Replaces annotations a particular board track

    Parameters

    • trackId: string

      Id that identifies the track

    • data: RcsbFvTrackData

      New annotations to be displayed

    Returns Promise<void>

Generated using TypeDoc