Class LabeledAxis

Implementation of RenderableItem class drawn on chart.

Hierarchy

AxisBase<number, AxisOptions>
- LabeledAxis

Index

Constructors

constructor

Accessors

chart size

Constructors

constructor

new LabeledAxis(location: NumericPoint, orientation: AxisOrientation, range: NumericRange, dataTransformation: DataTransformation, options: AxisOptions, width?: number, height?: number): LabeledAxis
Creates axis with string labels on it.
Parameters
- location: NumericPoint
  
  Axis location.
- orientation: AxisOrientation
  
  Axis orientation.
- range: NumericRange
  
  Axis range (it's min and max values)
- dataTransformation: DataTransformation
  
  transformation of data from data coordinates to screen coordinate and vice versa.
- options: AxisOptions
- Optional width: number
  
  Axis width.
- Optional height: number
  
  Axis height.
Returns LabeledAxis
Overrides AxisBase.constructor
- Defined in projects/some-charts-lib/src/chart/axis/labeled/labeled-axis.ts:21

Properties

`Optional` _chart

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

`Protected` _size

_size: Size

`Readonly` id

id: number

`Protected` initialHeight

initialHeight: undefined | number

`Protected` initialWidth

initialWidth: undefined | number

`Protected` konvaDrawables

konvaDrawables: Shape<ShapeConfig>[]

`Private` labels

labels: Point<string>[]

`Protected` layerId

layerId: string

`Protected` location

location: NumericPoint

`Protected` majorTicks

majorTicks: Tick<number>[]

`Protected` `Readonly` majorTicksGenerator

majorTicksGenerator: MajorTicksGenerator<number>

`Protected` `Optional` majorTicksLabelsSizes

majorTicksLabelsSizes?: Size[]

`Protected` majorTicksScreenCoords

majorTicksScreenCoords: number[]

`Protected` `Optional` minorTicks

minorTicks?: Tick<number>[]

`Protected` `Optional` `Readonly` minorTicksGenerator

minorTicksGenerator?: MinorTicksGenerator<number>

`Protected` minorTicksScreenCoords

minorTicksScreenCoords: number[]

`Protected` options

options: AxisOptions

`Protected` orientation

orientation: AxisOrientation

`Protected` range

range: Range<number>

`Protected` textMeasureUtils

textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance

`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 AxisBase.chart
- Defined in projects/some-charts-lib/src/chart/chart-content.ts:26

size

get size(): Size
Returns Size
Inherited from AxisBase.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 AxisBase.attach
- Defined in projects/some-charts-lib/src/renderer/renderable-item.ts:22

axisValueToNumber

axisValueToNumber(tickValue: number): number
Converts value from axis inits to number.
Parameters
- tickValue: number
Returns number
Overrides AxisBase.axisValueToNumber
- Defined in projects/some-charts-lib/src/chart/axis/labeled/labeled-axis.ts:34

detach

detach(): void
Detaches item the to renderer.

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

`Protected` evaluateLabelsLayout

evaluateLabelsLayout(axisSize: Size, ticksLabelsSizes: Size[], ticks: Tick<number>[], range: Range<number>): 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<number>[]
  
  ticks.
- range: Range<number>
  
  axis range.
Returns LabelsLayout
Inherited from AxisBase.evaluateLabelsLayout
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:523

`Protected` generateMajorTicks

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

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

getDependantLayers

getDependantLayers(): string[]
Returns string[]
Inherited from AxisBase.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[]
Inherited from AxisBase.getMajorTicksScreenCoords
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:558

getOrientation

getOrientation(): AxisOrientation
Returns axis orientation

Returns
axis orientation.

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

getSize

getSize(): Size
Returns axis size

Returns
axis size.

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

`Protected` getTickScreenCoordinate

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

Returns
Tick's screen coordinate.
Parameters
- tick: Tick<number>
- screenWidth: number
- screenHeight: number
- range: Range<number>
Returns number
Inherited from AxisBase.getTickScreenCoordinate
- 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
Inherited from AxisBase.measureLabelSize
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:349

`Protected` measureLabelSizeForMajorTick

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

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

`Protected` measureLabelsSizesForMajorTicks

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

Returns
Parameters
- ticks: Tick<number>[]
  
  Array of ticks
Returns Size[]
Inherited from AxisBase.measureLabelsSizesForMajorTicks
- 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
Inherited from AxisBase.placeOnChart
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:265

removeFromChart

removeFromChart(): void
Returns void
Inherited from AxisBase.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
Inherited from AxisBase.renderHorizontalMinorTicks
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:212

`Protected` renderVerticalMinorTicks

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

update

update(location: NumericPoint, range: Range<number>, width?: number, height?: number): void
Updates axis state.
Parameters
- location: NumericPoint
  
  axis location on chart.
- range: Range<number>
  
  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
Inherited from AxisBase.update
- Defined in projects/some-charts-lib/src/chart/axis/axis-base.ts:362

`Protected` updateAxisSize

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

updateLabels

updateLabels(labels: Point<string>[]): void
Parameters
- labels: Point<string>[]
Returns void
- Defined in projects/some-charts-lib/src/chart/axis/labeled/labeled-axis.ts:38

`Protected` updateMajorTicks

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

`Protected` updateMinorTicks

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

`Protected` updateTicksScreenCoords

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

`Protected` updateTicksShape

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

`Protected` validateAxisInitialHeight

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

`Protected` validateAxisInitialWidth

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

Class LabeledAxis

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

location: NumericPoint

orientation: AxisOrientation

range: NumericRange

dataTransformation: DataTransformation

options: AxisOptions

Optional width: number

Optional height: number

Returns LabeledAxis

Properties

Optional _chart

Protected _size

Readonly id

Protected initialHeight

Protected initialWidth

Protected konvaDrawables

Private labels

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

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

axisValueToNumber

Parameters

tickValue: number

Returns number

Protected cleanMajorTicks

Returns void

Protected createMajorTicksGenerator

Returns MajorTicksGenerator<number>

Protected createMinorTicksGenerator

Returns undefined | MinorTicksGenerator<number>

detach

Returns void

Protected evaluateLabelsLayout

Returns

Parameters

axisSize: Size

ticksLabelsSizes: Size[]

ticks: Tick<number>[]

range: Range<number>

Returns LabelsLayout

Protected generateMajorTicks

Returns

Parameters

range: Range<number>

size: Size

Returns Tick<number>[]

getDependantLayers

Returns string[]

`Optional` width: number

`Optional` height: number

`Optional` _chart

`Protected` _size

`Readonly` id

`Protected` initialHeight

`Protected` initialWidth

`Protected` konvaDrawables

`Private` labels

`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

`Static` `Readonly` generateMajorTicksMaxAttempts

`Static` `Readonly` textVerticalOffsetMultiplier

`Protected` cleanMajorTicks

`Protected` createMajorTicksGenerator

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

`Protected` updateMajorTicks

`Protected` updateMinorTicks

`Protected` updateTicksScreenCoords