Class RcsbFv<P, S, R, M>

Protein Feature Viewer entry point

Type Parameters

P extends { [k: string]: any } = {}
S extends { [k: string]: any } = {}
R extends { [k: string]: any } = {}
M extends { [k: string]: any } = {}

Constructors

constructor

new RcsbFv<
    P extends { [k: string]: any } = {},
    S extends { [k: string]: any } = {},
    R extends { [k: string]: any } = {},
    M extends { [k: string]: any } = {},
>(
    props: RcsbFvInterface<P, S, R, M>,
): RcsbFv<P, S, R, M>
Type Parameters
- P extends { [k: string]: any } = {}
- S extends { [k: string]: any } = {}
- R extends { [k: string]: any } = {}
- M extends { [k: string]: any } = {}
Parameters
- props: RcsbFvInterface<P, S, R, M>
Returns RcsbFv<P, S, R, M>
- Defined in src/RcsbFv/RcsbFv.tsx:75

Methods

addSelection

addSelection(selection: SetSelectionInterface): void
Add selection to board
Parameters
- selection: SetSelectionInterface
  region/elements
Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:295

addTrack

addTrack(trackConfig: RcsbFvRowConfigInterface<P, S, R, M>): Promise<void>
Adds a new track to the board
Parameters
- trackConfig: RcsbFvRowConfigInterface<P, S, R, M>
  Track configuration data
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:246

addTrackData

addTrackData(trackId: string, trackData: RcsbFvTrackData): Promise<void>
Adds new annotations for a particular board track
Parameters
- trackId: string
  Id that identifies the track
- trackData: RcsbFvTrackData
  Annotations to be added in the track
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:193

catch

catch(f: () => void): RcsbFv
Parameters
- f: () => void
Returns RcsbFv
- Defined in src/RcsbFv/RcsbFv.tsx:141

changeTrackVisibility

changeTrackVisibility(obj: TrackVisibilityInterface): Promise<void>
Changes track visibility (true/false)
Parameters
- obj: TrackVisibilityInterface
  Track visibility event data
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:254

clearSelection

clearSelection(mode?: "select" | "hover"): void
Clear Selection
Parameters
- Optionalmode: "select" | "hover"
Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:305

getBoardConfig

getBoardConfig(): RcsbFvBoardConfigInterface
Returns RcsbFvBoardConfigInterface
board configuration
- Defined in src/RcsbFv/RcsbFv.tsx:127

getBoardData

getBoardData(): RcsbFvRowConfigInterface<P, S, R, M>[]
Gets the configuration for each row of the board

Returns RcsbFvRowConfigInterface<P, S, R, M>[]
- Defined in src/RcsbFv/RcsbFv.tsx:112

getDomain

getDomain(): [number, number]
Get board view range

Returns [number, number]
- Defined in src/RcsbFv/RcsbFv.tsx:271

getSelection

getSelection(mode: "select" | "hover"): SelectionInterface[]
Get selected board ranges
Parameters
- mode: "select" | "hover"
  selection type
Returns SelectionInterface[]
- Defined in src/RcsbFv/RcsbFv.tsx:288

getTrackIds

getTrackIds(): string[]
Returns all track Ids in the same order that are visualised in the board

Returns string[]
- Defined in src/RcsbFv/RcsbFv.tsx:185

init

init(): Promise<void>
Renders the board

Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:152

moveTrack

moveTrack(oldIndex: number, newIndex: number): Promise<void>
Move board track
Parameters
- oldIndex: number
  original position
- newIndex: number
  new position *
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:320

reset

reset(): void
reset Selection and Scale

Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:328

resetTrack

resetTrack(trackId: string): Promise<void>
Rerender the board track
Parameters
- trackId: string
  Id that identifies the track
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:238

setBoardConfig

setBoardConfig(config: RcsbFvBoardConfigInterface): Promise<void>
Loads the configuration of the board
Parameters
- config: RcsbFvBoardConfigInterface
  Configuration of the board
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:120

setBoardData

setBoardData(
rowConfigData: RcsbFvRowConfigInterface<P, S, R, M>[],
): Promise<void>
Loads the configuration for each row of the board
Parameters
- rowConfigData: RcsbFvRowConfigInterface<P, S, R, M>[]
  Array of configurations for each row in the board
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:104

setDomain

setDomain(domain: [number, number]): void
Change board view range
Parameters
- domain: [number, number]
  new xScale domain
Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:262

setSelection

setSelection(selection: SetSelectionInterface): void
Select board range
Parameters
- selection: SetSelectionInterface
  region/elements
Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:278

then

then(f: () => void): RcsbFv
Parameters
- f: () => void
Returns RcsbFv
- Defined in src/RcsbFv/RcsbFv.tsx:131

unmount

unmount(): void
Unmount the board

Returns void
- Defined in src/RcsbFv/RcsbFv.tsx:174

updateBoardConfig

updateBoardConfig(
    newConfig: {
        boardConfigData?: RcsbFvBoardConfigInterface;
        rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[];
    },
): Promise<void>
Method used to update board global and all-tracks configuration
Parameters
- newConfig: {
  boardConfigData?: RcsbFvBoardConfigInterface;
  rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[];
  }
  New board configuration data
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:211

updateTrackData

updateTrackData(
    trackId: string,
    trackData: RcsbFvTrackData,
    displayId?: string,
): Promise<void>
Replaces annotations a particular board track
Parameters
- trackId: string
  Id that identifies the track
- trackData: RcsbFvTrackData
  New annotations to be displayed
- OptionaldisplayId: string
  optional Id that identifies track from a composite track to update
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:203

Class RcsbFv<P, S, R, M>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RcsbFv<P, S, R, M>

Methods

addSelection

Parameters

Returns void

addTrack

Parameters

Returns Promise<void>

addTrackData

Parameters

Returns Promise<void>

catch

Parameters

Returns RcsbFv

changeTrackVisibility

Parameters

Returns Promise<void>

clearSelection

Parameters

Returns void

getBoardConfig

Returns RcsbFvBoardConfigInterface

getBoardData

Returns RcsbFvRowConfigInterface<P, S, R, M>[]

getDomain

Returns [number, number]

getSelection

Parameters

Returns SelectionInterface[]

getTrackIds

Returns string[]

init

Returns Promise<void>

moveTrack

Parameters

Returns Promise<void>

reset

Returns void

resetTrack

Parameters

Returns Promise<void>

setBoardConfig

Parameters

Returns Promise<void>

setBoardData

Parameters

Returns Promise<void>

setDomain

Parameters

Returns void

setSelection

Parameters

Returns void

then

Parameters

Returns RcsbFv

unmount

Returns void

updateBoardConfig

Parameters

Returns Promise<void>

updateTrackData

Parameters

Returns Promise<void>

Settings

On This Page