Class Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>`Abstract`

Implementation of RenderableItem class drawn on chart.

Type Parameters

PlotOptionsType extends PlotOptions
PlotOptionsClassType extends PlotOptionsClass
TItemType
XDimensionType extends number | string | Date
YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

ChartRenderableItem<Konva.Group>
- Plot

Implements

Constructors

`Protected` constructor

new Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>(dataSet: DataSet<TItemType, XDimensionType, YDimensionType>, dataTransformation: DataTransformation, plotOptions: PlotOptionsType): Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>
Type Parameters
- PlotOptionsType extends PlotOptions
- PlotOptionsClassType extends PlotOptionsClass<PlotOptionsClassType>
- TItemType
- XDimensionType extends string | number | Date
- YDimensionType extends undefined | string | number | Date = undefined
Parameters
- dataSet: DataSet<TItemType, XDimensionType, YDimensionType>
- dataTransformation: DataTransformation
- plotOptions: PlotOptionsType
Returns Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>
Overrides ChartRenderableItem.constructor
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:47

Properties

`Optional` _chart

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

`Protected` `Readonly` dataSet

dataSet: DataSet<TItemType, XDimensionType, YDimensionType>

`Protected` dataTransformation

dataTransformation: DataTransformation

`Readonly` eventTarget

eventTarget: ACEventTarget<Tick>

`Readonly` id

id: number

`Protected` konvaDrawables

konvaDrawables: Group[]

`Protected` layerId

layerId: string

`Private` metricPoints1DMap

metricPoints1DMap: Map<string, (NumericPoint | NumericPoint[])[]>

`Protected` plotOptions

plotOptions: PlotOptionsClassType

`Protected` screen

screen: undefined | NumericDataRect

`Protected` shapesGroup

shapesGroup: Group

`Protected` visible

visible: undefined | NumericDataRect

`Static` `Protected` `Readonly` errors

errors: {
doesntSupport2DData: string;
} = ...

Type declaration

doesntSupport2DData: string

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

`Protected` buildPlotOptionsClass

buildPlotOptionsClass(plotOptions: PlotOptionsType): PlotOptionsClassType
Parameters
- plotOptions: PlotOptionsType
Returns PlotOptionsClassType
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:81

`Protected` clearPreCalculatedDataSetRelatedData

clearPreCalculatedDataSetRelatedData(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:130

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

dispose

dispose(): void
Returns void
Implementation of IDisposable.dispose
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:217

eventCallback

eventCallback(event: EventBase<Changed | Tick>, options?: any): void
Parameters
- event: EventBase<Changed | Tick>
- Optional options: any
Returns void
Implementation of EventListener.eventCallback
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:89

`Protected` getArrayMetricPoints1D

getArrayMetricPoints1D(metricId: string): undefined | NumericPoint[][]
Parameters
- metricId: string
Returns undefined | NumericPoint[][]
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:194

`Abstract` getBoundingRectangle

getBoundingRectangle(): undefined | NumericDataRect
Calculates bounding rectangle of this plot.

Returns undefined | NumericDataRect
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:211

`Protected` getColor

getColor(color: Color<ColorParam> | Palette, xDimVal: DimensionValue<XDimensionType>, yDimVal?: undefined | DimensionValue<Exclude<YDimensionType, undefined>>): Color<ColorParam>
Parameters
- color: Color<ColorParam> | Palette
- xDimVal: DimensionValue<XDimensionType>
- yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>> = undefined
Returns Color<ColorParam>
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:134

getDependantLayers

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

`Protected` getDependantNumericValueForMetricValue

getDependantNumericValueForMetricValue(dependant: MetricDependantValue<number>, xDimVal: DimensionValue<XDimensionType>, YDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>): undefined | number
Parameters
- dependant: MetricDependantValue<number>
- xDimVal: DimensionValue<XDimensionType>
- YDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>
Returns undefined | number
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:148

getFitToViewMargin

getFitToViewMargin(): Margin
Returns Margin
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:213

`Protected` getMetricPoint1D

getMetricPoint1D(metricId: string, xDimension: DimensionValue<XDimensionType>): undefined | NumericPoint | NumericPoint[]
Parameters
- metricId: string
- xDimension: DimensionValue<XDimensionType>
Returns undefined | NumericPoint | NumericPoint[]
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:182

`Protected` getMetricPoints1D

getMetricPoints1D(metricId: string): undefined | (NumericPoint | NumericPoint[])[]
Parameters
- metricId: string
Returns undefined | (NumericPoint | NumericPoint[])[]
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:162

`Protected` getSingleMetricPoint1D

getSingleMetricPoint1D(metricId: string, xDimension: DimensionValue<XDimensionType>): undefined | NumericPoint
Parameters
- metricId: string
- xDimension: DimensionValue<XDimensionType>
Returns undefined | NumericPoint
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:201

`Protected` getSingleMetricPoints1D

getSingleMetricPoints1D(metricId: string): undefined | NumericPoint[]
Parameters
- metricId: string
Returns undefined | NumericPoint[]
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:187

`Protected` init

init(plotOptions: PlotOptionsClassType): void
Parameters
- plotOptions: PlotOptionsClassType
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:85

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

`Protected` `Abstract` rebuildShapesFromDataSet

rebuildShapesFromDataSet(dataSetChange: DataSetChange<XDimensionType, YDimensionType>): void
Parameters
- dataSetChange: DataSetChange<XDimensionType, YDimensionType>
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:126

`Protected` reinitOnDataSetUpdate

reinitOnDataSetUpdate(): void
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:111

removeFromChart

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

`Protected` updateFromDataSet

updateFromDataSet(dataSetChange: DataSetChange<XDimensionType, YDimensionType>): void
Parameters
- dataSetChange: DataSetChange<XDimensionType, YDimensionType>
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:98

`Protected` `Abstract` updateShapesVisibleAndScreen

updateShapesVisibleAndScreen(dataTransformation: DataTransformation, visible: NumericDataRect, screen: NumericDataRect): void
Parameters
- dataTransformation: DataTransformation
- visible: NumericDataRect
- screen: NumericDataRect
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:128

updateVisibleAndScreen

updateVisibleAndScreen(visible: NumericDataRect, screen: NumericDataRect): void
Sets visible and screen rectangle of plot
Parameters
- visible: NumericDataRect
  
  Visible rectangle of plot.
- screen: NumericDataRect
  
  Screen rectangle of plot.
Returns void
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:118

Class Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>Abstract

Type Parameters

PlotOptionsType extends PlotOptions

PlotOptionsClassType extends PlotOptionsClass

TItemType

XDimensionType extends number | string | Date

YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

PlotOptionsType extends PlotOptions

PlotOptionsClassType extends PlotOptionsClass<PlotOptionsClassType>

TItemType

XDimensionType extends string | number | Date

YDimensionType extends undefined | string | number | Date = undefined

Parameters

dataSet: DataSet<TItemType, XDimensionType, YDimensionType>

dataTransformation: DataTransformation

plotOptions: PlotOptionsType

Returns Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>

Properties

Optional _chart

Protected Readonly dataSet

Protected dataTransformation

Readonly eventTarget

Readonly id

Protected konvaDrawables

Protected layerId

Private metricPoints1DMap

Protected plotOptions

Protected screen

Protected shapesGroup

Protected visible

Static Protected Readonly errors

Type declaration

doesntSupport2DData: string

Accessors

chart

Returns

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

Methods

attach

Parameters

renderer: Renderer

Returns void

Protected buildPlotOptionsClass

Parameters

plotOptions: PlotOptionsType

Returns PlotOptionsClassType

Protected clearPreCalculatedDataSetRelatedData

Returns void

detach

Returns void

dispose

Returns void

eventCallback

Parameters

event: EventBase<Changed | Tick>

Optional options: any

Returns void

Protected getArrayMetricPoints1D

Parameters

metricId: string

Returns undefined | NumericPoint[][]

Abstract getBoundingRectangle

Returns undefined | NumericDataRect

Protected getColor

Parameters

color: Color<ColorParam> | Palette

xDimVal: DimensionValue<XDimensionType>

yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>> = undefined

Returns Color<ColorParam>

getDependantLayers

Class Plot<PlotOptionsType, PlotOptionsClassType, TItemType, XDimensionType, YDimensionType>`Abstract`

`Protected` constructor

`Optional` _chart

`Protected` `Readonly` dataSet

`Protected` dataTransformation

`Readonly` eventTarget

`Readonly` id

`Protected` konvaDrawables

`Protected` layerId

`Private` metricPoints1DMap

`Protected` plotOptions

`Protected` screen

`Protected` shapesGroup

`Protected` visible

`Static` `Protected` `Readonly` errors

`Protected` buildPlotOptionsClass

`Protected` clearPreCalculatedDataSetRelatedData

`Optional` options: any

`Protected` getArrayMetricPoints1D

`Abstract` getBoundingRectangle

`Protected` getColor

`Protected` getDependantNumericValueForMetricValue

`Protected` getMetricPoint1D

`Protected` getMetricPoints1D

`Protected` getSingleMetricPoint1D

`Protected` getSingleMetricPoints1D

`Protected` init

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

`Protected` `Abstract` rebuildShapesFromDataSet

`Protected` reinitOnDataSetUpdate

`Protected` updateFromDataSet

`Protected` `Abstract` updateShapesVisibleAndScreen