Class BoxPlot<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType
XDimensionType extends number | string | Date
YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

ElementwisePlot<BoxPlotOptions, BoxPlotOptionsClass, TItemType, XDimensionType, YDimensionType>
- BoxPlot

Constructors

constructor

new BoxPlot<TItemType, XDimensionType, YDimensionType>(dataSet: DataSet<TItemType, XDimensionType, YDimensionType>, dataTransformation: DataTransformation, options: BoxPlotOptions, plotErrorBuilder?: PlotErrorBuilder): BoxPlot<TItemType, XDimensionType, YDimensionType>
Type Parameters
- TItemType
- XDimensionType extends string | number | Date
- YDimensionType extends undefined | string | number | Date = undefined
Parameters
- dataSet: DataSet<TItemType, XDimensionType, YDimensionType>
- dataTransformation: DataTransformation
- options: BoxPlotOptions
- plotErrorBuilder: PlotErrorBuilder = PlotErrorBuilder.Instance
Returns BoxPlot<TItemType, XDimensionType, YDimensionType>
Overrides ElementwisePlot<BoxPlotOptions, BoxPlotOptionsClass, TItemType, XDimensionType, YDimensionType>.constructor
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:21

Properties

`Optional` _chart

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

`Private` boxDataWidth

boxDataWidth: number = 0

`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

`Protected` plotElements

plotElements: PlotDrawableElement<Group | Shape<ShapeConfig>>[]

`Protected` plotErrorBuilder

plotErrorBuilder: PlotErrorBuilder = PlotErrorBuilder.Instance

`Protected` plotOptions

plotOptions: BoxPlotOptionsClass

`Protected` screen

screen: undefined | NumericDataRect

`Protected` shapesGroup

shapesGroup: Group

`Protected` visible

visible: undefined | NumericDataRect

`Private` whiskersDataWidth

whiskersDataWidth: number = 0

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

Methods

`Protected` add1DPlotElements

add1DPlotElements(xDimVal: DimensionValue<XDimensionType>): [PlotDrawableElement<Group | Shape<ShapeConfig>>]
Parameters
- xDimVal: DimensionValue<XDimensionType>
Returns [PlotDrawableElement<Group | Shape<ShapeConfig>>]
Overrides ElementwisePlot.add1DPlotElements
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:37

`Protected` add2DPlotElements

add2DPlotElements(xDimVal: DimensionValue<XDimensionType>, yDimVal: DimensionValue<Exclude<YDimensionType, undefined>>): [PlotDrawableElement<Group | Shape<ShapeConfig>>]
Parameters
- xDimVal: DimensionValue<XDimensionType>
- yDimVal: DimensionValue<Exclude<YDimensionType, undefined>>
Returns [PlotDrawableElement<Group | Shape<ShapeConfig>>]
Overrides ElementwisePlot.add2DPlotElements
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:55

attach

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

`Protected` buildPlotOptionsClass

buildPlotOptionsClass(plotOptions: BoxPlotOptions): BoxPlotOptionsClass
Parameters
- plotOptions: BoxPlotOptions
Returns BoxPlotOptionsClass
Inherited from ElementwisePlot.buildPlotOptionsClass
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:81

`Protected` clearPreCalculatedDataSetRelatedData

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

detach

detach(): void
Detaches item the to renderer.

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

dispose

dispose(): void
Returns void
Inherited from ElementwisePlot.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
Inherited from ElementwisePlot.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[][]
Inherited from ElementwisePlot.getArrayMetricPoints1D
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:194

`Protected` getAvgXDelta

getAvgXDelta(metricId: string): undefined | number
Parameters
- metricId: string
Returns undefined | number
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:80

getBoundingRectangle

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

Returns undefined | NumericDataRect
Inherited from ElementwisePlot.getBoundingRectangle
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/elementwise-plot.ts:129

`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>
Inherited from ElementwisePlot.getColor
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:134

getDependantLayers

getDependantLayers(): string[]
Returns string[]
Inherited from ElementwisePlot.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
Inherited from ElementwisePlot.getDependantNumericValueForMetricValue
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:148

getFitToViewMargin

getFitToViewMargin(): Margin
Returns Margin
Inherited from ElementwisePlot.getFitToViewMargin
- 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[]
Inherited from ElementwisePlot.getMetricPoint1D
- 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[])[]
Inherited from ElementwisePlot.getMetricPoints1D
- 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
Inherited from ElementwisePlot.getSingleMetricPoint1D
- 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[]
Inherited from ElementwisePlot.getSingleMetricPoints1D
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:187

`Protected` init

init(plotOptions: BoxPlotOptionsClass): void
Parameters
- plotOptions: BoxPlotOptionsClass
Returns void
Inherited from ElementwisePlot.init
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/elementwise-plot.ts:32

placeOnChart

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

`Protected` rebuildShapesFromDataSet

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

reinitOnDataSetUpdate

reinitOnDataSetUpdate(): void
Returns void
Overrides ElementwisePlot.reinitOnDataSetUpdate
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:31

removeFromChart

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

`Protected` update1DPlotElement

update1DPlotElement(plotElt: PlotDrawableElement<Group | Shape<ShapeConfig>>, xDimVal: DimensionValue<XDimensionType>): void
Parameters
- plotElt: PlotDrawableElement<Group | Shape<ShapeConfig>>
- xDimVal: DimensionValue<XDimensionType>
Returns void
Overrides ElementwisePlot.update1DPlotElement
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:59

`Protected` update2DPlotElement

update2DPlotElement(plotElt: PlotDrawableElement<Group | Shape<ShapeConfig>>, xDimVal: DimensionValue<XDimensionType>, yDimVal: DimensionValue<Exclude<YDimensionType, undefined>>): void
Parameters
- plotElt: PlotDrawableElement<Group | Shape<ShapeConfig>>
- xDimVal: DimensionValue<XDimensionType>
- yDimVal: DimensionValue<Exclude<YDimensionType, undefined>>
Returns void
Overrides ElementwisePlot.update2DPlotElement
- Defined in projects/some-charts-lib/src/chart/plots/elementwise/box/box-plot.ts:76

`Protected` updateFromDataSet

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

`Protected` updateShapesVisibleAndScreen

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

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
Inherited from ElementwisePlot.updateVisibleAndScreen
- Defined in projects/some-charts-lib/src/chart/plots/plot.ts:118

Class BoxPlot<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType

XDimensionType extends number | string | Date

YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TItemType

XDimensionType extends string | number | Date

YDimensionType extends undefined | string | number | Date = undefined

Parameters

dataSet: DataSet<TItemType, XDimensionType, YDimensionType>

dataTransformation: DataTransformation

options: BoxPlotOptions

plotErrorBuilder: PlotErrorBuilder = PlotErrorBuilder.Instance

Returns BoxPlot<TItemType, XDimensionType, YDimensionType>

Properties

Optional _chart

Private boxDataWidth

Protected Readonly dataSet

Protected dataTransformation

Readonly eventTarget

Readonly id

Protected konvaDrawables

Protected layerId

Protected plotElements

Protected plotErrorBuilder

Protected plotOptions

Protected screen

Protected shapesGroup

Protected visible

Private whiskersDataWidth

Static Protected Readonly errors

Type declaration

doesntSupport2DData: string

Accessors

chart

Returns

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

Methods

Protected add1DPlotElements

Parameters

xDimVal: DimensionValue<XDimensionType>

Returns [PlotDrawableElement<Group | Shape<ShapeConfig>>]

Protected add2DPlotElements

Parameters

xDimVal: DimensionValue<XDimensionType>

yDimVal: DimensionValue<Exclude<YDimensionType, undefined>>

Returns [PlotDrawableElement<Group | Shape<ShapeConfig>>]

attach

Parameters

renderer: Renderer

Returns void

Protected buildPlotOptionsClass

Parameters

plotOptions: BoxPlotOptions

Returns BoxPlotOptionsClass

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[][]

Protected getAvgXDelta

`Optional` _chart

`Private` boxDataWidth

`Protected` `Readonly` dataSet

`Protected` dataTransformation

`Readonly` eventTarget

`Readonly` id

`Protected` konvaDrawables

`Protected` layerId

`Protected` plotElements

`Protected` plotErrorBuilder

`Protected` plotOptions

`Protected` screen

`Protected` shapesGroup

`Protected` visible

`Private` whiskersDataWidth

`Static` `Protected` `Readonly` errors

`Protected` add1DPlotElements

`Protected` add2DPlotElements

`Protected` buildPlotOptionsClass

`Protected` clearPreCalculatedDataSetRelatedData

`Optional` options: any

`Protected` getArrayMetricPoints1D

`Protected` getAvgXDelta

`Protected` getColor

`Protected` getDependantNumericValueForMetricValue

`Protected` getMetricPoint1D

`Protected` getMetricPoints1D

`Protected` getSingleMetricPoint1D

`Protected` getSingleMetricPoints1D

`Protected` init

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

`Protected` rebuildShapesFromDataSet

`Protected` update1DPlotElement

`Protected` update2DPlotElement

`Protected` updateFromDataSet