Class AuxiliaryAxis<T>

Class to represent an extra x and/or y axis for a Plotly chart.

Type parameters

T: string

Hierarchy

AuxiliaryAxis
- SecondaryStructureAxis

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AuxiliaryAxis(sections: Array<Bioblocks1DSection<T>>, axisIndex?: number, colorMap?: ColorMapper<T>, dataTransformFn?: undefined | object, filterFn?: function): AuxiliaryAxis

- Defined in src/component/chart/AuxiliaryAxis.ts:81
Creates an instance of AuxiliaryAxis.

Parameters
- sections: Array<Bioblocks1DSection<T>>
  
  The underlying data to be represented by these axes.
- Default value axisIndex: number = 2
- Default value colorMap: ColorMapper<T> = new ColorMapper<T>()
- Optional dataTransformFn: undefined | object
- Default value filterFn: function = () => false
  - - (section: Bioblocks1DSection<T>): boolean
    - Parameters
      - section: Bioblocks1DSection<T>
      Returns boolean
Returns AuxiliaryAxis

Properties

Protected axes

axes: Map<T, IAxisMapping> = new Map()

axisIndex

axisIndex: number

colorMap

colorMap: ColorMapper<T>

Optional dataTransformFn

dataTransformFn: undefined | object

filterFn

filterFn: function

Type declaration

- (section: Bioblocks1DSection<T>): boolean
- Parameters
  - section: Bioblocks1DSection<T>
  Returns boolean

Protected highlightedAxes

highlightedAxes: Map<T, IAxisMapping> = new Map()

sections

sections: Array<Bioblocks1DSection<T>>

The underlying data to be represented by these axes.

Accessors

axis

get axis(): Map<T, IAxisMapping>

- Defined in src/component/chart/AuxiliaryAxis.ts:31
Get all the axis objects belonging to this Auxiliary Axis.

Returns Map<T, IAxisMapping>

highlightedXAxes

get highlightedXAxes(): object[]

- Defined in src/component/chart/AuxiliaryAxis.ts:50
Get all the highlighted x-axis objects belonging to this Auxiliary Axis.

Returns object[]

highlightedYAxes

get highlightedYAxes(): object[]

- Defined in src/component/chart/AuxiliaryAxis.ts:74
Get all the highlighted y-axis objects belonging to this Auxiliary Axis.

Returns object[]

xAxes

get xAxes(): object[]

- Defined in src/component/chart/AuxiliaryAxis.ts:38
Get all the x-axis objects belonging to this Auxiliary Axis.

Returns object[]

yAxes

get yAxes(): object[]

- Defined in src/component/chart/AuxiliaryAxis.ts:62
Get all the y-axis objects belonging to this Auxiliary Axis.

Returns object[]

Methods

Protected auxiliaryAxisDefaults

auxiliaryAxisDefaults(key: T): REQUIRED_BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:203
Default plotly data for an axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns REQUIRED_BIOBLOCKS_PLOTLY_DATA

Protected deriveHighlightedPointsInAxis

deriveHighlightedPointsInAxis(section: Bioblocks1DSection<T>): object

- Defined in src/component/chart/AuxiliaryAxis.ts:262
Parameters
- section: Bioblocks1DSection<T>
Returns object
- main: number[]
- opposite: (null | number)[]

Protected derivePointsInAxis

derivePointsInAxis(section: Bioblocks1DSection<T>): object

- Defined in src/component/chart/AuxiliaryAxis.ts:241
Determines the points that make up the axis for both the main and opposite axis side.

Parameters
- section: Bioblocks1DSection<T>
  
  The section of data to derive points for.
Returns object
- main: number[]
- opposite: (null | number)[]

Protected generateHighlightedXAxisSegment

generateHighlightedXAxisSegment(key: T): BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:167
Plotly data specific for the highlighted x axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns BIOBLOCKS_PLOTLY_DATA

Protected generateHighlightedYAxisSegment

generateHighlightedYAxisSegment(key: T): BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:191
Plotly data specific for the highlighted y axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns BIOBLOCKS_PLOTLY_DATA

Protected generateXAxisSegment

generateXAxisSegment(key: T): BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:155
Plotly data specific for the x axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns BIOBLOCKS_PLOTLY_DATA

Protected generateYAxisSegment

generateYAxisSegment(key: T): BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:179
Plotly data specific for the y axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns BIOBLOCKS_PLOTLY_DATA

getAxisById

getAxisById(id: T): undefined | IAxisMapping

- Defined in src/component/chart/AuxiliaryAxis.ts:104
Parameters
- id: T
Returns undefined | IAxisMapping

Protected highlightedAuxiliaryAxisDefaults

highlightedAuxiliaryAxisDefaults(key: T): BIOBLOCKS_PLOTLY_DATA

- Defined in src/component/chart/AuxiliaryAxis.ts:228
Default plotly data for a highlighted axis.

Parameters
- key: T
  
  The label for this piece of data.
Returns BIOBLOCKS_PLOTLY_DATA

Protected setupAuxiliaryAxis

setupAuxiliaryAxis(): void

- Defined in src/component/chart/AuxiliaryAxis.ts:111
Create the Auxiliary Axis.

Returns void

Generated using TypeDoc