Class RcsbBoard

Hierarchy

RcsbBoard

Constructors

constructor

new RcsbBoard(elementId, xScale, selection, contextManager): RcsbBoard
Parameters
- elementId: string
- xScale: RcsbScaleInterface<number, ScaleLinear<number, number, never>>
- selection: RcsbSelection
- contextManager: RcsbFvContextManager
Returns RcsbBoard
- Defined in src/RcsbBoard/RcsbBoard.ts:90

Properties

`Private` _bgColor

_bgColor: string = "#FFFFFF"

`Private` _innerPadding

_innerPadding: number = 10

`Private` _width

_width: number = 920

`Private` `Readonly` _xScale

_xScale: RcsbScaleInterface<number, ScaleLinear<number, number, never>>

`Private` `Readonly` boardDiv

boardDiv: HTMLElement

`Private` `Readonly` boardSubject

boardSubject: {
    mouseenter: Subject<MouseEvent>;
    mouseleave: Subject<MouseEvent>;
    mousemove: Subject<{
        e: MouseEvent;
        n: number;
    }>;
} = ...

Type declaration

mouseenter: Subject<MouseEvent>
mouseleave: Subject<MouseEvent>
mousemove: Subject<{
e: MouseEvent;
n: number;
}>

`Private` `Readonly` contextManager

contextManager: RcsbFvContextManager

`Private` currentLocationView

currentLocationView: LocationViewInterface = ...

`Readonly` d3Manager

d3Manager: RcsbD3Manager = ...

`Private` `Readonly` domId

domId: string

`Readonly` elementClickSubject

elementClickSubject: Subject<{
d?: RcsbFvTrackDataElementInterface;
e?: MouseEvent;
}> = ...

Type declaration

Optional d?: RcsbFvTrackDataElementInterface
Optional e?: MouseEvent

`Private` highlightHoverElementFlag

highlightHoverElementFlag: boolean = false

`Private` isIntersecting

isIntersecting: boolean = true

`Private` limits

limits: RegionLimitsInterface = ...

`Private` `Readonly` mouseHoverSubject

mouseHoverSubject: Subject<RcsbFvTrackDataElementInterface[]> = ...

`Private` `Readonly` selection

selection: RcsbSelection

`Private` tracks

tracks: RcsbDisplayInterface[] = ...

`Private` upToDate

upToDate: boolean = true

`Private` updateDelay

updateDelay: number = 300

`Private` updateTask

updateTask: null | Subscription = null

`Private` zoomEventHandler

zoomEventHandler: ZoomBehavior<Element, any> = ...

Methods

`Private` addHighlightHoverElement

addHighlightHoverElement(t): void
Parameters
- t: RcsbDisplayInterface
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:297

addHoverCallback

addHoverCallback(f): void
Parameters
- f: ((n) => void)
  - - (n): void
    - Parameters
      n: RcsbFvTrackDataElementInterface[]
      Returns void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:176

`Private` addMainG

addMainG(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:121

`Private` addSVG

addSVG(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:107

addTrack

addTrack(track, options?): void
Parameters
- track: RcsbDisplayInterface | RcsbDisplayInterface[]
- Optional options: {}
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:310

`Private` addTrackCallbacks

addTrackCallbacks(t): void
Parameters
- t: RcsbDisplayInterface
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:320

getSelection

getSelection(): RcsbSelection
Returns RcsbSelection
- Defined in src/RcsbBoard/RcsbBoard.ts:436

highlightRegion

highlightRegion(d, operation, mode, propFlag?): void
Parameters
- d: null | RcsbFvTrackDataElementInterface
- operation: "set" | "add" | "replace-last"
- mode: "select" | "hover"
- Optional propFlag: boolean
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:204

`Private` moveAllTracks

moveAllTracks(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:358

`Private` moveBoard

moveBoard(event, newTransform, propFlag): void
Parameters
- event: D3ZoomEvent<SVGGElement, null>
- newTransform: ZoomTransform
- propFlag: boolean
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:368

`Private` moveSelection

moveSelection(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:240

removeScrollEvent

removeScrollEvent(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:103

reset

reset(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:288

`Private` `Readonly` scrollEvent

scrollEvent(isIntersecting): void
Parameters
- isIntersecting: boolean
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:84

`Private` setBoardHeight

setBoardHeight(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:331

setBoardWidth

setBoardWidth(w): void
Parameters
- w: number
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:339

setElementClickCallback

setElementClickCallback(f): void
Parameters
- f: ((d?, e?) => void)
  - - (d?, e?): void
    - Parameters
      Optional d: RcsbFvTrackDataElementInterface
      Optional e: MouseEvent
      Returns void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:164

setHighlightHoverElement

setHighlightHoverElement(flag): void
Parameters
- flag: boolean
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:293

setHighlightHoverPosition

setHighlightHoverPosition(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:168

`Private` setLocation

setLocation(from, to): void
Parameters
- from: number
- to: number
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:343

setRange

setRange(from, to): void
Parameters
- from: number
- to: number
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:180

setScale

setScale(domId): void
Parameters
- domId: string
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:430

setSelection

setSelection(boardId, mode): void
Parameters
- boardId: string
- mode: "select" | "hover"
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:199

startBoard

startBoard(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:253

`Private` startTracks

startTracks(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:277

`Private` triggerScaleEvent

triggerScaleEvent(geoTrans): void
Parameters
- geoTrans: RcsbFvContextManagerType
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:440

`Private` triggerSelectionEvent

triggerSelectionEvent(selection): void
Parameters
- selection: RcsbFvContextManagerType
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:444

`Private` updateAllTracks

updateAllTracks(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:350

`Private` updateAndMove

updateAndMove(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:412

`Private` updateWithDelay

updateWithDelay(): void
Returns void
- Defined in src/RcsbBoard/RcsbBoard.ts:423

xScale

xScale(): RcsbScaleInterface<number, ScaleLinear<number, number, never>>
Returns RcsbScaleInterface<number, ScaleLinear<number, number, never>>
- Defined in src/RcsbBoard/RcsbBoard.ts:364

Class RcsbBoard

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

elementId: string

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

selection: RcsbSelection

contextManager: RcsbFvContextManager

Returns RcsbBoard

Properties

Private _bgColor

Private _innerPadding

Private _width

Private Readonly _xScale

Private Readonly boardDiv

Private Readonly boardSubject

Type declaration

mouseenter: Subject<MouseEvent>

mouseleave: Subject<MouseEvent>

mousemove: Subject<{ e: MouseEvent; n: number; }>

Private Readonly contextManager

Private currentLocationView

Readonly d3Manager

Private Readonly domId

Readonly elementClickSubject

Type declaration

Optional d?: RcsbFvTrackDataElementInterface

Optional e?: MouseEvent

Private highlightHoverElementFlag

Private isIntersecting

Private limits

Private Readonly mouseHoverSubject

Private Readonly selection

Private tracks

Private upToDate

Private updateDelay

Private updateTask

Private zoomEventHandler

Methods

Private addHighlightHoverElement

Parameters

t: RcsbDisplayInterface

Returns void

addHoverCallback

Parameters

f: ((n) => void)

Parameters

n: RcsbFvTrackDataElementInterface[]

Returns void

Returns void

Private addMainG

Returns void

Private addSVG

Returns void

addTrack

Parameters

track: RcsbDisplayInterface | RcsbDisplayInterface[]

Optional options: {}

Returns void

Private addTrackCallbacks

Parameters

t: RcsbDisplayInterface

Returns void

getSelection

Returns RcsbSelection

highlightRegion

Parameters

d: null | RcsbFvTrackDataElementInterface

operation: "set" | "add" | "replace-last"

mode: "select" | "hover"

Optional propFlag: boolean

Returns void

Private moveAllTracks

Returns void

Private moveBoard

`Private` _bgColor

`Private` _innerPadding

`Private` _width

`Private` `Readonly` _xScale

`Private` `Readonly` boardDiv

`Private` `Readonly` boardSubject

mousemove: Subject<{
e: MouseEvent;
n: number;
}>

`Private` `Readonly` contextManager

`Private` currentLocationView

`Readonly` d3Manager

`Private` `Readonly` domId

`Readonly` elementClickSubject

`Optional` d?: RcsbFvTrackDataElementInterface

`Optional` e?: MouseEvent

`Private` highlightHoverElementFlag

`Private` isIntersecting

`Private` limits

`Private` `Readonly` mouseHoverSubject

`Private` `Readonly` selection

`Private` tracks

`Private` upToDate

`Private` updateDelay

`Private` updateTask

`Private` zoomEventHandler

`Private` addHighlightHoverElement

`Private` addMainG

`Private` addSVG

`Optional` options: {}

`Private` addTrackCallbacks

`Optional` propFlag: boolean

`Private` moveAllTracks

`Private` moveBoard

`Private` moveSelection

`Private` `Readonly` scrollEvent

`Private` setBoardHeight

`Optional` d: RcsbFvTrackDataElementInterface

`Optional` e: MouseEvent

`Private` setLocation

`Private` startTracks

`Private` triggerScaleEvent

`Private` triggerSelectionEvent

`Private` updateAllTracks

`Private` updateAndMove