core/io.data2viz.charts.chart.mark/BoxPlotMark

BoxPlotMark

interface BoxPlotMark<DOMAIN, XVAL, YVAL> : MarkXY<DOMAIN, XVAL, YVAL> , HasSymbol<DOMAIN> , HasFill<DOMAIN> , HasSize<DOMAIN> , HasStrokeColor<DOMAIN> , HasStrokeWidth<DOMAIN> , HasCustomTooltip<DOMAIN> , HasLegendDecorator<DOMAIN>

Draw BoxPlot (or candle) for a given Dataset and X and Y Dimensions.

Functions

drawHighlight

common

open fun drawHighlight(drawingZone: DrawingZone, highlightedData: Collection<Datum<DOMAIN>>)

Draw a highlighted sign on the DrawingZone for each elements of a given dataset.

drawMark

common

open fun drawMark(drawingZone: DrawingZone, dataset: Dataset<DOMAIN>)

Draw a sign on the DrawingZone for each elements of a given dataset.

drawSelection

common

open fun drawSelection(drawingZone: DrawingZone, selectedData: Collection<Datum<DOMAIN>>)

Draw a selected sign on the DrawingZone for each elements of a given dataset.

getEventZones

common

open fun getEventZones(dataset: Dataset<DOMAIN>): Collection<EventZone<DOMAIN>>

Get all of interactive zones for this Mark.

getTooltipPosition

common

abstract fun getTooltipPosition(datum: Datum<DOMAIN>, drawingZone: DrawingZone): TooltipPosition?

Return the TooltipPosition if available for th given Datum and the current DrawingZone.

prepare

common

open fun prepare(dataset: Dataset<DOMAIN>)

The prepare function is called once on the initialization of mark and on data changed.

common

open fun x(configLambda: Axis<DOMAIN, XVAL>.() -> Unit)

An initialization lambda for configuring the X Axis used in this Mark.

common

open fun y(configLambda: Axis<DOMAIN, YVAL>.() -> Unit)

An initialization lambda for configuring the Y Axis used in this Mark.

Properties

defaultLegendDecorator

common

abstract val defaultLegendDecorator: DatumDecorator<DOMAIN>

The default legend decorator for a given Datum.

fill

common

abstract var fill: Dimension<DOMAIN, ColorOrGradient?>

The Dimension used to define a filling color from a DOMAIN object.

fillHighlight

common

abstract var fillHighlight: Dimension<DOMAIN, ColorOrGradient?>

The Dimension used to define a filling color from a DOMAIN object.

fillSelect

common

abstract var fillSelect: Dimension<DOMAIN, ColorOrGradient?>

The Dimension used to define a filling color from a DOMAIN object.

legendDecorator

common

abstract var legendDecorator: DatumDecorator<DOMAIN>

The legend decorator lambda will be called on each series, use this to draw custom decorations for your series.

lowerQuartile

common

abstract var lowerQuartile: Datum<DOMAIN>.() -> Double

The "lower Quartile" or "First quartile" value accessor, use this to provide the value for each of your domain object.

maximum

common

abstract var maximum: Datum<DOMAIN>.() -> Double

The "maximum" value accessor, use this to provide the "maximum" value for each of your domain object.

minimum

common

abstract var minimum: Datum<DOMAIN>.() -> Double

The "minimum" value accessor, use this to provide the "minimum" value for each of your domain object.

outliers

common

abstract var outliers: Datum<DOMAIN>.() -> List<Double>

The "outliers" value(s) accessor, use this to provide the "outliers" value(s) as a List for each of your domain object.

showSymbols

common

abstract var showSymbols: Boolean

Show / hide symbols.

size

common

abstract var size: Dimension<DOMAIN, Double?>

The Dimension used to define the size of a sign from a DOMAIN object.

strokeColor

common

abstract var strokeColor: Dimension<DOMAIN, Color?>

The Dimension used to define the stroke color from a DOMAIN object.

strokeColorHighlight

common

abstract var strokeColorHighlight: Dimension<DOMAIN, Color?>

The Dimension used to define the "highlighted" stroke color from a DOMAIN object.

strokeColorSelect

common

abstract var strokeColorSelect: Dimension<DOMAIN, Color?>

The Dimension used to define the "selected" stroke color from a DOMAIN object.

strokeWidth

common

abstract var strokeWidth: Dimension<DOMAIN, Double?>

The Dimension used to define the stroke thickness from a DOMAIN object.

strokeWidthHighlight

common

abstract var strokeWidthHighlight: Dimension<DOMAIN, Double?>

The Dimension used to define the "highlighted" stroke thickness from a DOMAIN object.

strokeWidthSelect

common

abstract var strokeWidthSelect: Dimension<DOMAIN, Double?>

The Dimension used to define the "selected" stroke thickness from a DOMAIN object.

symbol

common

abstract var symbol: Dimension<DOMAIN, Symbols?>

The Dimension used to define the shape (symbol) of a sign from a DOMAIN object.

upperQuartile

common

abstract var upperQuartile: Datum<DOMAIN>.() -> Double

The "upper Quartile" or "Third quartile" value accessor, use this to provide the value for each of your domain object.

common

abstract val x: Axis<DOMAIN, XVAL>

The Axis used to translate data values into a X position.

xAxisConfig

common

abstract val xAxisConfig: AxisConfig

The configuration object AxisConfig used for the X axis.

common

abstract val y: Axis<DOMAIN, YVAL>

The Axis used to translate data values into a Y position.

yAxisConfig

common

abstract val yAxisConfig: AxisConfig

The configuration object AxisConfig used for the Y axis.