Class Grid

Implementation of RenderableItem class drawn on chart.

Hierarchy

ChartRenderableItem<Konva.Shape>
- Grid

Index

Constructors

Properties

_chart? borderShape compositeShape horizontalLinesCoords id konvaDrawables layerId location options size verticalLinesCoords

Accessors

Methods

attach detach getDependantLayers placeOnChart removeFromChart setLinesCoords update updateGridShapes

Constructors

constructor

new Grid(location: NumericPoint, size: Size, options?: GridOptions): Grid
Creates new instance of grid. Grid is grid net on chart's plot area.
Parameters
- location: NumericPoint
  
  Grid location on renderer.
- size: Size
  
  Grid size.
- Optional options: GridOptions
  
  Grid options object.
Returns Grid
Overrides ChartRenderableItem.constructor
- Defined in projects/some-charts-lib/src/chart/grid.ts:31

Properties

`Optional` _chart

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

`Private` borderShape

borderShape: Shape<ShapeConfig>

`Private` compositeShape

compositeShape: Shape<ShapeConfig>

`Protected` horizontalLinesCoords

horizontalLinesCoords: number[]

`Readonly` id

id: number

`Protected` konvaDrawables

konvaDrawables: Shape<ShapeConfig>[]

`Protected` layerId

layerId: string

`Private` location

location: NumericPoint

`Private` options

options: GridOptions

`Private` size

size: Size

`Protected` verticalLinesCoords

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

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

setLinesCoords

setLinesCoords(horizontalLinesCoords: number[], verticalLinesCoords: number[]): void
Uprates grid's horizontal and vertical lines.
Parameters
- horizontalLinesCoords: number[]
  
  Grid's horizontal lines Y coordinates.
- verticalLinesCoords: number[]
  
  Grid's vertical lines X coordinates.
Returns void
- Defined in projects/some-charts-lib/src/chart/grid.ts:149

update

update(location: NumericPoint, size: Size): void
Uprates grid's state.
Parameters
- location: NumericPoint
  
  Grid location on renderer.
- size: Size
  
  Grid size.
Returns void
- Defined in projects/some-charts-lib/src/chart/grid.ts:138

`Private` updateGridShapes

updateGridShapes(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/grid.ts:156

Generated using TypeDoc