Class RcsbAxisDisplay

Hierarchy (View Summary)

RcsbAbstractDisplay
- RcsbAxisDisplay

Constructors

constructor

new RcsbAxisDisplay(
    boardId: string,
    trackId: string,
    length?: number,
): RcsbAxisDisplay
Parameters
- boardId: string
- trackId: string
- Optionallength: 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 }>;
} = ...

`Protected`g

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

`Protected`minRatio

minRatio: number = 0

`Readonly`trackSubject

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

`Protected`updateDataOnMove

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

`Protected`xScale

xScale: RcsbScaleInterface

Methods

_update

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

data

data(
d?: RcsbFvTrackDataMap | RcsbFvTrackData<{ [k: string]: any }>,
): RcsbFvTrackData
Parameters
- Optionald: RcsbFvTrackDataMap | RcsbFvTrackData<{ [k: string]: any }>
Returns RcsbFvTrackData
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: Selection<
        SVGGElement,
        RcsbFvTrackDataElementInterface,
        BaseType,
        undefined,
    >,
): 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: RcsbFvTrackDataElementInterface,
    operation: "set" | "add",
    mode: "select" | "hover",
    propFlag?: boolean,
) => void
Returns (
    d: RcsbFvTrackDataElementInterface,
    operation: "set" | "add",
    mode: "select" | "hover",
    propFlag?: boolean,
) => 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): number
Parameters
- Optionalh: number
Returns number
Inherited from RcsbAbstractDisplay.height
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:40

highlightRegion

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

init

init(
    scale: RcsbScaleInterface,
    compositeFlag?: boolean,
    compositeHeight?: number,
): void
Parameters
- scale: RcsbScaleInterface
- OptionalcompositeFlag: boolean
- OptionalcompositeHeight: 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: "select" | "hover"): void
Parameters
- mode: "select" | "hover"
Returns void
Inherited from RcsbAbstractDisplay.moveSelection
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:135

plot

plot(
    element: Selection<
        SVGGElement,
        RcsbFvTrackDataElementInterface,
        BaseType,
        undefined,
    >,
): 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): RcsbFvTrackData
Parameters
- dataElems: RcsbFvTrackData
Returns RcsbFvTrackData
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: RcsbFvTrackData,
    compKey?: string,
): Selection<
    SVGGElement,
    RcsbFvTrackDataElementInterface,
    BaseType,
    undefined,
>
Parameters
- dataElems: RcsbFvTrackData
- OptionalcompKey: string
Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
Inherited from RcsbAbstractDisplay.selectElements
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:164

setBoardHighlight

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

`Protected`setDataUpdated

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

setDisplayColor

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

setHideEmptyTrack

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

setManagers

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

setMinRatio

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

setSelectDataInRange

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

setUpdateDataOnMove

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

subscribeElementHighlight

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

trackColor

trackColor(c?: string): string
Parameters
- Optionalc: 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

`Protected` `Static`dataKey

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

Class RcsbAxisDisplay

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RcsbAxisDisplay

Properties

Protected_displayColor

ProtectedcontextManager

Protectedd3Manager

ReadonlyelementSubject

Protectedg

ProtectedminRatio

ReadonlytrackSubject

ProtectedupdateDataOnMove

ProtectedxScale

Methods

_update

Parameters

Returns void

data

Parameters

Returns RcsbFvTrackData

displayEmpty

Returns void

enter

Parameters

Returns void

ProtectedgetBoardHighlight

Returns ( d: RcsbFvTrackDataElementInterface, operation: "set" | "add", mode: "select" | "hover", propFlag?: boolean,) => void

getElements

Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>

ProtectedgetRatio

Returns number

height

Parameters

Returns number

highlightRegion

Parameters

Returns void

init

Parameters

Returns void

ProtectedisDataUpdated

Returns boolean

move

Returns void

moveSelection

Parameters

Returns void

plot

Parameters

Returns void

ProtectedprocessData

Parameters

Returns RcsbFvTrackData

reset

Returns void

ProtectedselectElements

Parameters

Returns Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>

setBoardHighlight

Parameters

Returns void

ProtectedsetDataUpdated

Parameters

Returns void

setDisplayColor

Parameters

Returns void

setHideEmptyTrack

Parameters

Returns void

setManagers

Parameters

Returns void

`Protected`_displayColor

`Protected`contextManager

`Protected`d3Manager

`Readonly`elementSubject

`Protected`g

`Protected`minRatio

`Readonly`trackSubject

`Protected`updateDataOnMove

`Protected`xScale

`Protected`getBoardHighlight

Returns (
d: RcsbFvTrackDataElementInterface,
operation: "set" | "add",
mode: "select" | "hover",
propFlag?: boolean,
) => void

`Protected`getRatio

`Protected`isDataUpdated

`Protected`processData

`Protected`selectElements

`Protected`setDataUpdated

`Protected` `Static`dataKey