Class RcsbCompositeDisplay

Hierarchy

RcsbCompositeDisplay

Implements

RcsbDisplayInterface

Constructors

constructor

new RcsbCompositeDisplay(): RcsbCompositeDisplay
Returns RcsbCompositeDisplay

Properties

`Private` _bgColor

_bgColor: string

`Private` _data

_data: RcsbFvTrackDataMap

`Private` _height

_height: number

`Private` compositeHeight

compositeHeight: number

`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;
}>

`Private` innerDisplays

innerDisplays: DisplayElementInterface[] = ...

plot

plot: ((element) => void)

Type declaration

- (element): void
- Parameters
  - element: Selection<SVGGElement, RcsbFvTrackDataElementInterface, BaseType, undefined>
  Returns void

setHideEmptyTrack

setHideEmptyTrack: ((flag) => void)

Type declaration

- (flag): void
- Parameters
  - flag: boolean
  Returns void

setMinRatio

setMinRatio: ((ratio) => void)

Type declaration

- (ratio): void
- Parameters
  - ratio: number
  Returns void

setSelectDataInRange

setSelectDataInRange: ((flag) => void)

Type declaration

- (flag): void
- Parameters
  - flag: boolean
  Returns void

setUpdateDataOnMove

setUpdateDataOnMove: ((f) => void)

Type declaration

- (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

`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;
}>

Methods

addDisplay

addDisplay(displayId, display): void
Parameters
- displayId: string
- display: RcsbDisplayInterface
Returns void
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:84

data

data(d?): RcsbFvTrackDataMap
Parameters
- Optional d: RcsbFvTrackDataMap | RcsbFvTrackData<{
  [k: string]: any;
  }>
Returns RcsbFvTrackDataMap
Implementation of RcsbDisplayInterface.data
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:129

displayEmpty

displayEmpty(): void
Returns void
Implementation of RcsbDisplayInterface.displayEmpty
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:66

height

height(h?): number
Parameters
- Optional h: number
Returns number
Implementation of RcsbDisplayInterface.height
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:109

highlightRegion

highlightRegion(d, options?): void
Parameters
- d: null | RcsbFvTrackDataElementInterface[]
- Optional options: {
  color?: string;
  rectClass?: string;
  }
  - Optional color?: string
  - Optional rectClass?: string
Returns void
Implementation of RcsbDisplayInterface.highlightRegion
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:142

init

init(scale): void
Parameters
- scale: RcsbScaleInterface<number, ScaleLinear<number, number, never>>
Returns void
Implementation of RcsbDisplayInterface.init
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:54

move

move(): void
Returns void
Implementation of RcsbDisplayInterface.move
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:72

moveSelection

moveSelection(mode): void
Parameters
- mode: "select" | "hover"
Returns void
Implementation of RcsbDisplayInterface.moveSelection
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:78

reset

reset(): void
Returns void
Implementation of RcsbDisplayInterface.reset
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:48

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
Implementation of RcsbDisplayInterface.setBoardHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:97

setCompositeHeight

setCompositeHeight(h): void
Parameters
- h: number
Returns void
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:44

setDisplayColor

setDisplayColor(color): void
Parameters
- color: string | RcsbFvColorGradient
Returns void
Implementation of RcsbDisplayInterface.setDisplayColor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:148

setManagers

setManagers(d3Manager, contextManager): void
Parameters
- d3Manager: RcsbD3Manager
- contextManager: RcsbFvContextManager
Returns void
Implementation of RcsbDisplayInterface.setManagers
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:91

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
Implementation of RcsbDisplayInterface.subscribeElementHighlight
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:103

trackColor

trackColor(c?): string
Parameters
- Optional c: string
Returns string
Implementation of RcsbDisplayInterface.trackColor
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:119

update

update(): void
Returns void
Implementation of RcsbDisplayInterface.update
- Defined in src/RcsbBoard/RcsbDisplay/RcsbCompositeDisplay.ts:60

Class RcsbCompositeDisplay

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RcsbCompositeDisplay

Properties

Private _bgColor

Private _data

Private _height

Private compositeHeight

Readonly elementSubject

Type declaration

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

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

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

Private innerDisplays

plot

Type declaration

Parameters

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

Returns void

setHideEmptyTrack

Type declaration

Parameters

flag: boolean

Returns void

setMinRatio

Type declaration

Parameters

ratio: number

Returns void

setSelectDataInRange

Type declaration

Parameters

flag: boolean

Returns void

setUpdateDataOnMove

Type declaration

Parameters

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

Parameters

d: LocationViewInterface

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

Returns void

Readonly trackSubject

Type declaration

mouseenter: Subject<MouseEvent>

mouseleave: Subject<MouseEvent>

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

Methods

addDisplay

Parameters

displayId: string

display: RcsbDisplayInterface

Returns void

data

Parameters

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

Returns RcsbFvTrackDataMap

displayEmpty

Returns void

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

`Private` _bgColor

`Private` _data

`Private` _height

`Private` compositeHeight

`Readonly` elementSubject

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

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

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

`Private` innerDisplays

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

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

`Readonly` trackSubject

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

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

`Optional` h: number

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

`Optional` color?: string

`Optional` rectClass?: string

`Optional` propFlag: boolean

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

`Optional` c: string