Class RcsbAxisDisplay

Hierarchy

RcsbAbstractDisplay
- RcsbAxisDisplay

Constructors

constructor

new RcsbAxisDisplay(boardId, trackId, length?): RcsbAxisDisplay
Parameters
- boardId: string
- trackId: string
- Optional length: number
Returns RcsbAxisDisplay
Overrides RcsbAbstractDisplay.constructor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAxisDisplay.ts:12

Properties

`Protected` _displayColor

_displayColor: string | RcsbFvColorGradient = "#FF6666"

`Protected` contextManager

contextManager: RcsbFvContextManager

`Protected` d3Manager

d3Manager: RcsbD3Manager

`Readonly` elementSubject

elementSubject: {
    mouseclick: Subject<{
        d: RcsbFvTrackDataElementInterface;
        e: MouseEvent;
    }>;
    mouseenter: Subject<{
        d: RcsbFvTrackDataElementInterface;
        e: MouseEvent;
    }>;
    mouseleave: Subject<{
        d: RcsbFvTrackDataElementInterface;
        e: MouseEvent;
    }>;
} = ...

Type declaration

mouseclick: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>
mouseenter: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>
mouseleave: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>

`Protected` g

g: Selection<SVGGElement, any, null, undefined>

`Private` `Readonly` length

length: undefined | number

`Protected` minRatio

minRatio: number = 0

`Readonly` trackSubject

trackSubject: {
    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;
}>

`Protected` updateDataOnMove

updateDataOnMove: ((d) => Promise<RcsbFvTrackData<{
[k: string]: any;
}>>)

Type declaration

- (d): Promise<RcsbFvTrackData<{
  [k: string]: any;
  }>>
- Parameters
  - d: LocationViewInterface
  Returns Promise<RcsbFvTrackData<{
  [k: string]: any;
  }>>

`Private` xAxis

xAxis: Axis<number>

`Protected` xScale

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

Methods

_update

_update(where, compKey?): void
Parameters
- where: LocationViewInterface
- Optional compKey: string
Returns void
Inherited from RcsbAbstractDisplay._update
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:112

data

data(d?): RcsbFvTrackData<{
[k: string]: any;
}>
Parameters
- Optional d: RcsbFvTrackDataMap | RcsbFvTrackData<{
  [k: string]: any;
  }>
Returns RcsbFvTrackData<{
[k: string]: any;
}>
Inherited from RcsbAbstractDisplay.data
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:77

displayEmpty

displayEmpty(): void
Returns void
Inherited from RcsbAbstractDisplay.displayEmpty
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:154

enter

enter(e): void
Parameters
- e: Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Returns void
Inherited from RcsbAbstractDisplay.enter
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:177

`Protected` getBoardHighlight

getBoardHighlight(): ((d, operation, mode, propFlag?) => void)
Returns ((d, operation, mode, propFlag?) => void)
- - (d, operation, mode, propFlag?): void
  - Parameters
    - d: RcsbFvTrackDataElementInterface
    - operation: "set" | "add"
    - mode: "select" | "hover"
    - Optional propFlag: boolean
    Returns void
Inherited from RcsbAbstractDisplay.getBoardHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:104

getElements

getElements(): Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Inherited from RcsbAbstractDisplay.getElements
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:180

`Protected` getRatio

getRatio(): number
Returns number
Inherited from RcsbAbstractDisplay.getRatio
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:188

height

height(h?): number
Parameters
- Optional h: number
Returns number
Inherited from RcsbAbstractDisplay.height
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:40

highlightRegion

highlightRegion(d, options?): void
Parameters
- d: null | RcsbFvTrackDataElementInterface[]
- Optional options: {
  color?: string;
  rectClass?: string;
  }
  - Optional color?: string
  - Optional rectClass?: string
Returns void
Inherited from RcsbAbstractDisplay.highlightRegion
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:113

init

init(scale, compositeFlag?, compositeHeight?): void
Parameters
- scale: RcsbScaleInterface<number, ScaleLinear<number, number, never>>
- Optional compositeFlag: boolean
- Optional compositeHeight: number
Returns void
Inherited from RcsbAbstractDisplay.init
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:54

`Protected` isDataUpdated

isDataUpdated(): boolean
Returns boolean
Inherited from RcsbAbstractDisplay.isDataUpdated
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:92

move

move(): void
Returns void
Overrides RcsbAbstractDisplay.move
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAxisDisplay.ts:33

moveSelection

moveSelection(mode): void
Parameters
- mode: "select" | "hover"
Returns void
Inherited from RcsbAbstractDisplay.moveSelection
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:133

plot

plot(element): void
Parameters
- element: Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Returns void
Inherited from RcsbAbstractDisplay.plot
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:62

`Protected` processData

processData(dataElems): RcsbFvTrackData<{
[k: string]: any;
}>
Parameters
- dataElems: RcsbFvTrackData<{
  [k: string]: any;
  }>
Returns RcsbFvTrackData<{
[k: string]: any;
}>
Inherited from RcsbAbstractDisplay.processData
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:160

reset

reset(): void
Returns void
Overrides RcsbAbstractDisplay.reset
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAxisDisplay.ts:17

`Protected` selectElements

selectElements(dataElems, compKey?): Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Parameters
- dataElems: RcsbFvTrackData<{
  [k: string]: any;
  }>
- Optional compKey: string
Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Inherited from RcsbAbstractDisplay.selectElements
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:164

setBoardHighlight

setBoardHighlight(f): void
Parameters
- f: ((d, operation, mode, propFlag?) => void)
  - - (d, operation, mode, propFlag?): void
    - Parameters
      d: RcsbFvTrackDataElementInterface
      operation: "set" | "add"
      mode: "select" | "hover"
      Optional propFlag: boolean
      Returns void
Returns void
Inherited from RcsbAbstractDisplay.setBoardHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:100

`Protected` setDataUpdated

setDataUpdated(flag): void
Parameters
- flag: boolean
Returns void
Inherited from RcsbAbstractDisplay.setDataUpdated
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:88

setDisplayColor

setDisplayColor(color): void
Parameters
- color: string | RcsbFvColorGradient
Returns void
Inherited from RcsbAbstractDisplay.setDisplayColor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:37

setHideEmptyTrack

setHideEmptyTrack(flag): void
Parameters
- flag: boolean
Returns void
Inherited from RcsbAbstractDisplay.setHideEmptyTrack
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:49

setManagers

setManagers(d3Manager, contextManager): void
Parameters
- d3Manager: RcsbD3Manager
- contextManager: RcsbFvContextManager
Returns void
Inherited from RcsbAbstractDisplay.setManagers
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:108

setMinRatio

setMinRatio(ratio): void
Parameters
- ratio: number
Returns void
Inherited from RcsbAbstractDisplay.setMinRatio
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:41

setSelectDataInRange

setSelectDataInRange(flag): void
Parameters
- flag: boolean
Returns void
Inherited from RcsbAbstractDisplay.setSelectDataInRange
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:45

setUpdateDataOnMove

setUpdateDataOnMove(f): void
Parameters
- f: ((d) => Promise<RcsbFvTrackData<{
  [k: string]: any;
  }>>)
  - - (d): Promise<RcsbFvTrackData<{
      [k: string]: any;
      }>>
    - Parameters
      d: LocationViewInterface
      Returns Promise<RcsbFvTrackData<{
      [k: string]: any;
      }>>
Returns void
Inherited from RcsbAbstractDisplay.setUpdateDataOnMove
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:96

subscribeElementHighlight

subscribeElementHighlight(action): void
Parameters
- action: {
  enter: ((d) => void);
  leave: ((d) => void);
  }
  - enter: ((d) => void)
    - (d): void
      Parameters
      d: RcsbFvTrackDataElementInterface
      Returns void
  - leave: ((d) => void)
    - (d): void
      Parameters
      d: RcsbFvTrackDataElementInterface
      Returns void
Returns void
Inherited from RcsbAbstractDisplay.subscribeElementHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:57

trackColor

trackColor(c?): string
Parameters
- Optional c: string
Returns string
Inherited from RcsbAbstractDisplay.trackColor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:47

update

update(): void
Returns void
Overrides RcsbAbstractDisplay.update
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAxisDisplay.ts:22

`Static` `Protected` dataKey

dataKey(d): string
Parameters
- d: RcsbFvTrackDataElementInterface
Returns string
Inherited from RcsbAbstractDisplay.dataKey
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:184

Class RcsbAxisDisplay

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

boardId: string

trackId: string

Optional length: number

Returns RcsbAxisDisplay

Properties

Protected _displayColor

Protected contextManager

Protected d3Manager

Readonly elementSubject

Type declaration

mouseclick: Subject<{ d: RcsbFvTrackDataElementInterface; e: MouseEvent; }>

mouseenter: Subject<{ d: RcsbFvTrackDataElementInterface; e: MouseEvent; }>

mouseleave: Subject<{ d: RcsbFvTrackDataElementInterface; e: MouseEvent; }>

Protected g

Private Readonly length

Protected minRatio

Readonly trackSubject

Type declaration

mouseenter: Subject<MouseEvent>

mouseleave: Subject<MouseEvent>

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

Protected updateDataOnMove

Type declaration

Parameters

d: LocationViewInterface

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

Private xAxis

Protected xScale

Methods

_update

Parameters

where: LocationViewInterface

Optional compKey: string

Returns void

data

Parameters

Optional d: RcsbFvTrackDataMap | RcsbFvTrackData<{ [k: string]: any; }>

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

displayEmpty

Returns void

enter

Parameters

e: Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>

Returns void

Protected getBoardHighlight

Returns ((d, operation, mode, propFlag?) => void)

Parameters

d: RcsbFvTrackDataElementInterface

operation: "set" | "add"

mode: "select" | "hover"

Optional propFlag: boolean

Returns void

getElements

Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>

Protected getRatio

Returns number

height

Parameters

Optional h: number

Returns number

highlightRegion

Parameters

d: null | RcsbFvTrackDataElementInterface[]

Optional options: { color?: string; rectClass?: string; }

Optional color?: string

Optional rectClass?: string

Returns void

init

Parameters

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

Optional compositeFlag: boolean

`Optional` length: number

`Protected` _displayColor

`Protected` contextManager

`Protected` d3Manager

`Readonly` elementSubject

mouseclick: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>

mouseenter: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>

mouseleave: Subject<{
d: RcsbFvTrackDataElementInterface;
e: MouseEvent;
}>

`Protected` g

`Private` `Readonly` length

`Protected` minRatio

`Readonly` trackSubject

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

`Protected` updateDataOnMove

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

`Private` xAxis

`Protected` xScale

`Optional` compKey: string

`Optional` d: RcsbFvTrackDataMap | RcsbFvTrackData<{
[k: string]: any;
}>

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

`Protected` getBoardHighlight

`Optional` propFlag: boolean

`Protected` getRatio

`Optional` h: number

`Optional` options: {
color?: string;
rectClass?: string;
}

`Optional` color?: string

`Optional` rectClass?: string

`Optional` compositeFlag: boolean

`Optional` compositeHeight: number

`Protected` isDataUpdated

`Protected` processData

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

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

`Protected` selectElements

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

`Optional` compKey: string

`Optional` propFlag: boolean

`Protected` setDataUpdated

f: ((d) => Promise<RcsbFvTrackData<{
[k: string]: any;
}>>)

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

action: {
enter: ((d) => void);
leave: ((d) => void);
}