Class RcsbAreaDisplay

Hierarchy (View Summary)

RcsbLineDisplay
- RcsbAreaDisplay

Constructors

constructor

new RcsbAreaDisplay(boardId: string, trackId: string): RcsbAreaDisplay
Parameters
- boardId: string
- trackId: string
Returns RcsbAreaDisplay
Overrides RcsbLineDisplay.constructor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:37

Properties

`Protected`_displayColor

_displayColor: string | RcsbFvColorGradient = "#FF6666"

`Protected`contextManager

contextManager: RcsbFvContextManager

`Protected`d3Manager

d3Manager: RcsbD3Manager

`Protected`definedScale

definedScale: boolean = false

`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`innerData

innerData: (null | RcsbFvTrackDataElementInterface)[] = ...

`Protected`line

line: Line<RcsbFvTrackDataElementInterface> = ...

`Protected`maxPoints

maxPoints: number = 1000

`Protected`minRatio

minRatio: number = 0

`Protected` `Readonly`SUFFIX_ID

SUFFIX_ID: string = "area_"

`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

`Protected`yScale

yScale: RcsbScaleInterface = ...

Methods

_update

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

enter

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

`Protected`geoPlot

geoPlot(data: RcsbFvTrackData): void
Parameters
- data: RcsbFvTrackData
Returns void
Overrides RcsbLineDisplay.geoPlot
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:119

`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 RcsbLineDisplay.getBoardHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:104

getElements

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

`Protected`getRatio

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

height

height(h?: number): number
Parameters
- Optionalh: number
Returns number
Inherited from RcsbLineDisplay.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 RcsbLineDisplay.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 RcsbLineDisplay.init
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:54

`Protected`isDataUpdated

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

move

move(): void
Returns void
Overrides RcsbLineDisplay.move
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:165

moveSelection

moveSelection(mode: "select" | "hover"): void
Parameters
- mode: "select" | "hover"
Returns void
Inherited from RcsbLineDisplay.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 RcsbLineDisplay.plot
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:62

`Protected`processData

processData(dataElems: RcsbFvTrackData): RcsbFvTrackData
Parameters
- dataElems: RcsbFvTrackData
Returns RcsbFvTrackData
Inherited from RcsbLineDisplay.processData
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:160

reset

reset(): void
Returns void
Inherited from RcsbLineDisplay.reset
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:53

`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 RcsbLineDisplay.selectElements
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:164

setBlockArea

setBlockArea(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:55

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 RcsbLineDisplay.setBoardHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractTrack.ts:100

`Protected`setDataUpdated

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

setDisplayColor

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

setHideEmptyTrack

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

setInterpolationType

setInterpolationType(type: string): void
Parameters
- type: string
Returns void
Overrides RcsbLineDisplay.setInterpolationType
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:43

`Protected`setLine

setLine(): void
Returns void
Inherited from RcsbLineDisplay.setLine
- Defined in src/RcsbBoard/RcsbDisplay/RcsbLineDisplay.ts:52

setManagers

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

setMinRatio

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

setMultiArea

setMultiArea(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAreaDisplay.ts:59

setScale

setScale(): void
Returns void
Inherited from RcsbLineDisplay.setScale
- Defined in src/RcsbBoard/RcsbDisplay/RcsbLineDisplay.ts:41

setSelectDataInRange

setSelectDataInRange(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from RcsbLineDisplay.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 RcsbLineDisplay.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 RcsbLineDisplay.subscribeElementHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:57

trackColor

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

update

update(compKey?: string): void
Parameters
- OptionalcompKey: string
Returns void
Inherited from RcsbLineDisplay.update
- Defined in src/RcsbBoard/RcsbDisplay/RcsbAbstractDisplay.ts:90

`Protected`updateLine

updateLine(): void
Returns void
Inherited from RcsbLineDisplay.updateLine
- Defined in src/RcsbBoard/RcsbDisplay/RcsbLineDisplay.ts:62

yDomain

yDomain(domain: [number, number]): void
Parameters
- domain: [number, number]
Returns void
Inherited from RcsbLineDisplay.yDomain
- Defined in src/RcsbBoard/RcsbDisplay/RcsbLineDisplay.ts:37

`Protected` `Static`dataKey

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

Class RcsbAreaDisplay

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RcsbAreaDisplay

Properties

Protected_displayColor

ProtectedcontextManager

Protectedd3Manager

ProtecteddefinedScale

ReadonlyelementSubject

Protectedg

ProtectedinnerData

Protectedline

ProtectedmaxPoints

ProtectedminRatio

Protected ReadonlySUFFIX_ID

ReadonlytrackSubject

ProtectedupdateDataOnMove

ProtectedxScale

ProtectedyScale

Methods

_update

Parameters

Returns void

data

Parameters

Returns RcsbFvTrackData

displayEmpty

Returns void

ProtecteddownSampling

Parameters

Returns RcsbFvTrackDataElementInterface[]

enter

Parameters

Returns void

ProtectedgeoPlot

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>

setBlockArea

Parameters

Returns void

`Protected`_displayColor

`Protected`contextManager

`Protected`d3Manager

`Protected`definedScale

`Readonly`elementSubject

`Protected`g

`Protected`innerData

`Protected`line

`Protected`maxPoints

`Protected`minRatio

`Protected` `Readonly`SUFFIX_ID

`Readonly`trackSubject

`Protected`updateDataOnMove

`Protected`xScale

`Protected`yScale

`Protected`downSampling

`Protected`geoPlot

`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`setLine

`Protected`updateLine

`Protected` `Static`dataKey