Class AxisBase<DataType, AxisOptionsType>`Abstract`

Implementation of RenderableItem class drawn on chart.

Type Parameters

DataType extends Object
AxisOptionsType extends AxisOptions

Hierarchy

ChartRenderableItem<Konva.Shape>
- AxisBase

Index

Constructors

constructor

Accessors

chart size

Constructors

`Protected` constructor

new AxisBase<DataType, AxisOptionsType>(location: NumericPoint, orientation: AxisOrientation, range: Range<DataType>, dataTransformation: DataTransformation, options: AxisOptionsType, width?: number, height?: number, textMeasureUtils?: TextMeasureUtils): AxisBase<DataType, AxisOptionsType>
Type Parameters
- DataType extends Object
- AxisOptionsType extends AxisOptions
Parameters
- location: NumericPoint
- orientation: AxisOrientation
- range: Range<DataType>
- dataTransformation: DataTransformation
- options: AxisOptionsType
- Optional width: number
- Optional height: number
- textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance
Returns AxisBase<DataType, AxisOptionsType>
Overrides ChartRenderableItem.constructor
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:56

Properties

`Optional` _chart

_chart?: Chart<any, string | number | Date, undefined>

`Protected` _size

_size: Size

`Private` borderShape

borderShape: Shape<ShapeConfig>

`Private` dataTransformation

dataTransformation: DataTransformation

`Readonly` id

id: number

`Protected` initialHeight

initialHeight: undefined | number

`Protected` initialWidth

initialWidth: undefined | number

`Protected` konvaDrawables

konvaDrawables: Shape<ShapeConfig>[]

`Protected` layerId

layerId: string

`Protected` location

location: NumericPoint

`Protected` majorTicks

majorTicks: Tick<DataType>[]

`Protected` `Readonly` majorTicksGenerator

majorTicksGenerator: MajorTicksGenerator<DataType>

`Protected` `Optional` majorTicksLabelsSizes

majorTicksLabelsSizes?: Size[]

`Protected` majorTicksScreenCoords

majorTicksScreenCoords: number[]

`Protected` `Optional` minorTicks

minorTicks?: Tick<DataType>[]

`Protected` `Optional` `Readonly` minorTicksGenerator

minorTicksGenerator?: MinorTicksGenerator<DataType>

`Protected` minorTicksScreenCoords

minorTicksScreenCoords: number[]

`Protected` options

options: AxisOptionsType

`Protected` orientation

orientation: AxisOrientation

`Protected` range

range: Range<DataType>

`Protected` textMeasureUtils

textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance

`Private` ticksShape

ticksShape: Shape<ShapeConfig>

`Static` `Readonly` generateMajorTicksMaxAttempts

generateMajorTicksMaxAttempts: 12 = 12

`Static` `Readonly` textVerticalOffsetMultiplier

textVerticalOffsetMultiplier: number = 0.0

Vertical multiplier, which must be used for defining an offset for fillText canvas method. Each text must be shifted by this constant in top direction (Y axis).

Accessors

chart

get chart(): undefined | Chart<any, string | number | Date, undefined>
Returns related chart

Returns
chart.

Returns undefined | Chart<any, string | number | Date, undefined>
Inherited from ChartRenderableItem.chart
- Defined in projects/some-charts-lib/src/chart/chart-content.ts:26

size

get size(): Size
Returns Size
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:35

Methods

attach

attach(renderer: Renderer): void
Attaches item the to renderer.
Parameters
- renderer: Renderer
  
  Renderer to use for item rendering.
Returns void
Inherited from ChartRenderableItem.attach
- Defined in projects/some-charts-lib/src/renderer/renderable-item.ts:22

`Abstract` axisValueToNumber

axisValueToNumber(tickValue: DataType): number
Converts value from axis inits to number.
Parameters
- tickValue: DataType
Returns number
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:306

`Protected` cleanMajorTicks

cleanMajorTicks(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:391

`Protected` `Abstract` createMajorTicksGenerator

createMajorTicksGenerator(): MajorTicksGenerator<DataType>
Returns MajorTicksGenerator<DataType>
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:262

`Protected` `Abstract` createMinorTicksGenerator

createMinorTicksGenerator(): undefined | MinorTicksGenerator<DataType>
Returns undefined | MinorTicksGenerator<DataType>
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:263

detach

detach(): void
Detaches item the to renderer.

Returns void
Inherited from ChartRenderableItem.detach
- Defined in projects/some-charts-lib/src/renderer/renderable-item.ts:32

`Protected` evaluateLabelsLayout

evaluateLabelsLayout(axisSize: Size, ticksLabelsSizes: Size[], ticks: Tick<DataType>[], range: Range<DataType>): LabelsLayout
Evaluates labels layout for the axis (whether they overlap with each other or are too close). Returns the result of labels layout evaluation.

Returns
Parameters
- axisSize: Size
  
  axis size;
- ticksLabelsSizes: Size[]
  
  sizes of ticks labels;
- ticks: Tick<DataType>[]
  
  ticks.
- range: Range<DataType>
  
  axis range.
Returns LabelsLayout
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:523

`Protected` generateMajorTicks

generateMajorTicks(range: Range<DataType>, size: Size): Tick<DataType>[]
Generates ticks for specified axis.

Returns
Parameters
- range: Range<DataType>
  
  axis range.
- size: Size
  
  axis size;
Returns Tick<DataType>[]
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:457

getDependantLayers

getDependantLayers(): string[]
Returns string[]
Inherited from ChartRenderableItem.getDependantLayers
- Defined in projects/some-charts-lib/src/chart/chart-renderable-item.ts:34

getMajorTicksScreenCoords

getMajorTicksScreenCoords(): number[]
Returns major ticks screen coordinates

Returns
Major ticks screen coordinates

Returns number[]
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:558

getOrientation

getOrientation(): AxisOrientation
Returns axis orientation

Returns
axis orientation.

Returns AxisOrientation
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:285

getSize

getSize(): Size
Returns axis size

Returns
axis size.

Returns Size
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:277

`Protected` getTickScreenCoordinate

getTickScreenCoordinate(tick: Tick<DataType>, screenWidth: number, screenHeight: number, range: Range<DataType>): number
Returns tick's screen coordinate

Returns
Tick's screen coordinate.
Parameters
- tick: Tick<DataType>
- screenWidth: number
- screenHeight: number
- range: Range<DataType>
Returns number
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:293

`Protected` measureLabelSize

measureLabelSize(label: string): Size
Generates label's size for specified label.

Returns
Label's size.
Parameters
- label: string
  
  Label to measure.
Returns Size
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:349

`Protected` measureLabelSizeForMajorTick

measureLabelSizeForMajorTick(tick: Tick<DataType>): Size
Measures label's size for specified major tick.

Returns
Label's size.
Parameters
- tick: Tick<DataType>
  
  Tick for which to generate label size.
Returns Size
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:329

`Protected` measureLabelsSizesForMajorTicks

measureLabelsSizesForMajorTicks(ticks: Tick<DataType>[]): Size[]
Measures labels sizes for an array of major ticks

Returns
Parameters
- ticks: Tick<DataType>[]
  
  Array of ticks
Returns Size[]
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:313

placeOnChart

placeOnChart(chart?: Chart<any, string | number | Date, undefined>): void
Parameters
- Optional chart: Chart<any, string | number | Date, undefined>
Returns void
Overrides ChartRenderableItem.placeOnChart
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:265

removeFromChart

removeFromChart(): void
Returns void
Inherited from ChartRenderableItem.removeFromChart
- Defined in projects/some-charts-lib/src/chart/chart-renderable-item.ts:26

`Protected` renderHorizontalMinorTicks

renderHorizontalMinorTicks(context: Context): void
Parameters
- context: Context
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:212

`Protected` renderVerticalMinorTicks

renderVerticalMinorTicks(context: Context): void
Parameters
- context: Context
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:231

update

update(location: NumericPoint, range: Range<DataType>, width?: number, height?: number): void
Updates axis state.
Parameters
- location: NumericPoint
  
  axis location on chart.
- range: Range<DataType>
  
  axis data range.
- Optional width: number
  
  axis width. May be undefined (for vertical axis only)
- Optional height: number
  
  axis height. May be undefined (for horizontal axis only)
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:362

`Protected` updateAxisSize

updateAxisSize(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:428

`Private` updateBorderShape

updateBorderShape(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:562

`Protected` updateMajorTicks

updateMajorTicks(range: Range<DataType>, size: Size): void
Parameters
- range: Range<DataType>
- size: Size
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:396

`Protected` updateMinorTicks

updateMinorTicks(range: Range<DataType>): void
Parameters
- range: Range<DataType>
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:402

`Protected` updateTicksScreenCoords

updateTicksScreenCoords(location: NumericPoint, range: Range<DataType>, size: Size): void
Parameters
- location: NumericPoint
- range: Range<DataType>
- size: Size
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:406

`Protected` updateTicksShape

updateTicksShape(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:569

`Protected` validateAxisInitialHeight

validateAxisInitialHeight(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:256

`Protected` validateAxisInitialWidth

validateAxisInitialWidth(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:250

Class AxisBase<DataType, AxisOptionsType>Abstract

Type Parameters

DataType extends Object

AxisOptionsType extends AxisOptions

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

DataType extends Object

AxisOptionsType extends AxisOptions

Parameters

location: NumericPoint

orientation: AxisOrientation

range: Range<DataType>

dataTransformation: DataTransformation

options: AxisOptionsType

Optional width: number

Optional height: number

textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance

Returns AxisBase<DataType, AxisOptionsType>

Properties

Optional _chart

Protected _size

Private borderShape

Private dataTransformation

Readonly id

Protected initialHeight

Protected initialWidth

Protected konvaDrawables

Protected layerId

Protected location

Protected majorTicks

Protected Readonly majorTicksGenerator

Protected Optional majorTicksLabelsSizes

Protected majorTicksScreenCoords

Protected Optional minorTicks

Protected Optional Readonly minorTicksGenerator

Protected minorTicksScreenCoords

Protected options

Protected orientation

Protected range

Protected textMeasureUtils

Private ticksShape

Static Readonly generateMajorTicksMaxAttempts

Static Readonly textVerticalOffsetMultiplier

Accessors

chart

Returns

Returns undefined | Chart<any, string | number | Date, undefined>

size

Returns Size

Methods

attach

Parameters

renderer: Renderer

Returns void

Abstract axisValueToNumber

Parameters

tickValue: DataType

Returns number

Protected cleanMajorTicks

Returns void

Protected Abstract createMajorTicksGenerator

Returns MajorTicksGenerator<DataType>

Protected Abstract createMinorTicksGenerator

Returns undefined | MinorTicksGenerator<DataType>

detach

Returns void

Protected evaluateLabelsLayout

Returns

Parameters

axisSize: Size

ticksLabelsSizes: Size[]

ticks: Tick<DataType>[]

range: Range<DataType>

Class AxisBase<DataType, AxisOptionsType>`Abstract`

`Protected` constructor

`Optional` width: number

`Optional` height: number

`Optional` _chart

`Protected` _size

`Private` borderShape

`Private` dataTransformation

`Readonly` id

`Protected` initialHeight

`Protected` initialWidth

`Protected` konvaDrawables

`Protected` layerId

`Protected` location

`Protected` majorTicks

`Protected` `Readonly` majorTicksGenerator

`Protected` `Optional` majorTicksLabelsSizes

`Protected` majorTicksScreenCoords

`Protected` `Optional` minorTicks

`Protected` `Optional` `Readonly` minorTicksGenerator

`Protected` minorTicksScreenCoords

`Protected` options

`Protected` orientation

`Protected` range

`Protected` textMeasureUtils

`Private` ticksShape

`Static` `Readonly` generateMajorTicksMaxAttempts

`Static` `Readonly` textVerticalOffsetMultiplier

`Abstract` axisValueToNumber

`Protected` cleanMajorTicks

`Protected` `Abstract` createMajorTicksGenerator

`Protected` `Abstract` createMinorTicksGenerator

`Protected` evaluateLabelsLayout

`Protected` generateMajorTicks

`Protected` getTickScreenCoordinate

`Protected` measureLabelSize

`Protected` measureLabelSizeForMajorTick

`Protected` measureLabelsSizesForMajorTicks

`Optional` chart: Chart<any, string | number | Date, undefined>

`Protected` renderHorizontalMinorTicks

`Protected` renderVerticalMinorTicks

`Optional` width: number

`Optional` height: number

`Protected` updateAxisSize

`Private` updateBorderShape

`Protected` updateMajorTicks