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

Index

Constructors

Methods

addTrack addTrackData changeTrackVisibility getBoardData moveTrack refresh resetTrack setBoardData unsubscribe updateTrackData

Constructors

constructor

new BoardDataState<
    P extends { [k: string]: any } = {},
    S extends { [k: string]: any } = {},
    R extends { [k: string]: any } = {},
    M extends { [k: string]: any } = {},
>(
    config: {
        boardId: string;
        contextManager: RcsbFvContextManager;
        rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[];
    },
): BoardDataState<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
- config: {
      boardId: string;
      contextManager: RcsbFvContextManager;
      rowConfigData?: RcsbFvRowConfigInterface<P, S, R, M>[];
  }
Returns BoardDataState<P, S, R, M>
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:42

Methods

addTrack

addTrack(configRow: RcsbFvRowConfigInterface<P, S, R, M>): void
Adds a new track to the board
Parameters
- configRow: RcsbFvRowConfigInterface<P, S, R, M>
  Track configuration object
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:70

addTrackData

addTrackData(obj: TrackDataInterface): void
Add new data to a given board track
Parameters
- obj: TrackDataInterface
  Additional track data and target track id
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:102

changeTrackVisibility

changeTrackVisibility(obj: TrackVisibilityInterface): void
Modifies visibility of a board track
Parameters
- obj: TrackVisibilityInterface
  Target track id and visibility flag (true/false)
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:80

getBoardData

getBoardData(): RcsbFvRowRenderConfigInterface<P, S, R, M>[]
Returns RcsbFvRowRenderConfigInterface<P, S, R, M>[]
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:53

moveTrack

moveTrack(move: { newIndex: number; oldIndex: number }): void
Parameters
- move: { newIndex: number; oldIndex: number }
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:88

refresh

refresh(): void
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:62

resetTrack

resetTrack(trackId: string): void
Rerender the board track
Parameters
- trackId: string
  Id that identifies the track
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:109

setBoardData

setBoardData(rowConfigData: RcsbFvRowConfigInterface<P, S, R, M>[]): void
Parameters
- rowConfigData: RcsbFvRowConfigInterface<P, S, R, M>[]
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:57

unsubscribe

unsubscribe(): void
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:117

updateTrackData

updateTrackData(obj: TrackDataInterface): void
Replace board track rack data
Parameters
- obj: TrackDataInterface
  New track data and target track id
Returns void
- Defined in src/RcsbFv/RcsbFvBoard/Utils/BoardDataState.ts:95

Class BoardDataState<P, S, R, M>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BoardDataState<P, S, R, M>

Methods

addTrack

Parameters

Returns void

addTrackData

Parameters

Returns void

changeTrackVisibility

Parameters

Returns void

getBoardData

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

moveTrack

Parameters

Returns void

refresh

Returns void

resetTrack

Parameters

Returns void

setBoardData

Parameters

Returns void

unsubscribe

Returns void

updateTrackData

Parameters

Returns void

Settings

On This Page