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;
} = {}

Hierarchy

RcsbFv

Constructors

constructor

new RcsbFv<P, S, R, M>(props): 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:68

Properties

`Private` boardConfigData

boardConfigData: RcsbFvBoardConfigInterface

Global board configuration

`Private` `Readonly` boardDataSate

boardDataSate: BoardDataState<P, S, R, M>

`Private` `Readonly` boardId

boardId: string = ...

`Private` `Readonly` contextManager

contextManager: RcsbFvContextManager = ...

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

`Private` `Readonly` elementId

elementId: string

DOM elemnt id where the board will be displayed

`Private` mounted

mounted: boolean = false

Flag indicating that the React component has been mounted

`Private` rcsbFvPromise

rcsbFvPromise: Promise<void>

`Private` `Readonly` rcsbFvStateManager

rcsbFvStateManager: RcsbFvStateManager

`Private` reactRoot

reactRoot: Root

`Private` `Readonly` selection

selection: RcsbSelection = ...

Global selection shared among all tracks

`Private` `Readonly` xScale

xScale: RcsbScaleInterface<number, ScaleLinear<number, number, never>> = ...

Global d3 Xscale object shared among all board tracks

Methods

addSelection

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

addTrack

addTrack(trackConfig): 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:240

addTrackData

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

catch

catch(f): RcsbFv<{}, {}, {}, {}>
Parameters
- f: (() => void)
  - - (): void
    - Returns void
Returns RcsbFv<{}, {}, {}, {}>
- Defined in src/RcsbFv/RcsbFv.tsx:133

changeTrackVisibility

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

clearSelection

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

getBoardConfig

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

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:104

getDomain

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

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

getSelection

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

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:179

init

init(): Promise<void>
Renders the board

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

moveTrack

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

reset

reset(): void
reset Selection and Scale

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

resetTrack

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

setBoardConfig

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

setBoardData

setBoardData(rowConfigData): 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:96

setDomain

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

setSelection

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

then

then(f): RcsbFv<{}, {}, {}, {}>
Parameters
- f: (() => void)
  - - (): void
    - Returns void
Returns RcsbFv<{}, {}, {}, {}>
- Defined in src/RcsbFv/RcsbFv.tsx:123

unmount

unmount(): void
Unmount the board

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

updateBoardConfig

updateBoardConfig(newConfig): 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
  - Optional boardConfigData?: RcsbFvBoardConfigInterface
  - Optional rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[]
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:205

`Private` updateBoardData

updateBoardData(): Promise<void>
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:327

updateTrackData

updateTrackData(trackId, trackData, displayId?): Promise<void>
Replaces annotations a particular board track
Parameters
- trackId: string
  Id that identifies the track
- trackData: RcsbFvTrackData<{
  [k: string]: any;
  }>
  New annotations to be displayed
- Optional displayId: string
  optional Id that identifies track from a composite track to update
Returns Promise<void>
- Defined in src/RcsbFv/RcsbFv.tsx:197

Class 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; } = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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>

Properties

Private boardConfigData

Private Readonly boardDataSate

Private Readonly boardId

Private Readonly contextManager

Private Readonly elementId

Private mounted

Private rcsbFvPromise

Private Readonly rcsbFvStateManager

Private reactRoot

Private Readonly selection

Private Readonly xScale

Methods

addSelection

Parameters

selection: SetSelectionInterface

Returns void

addTrack

Parameters

trackConfig: RcsbFvRowConfigInterface<P, S, R, M>

Returns Promise<void>

addTrackData

Parameters

trackId: string

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

Returns Promise<void>

catch

Parameters

f: (() => void)

Returns void

Returns RcsbFv<{}, {}, {}, {}>

changeTrackVisibility

Parameters

obj: TrackVisibilityInterface

Returns Promise<void>

clearSelection

Parameters

Optional mode: "select" | "hover"

Returns void

getBoardConfig

Returns RcsbFvBoardConfigInterface

getBoardData

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

getDomain

Returns [number, number]

getSelection

Parameters

mode: "select" | "hover"

Returns SelectionInterface[]

getTrackIds

Returns string[]

init

Returns Promise<void>

moveTrack

Parameters

oldIndex: number

newIndex: number

Returns Promise<void>

reset

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

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

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

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

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

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

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

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

`Private` boardConfigData

`Private` `Readonly` boardDataSate

`Private` `Readonly` boardId

`Private` `Readonly` contextManager

`Private` `Readonly` elementId

`Private` mounted

`Private` rcsbFvPromise

`Private` `Readonly` rcsbFvStateManager

`Private` reactRoot

`Private` `Readonly` selection

`Private` `Readonly` xScale

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

`Optional` mode: "select" | "hover"

newConfig: {
boardConfigData?: RcsbFvBoardConfigInterface;
rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[];
}

`Optional` boardConfigData?: RcsbFvBoardConfigInterface

`Optional` rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[]

`Private` updateBoardData

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

`Optional` displayId: string