Class Label

Implementation of RenderableItem class drawn on chart.

Hierarchy

ChartRenderableItem<Konva.Shape>
- Label

Index

Constructors

Properties

_chart? id konvaDrawables labelShape layerId location options textMeasureUtils textSize textTopBottomOffset width

Accessors

Methods

attach detach getDependantLayers placeOnChart removeFromChart update updateLabelShape

Constructors

constructor

new Label(location: NumericPoint, width: number, options: LabelOptions, textMeasureUtils?: TextMeasureUtils): Label
Parameters
- location: NumericPoint
- width: number
- options: LabelOptions
- textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance
Returns Label
Overrides ChartRenderableItem.constructor
- Defined in projects/some-charts-lib/src/chart/label.ts:27

Properties

`Optional` _chart

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

`Readonly` id

id: number

`Protected` konvaDrawables

konvaDrawables: Shape<ShapeConfig>[]

`Private` labelShape

labelShape: Shape<ShapeConfig>

`Protected` layerId

layerId: string

`Private` location

location: NumericPoint

`Private` options

options: LabelOptions

`Private` textMeasureUtils

textMeasureUtils: TextMeasureUtils = TextMeasureUtils.Instance

`Private` textSize

textSize: Size

`Private` textTopBottomOffset

textTopBottomOffset: number

`Private` width

width: number

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

height

get height(): number
Returns number
- Defined in projects/some-charts-lib/src/chart/label.ts:23

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

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

getDependantLayers

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

placeOnChart

placeOnChart(chart?: Chart<any, string | number | Date, undefined>): void
Parameters
- Optional chart: Chart<any, string | number | Date, undefined>
Returns void
Inherited from ChartRenderableItem.placeOnChart
- Defined in projects/some-charts-lib/src/chart/chart-renderable-item.ts:14

removeFromChart

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

update

update(location: NumericPoint, width: number): void
Sets location and width of this label
Parameters
- location: NumericPoint
  
  Label location on the canvas.
- width: number
  
  Label render width.
Returns void
- Defined in projects/some-charts-lib/src/chart/label.ts:73

`Private` updateLabelShape

updateLabelShape(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/label.ts:80

Generated using TypeDoc