Package io.data2viz.charts.chart.mark

Types

AreaMark

common

interface AreaMark<DOMAIN, XVAL, YVAL> : HasFill<DOMAIN> , HasSize<DOMAIN> , HasSymbol<DOMAIN> , HasCurve, HasStack, HasStrokeColor<DOMAIN> , HasStrokeWidth<DOMAIN> , HasStrokeLine<DOMAIN> , HasMarkDecorator<DOMAIN> , HasHighlightDecorator<DOMAIN> , HasSelectionDecorator<DOMAIN> , HasLegendDecorator<DOMAIN> , HasCustomTooltip<DOMAIN> , MarkXY<DOMAIN, XVAL, YVAL>

Draw an area for a given Dataset and X and Y Dimensions.

Axis

common

open class Axis<DOMAIN, VALUE>(data: List<Datum<DOMAIN>>, dimension: Dimension<DOMAIN, VALUE>, config: AxisConfig) : Scaler<VALUE> , AxisConfig

The core "axis" component for a given Mark.

BarMark

common

interface BarMark<DOMAIN, XVAL, YVAL> : HasFill<DOMAIN> , HasLabel<DOMAIN> , HasStrokeColor<DOMAIN> , HasStrokeWidth<DOMAIN> , HasStack, HasCustomTooltip<DOMAIN> , HasMarkDecorator<DOMAIN> , HasHighlightDecorator<DOMAIN> , HasSelectionDecorator<DOMAIN> , HasLegendDecorator<DOMAIN> , MarkXY<DOMAIN, XVAL, YVAL>

Draw horizontal bars for a given Dataset and X and Y Dimensions.

BoxPlotMark

common

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.

DatumDecorator

common

typealias DatumDecorator<DOMAIN> = (datum: Datum<DOMAIN>, position: Point, drawingZone: DrawingZone) -> Unit

A decorator lambda is called on each point, use this to draw custom decorations for your signs. It can be used on mark, selection, highlight.

EmptyMark

common

interface EmptyMark<DOMAIN, XVAL, YVAL> : MarkXY<DOMAIN, XVAL, YVAL>

An utility empty mark, can have a X and a Y axis, but does not draw anything.

HasCurve

common

interface HasCurve

A visual element that draw a Curve from Path.

HasCustomTooltip

common

interface HasCustomTooltip<DOMAIN>

If a Mark has some specificities (large size, custom layout, custom stacking...

HasFill

common

interface HasFill<DOMAIN>

A visual element that can change its filling color depending on the data.

HasHighlightDecorator

common

interface HasHighlightDecorator<DOMAIN>

A mark that implements HasMarkDecorator allows to define a DatumDecorator to highlight each of its Datums.

HasLabel

common

interface HasLabel<DOMAIN>

A visual element that can change its filling color depending on the data.

HasLegendDecorator

common

interface HasLegendDecorator<DOMAIN>

A mark that implements HasLegendDecorator allows to define a custom legend decorator.

HasMarkDecorator

common

interface HasMarkDecorator<DOMAIN>

A mark that implements HasMarkDecorator allows to define a DatumDecorator for each of its Datums.

HasSelectionDecorator

common

interface HasSelectionDecorator<DOMAIN>

A mark that implements HasMarkDecorator allows to define a DatumDecorator to select each of its Datums.

HasSize

common

interface HasSize<DOMAIN>

A visual element that can change size depending on the data.

HasStack

common

interface HasStack

A visual elements which signs can "stack"

HasStrokeColor

common

interface HasStrokeColor<DOMAIN>

A visual element which stroke color can change depending on the data.

HasStrokeLine

common

interface HasStrokeLine<DOMAIN>

A visual element that can change its line dash style depending on the data.

HasStrokeWidth

common

interface HasStrokeWidth<DOMAIN>

A visual element that can change its stroke thickness depending on the data.

HasSymbol

common

interface HasSymbol<DOMAIN>

A visual element which signs can change shapes (symbols) depending on the data.

LineMark

common

interface LineMark<DOMAIN, XVAL, YVAL> : HasMarkDecorator<DOMAIN> , HasHighlightDecorator<DOMAIN> , HasSelectionDecorator<DOMAIN> , HasLegendDecorator<DOMAIN> , HasCurve, HasSize<DOMAIN> , HasSymbol<DOMAIN> , HasStrokeColor<DOMAIN> , HasStrokeWidth<DOMAIN> , HasStrokeLine<DOMAIN> , MarkXY<DOMAIN, XVAL, YVAL>

Draw lines connecting each elements for a given Dataset and X and Y Dimensions.

Mark

common

interface Mark<DOMAIN>

A Mark is a way to represent a data as visual elements (signs).

MarkCurves

common

object MarkCurves

A collection of standard PathDrawers.

MarkX

common

interface MarkX<DOMAIN, VALUE>

A Mark that can display itself along a X Axis.

MarkXY

common

interface MarkXY<DOMAIN, XVAL, YVAL> : MarkX<DOMAIN, XVAL> , MarkY<DOMAIN, YVAL> , Mark<DOMAIN>

A Mark that can display itself along a X Axis and a Y Axis

MarkY

common

interface MarkY<DOMAIN, VALUE>

A Mark that can display itself along a Y Axis.

PathDrawer

common

fun fun interface PathDrawer

A PathDrawer transforms a given Path into a Curve.

PlotMark

common

interface PlotMark<DOMAIN, XVAL, YVAL> : HasSymbol<DOMAIN> , HasSize<DOMAIN> , HasStrokeColor<DOMAIN> , HasMarkDecorator<DOMAIN> , HasHighlightDecorator<DOMAIN> , HasSelectionDecorator<DOMAIN> , HasLegendDecorator<DOMAIN> , MarkXY<DOMAIN, XVAL, YVAL>

Draw signs (symbols) for each elements of a given Dataset and X and Y Dimensions.

Scaler

common

interface Scaler<VALUE>

A Scaler transforms a VALUE object into a Double, it is used to translates data into screen position.

Stacking

common

enum Stacking : Enum<Stacking>

Stacking behavior for bar charts or area charts.

TooltipPosition

common

data class TooltipPosition(zone: Zone, layout: LayoutPosition)

Holds a Tooltip layout information, the zone is the zone on which the tooltip is expected to "anchor", the layout is where the tooltip is expected to be placed from that zone.

Functions

area

common

fun <DOMAIN, XVAL> Chart<DOMAIN>.area(x: Discrete<DOMAIN, XVAL>, y: Quantitative<DOMAIN>, init: AreaMark<DOMAIN, XVAL, Double?>.() -> Unit = {})

Add an AreaMark to the current Chart.

fun <DOMAIN, YVAL> Chart<DOMAIN>.area(x: Quantitative<DOMAIN>, y: Discrete<DOMAIN, YVAL>, init: AreaMark<DOMAIN, Double?, YVAL>.() -> Unit = {})

Add an AreaMark to the current Chart.

areaMark

common

fun <DOMAIN, XVAL> areaMark(dataset: Dataset<DOMAIN>, x: Discrete<DOMAIN, XVAL>, y: Quantitative<DOMAIN>, init: AreaMark<DOMAIN, XVAL, Double?>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): AreaMark<DOMAIN, XVAL, Double?>

Instantiate a new AreaMark.

fun <DOMAIN, YVAL> areaMark(dataset: Dataset<DOMAIN>, x: Quantitative<DOMAIN>, y: Discrete<DOMAIN, YVAL>, init: AreaMark<DOMAIN, Double?, YVAL>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): AreaMark<DOMAIN, Double?, YVAL>

Instantiate a new AreaMark.

bar

common

fun <DOMAIN, XVAL> Chart<DOMAIN>.bar(x: Discrete<DOMAIN, XVAL>, y: Quantitative<DOMAIN>, init: BarMark<DOMAIN, XVAL, Double?>.() -> Unit = {})

Add a vertical BarMark to the current Chart.

fun <DOMAIN, YVAL> Chart<DOMAIN>.bar(x: Quantitative<DOMAIN>, y: Discrete<DOMAIN, YVAL>, init: BarMark<DOMAIN, Double?, YVAL>.() -> Unit = {})

Add a horizontal BarMark to the current Chart.

barMark

common

fun <DOMAIN, XVAL> barMark(dataset: Dataset<DOMAIN>, x: Discrete<DOMAIN, XVAL>, y: Quantitative<DOMAIN>, init: BarMark<DOMAIN, XVAL, Double?>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): BarMark<DOMAIN, XVAL, Double?>

Instantiate a new BarMark.

fun <DOMAIN, YVAL> barMark(dataset: Dataset<DOMAIN>, x: Quantitative<DOMAIN>, y: Discrete<DOMAIN, YVAL>, init: BarMark<DOMAIN, Double?, YVAL>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): BarMark<DOMAIN, Double?, YVAL>

Instantiate a new BarMark.

boxPlot

common

fun <DOMAIN, XVAL> Chart<DOMAIN>.boxPlot(x: Discrete<DOMAIN, XVAL>, y: Quantitative<DOMAIN>, init: BoxPlotMark<DOMAIN, XVAL, Double?>.() -> Unit = {})

Add a vertical BoxPlotMark to the current Chart.

fun <DOMAIN, YVAL> Chart<DOMAIN>.boxPlot(x: Quantitative<DOMAIN>, y: Discrete<DOMAIN, YVAL>, init: BoxPlotMark<DOMAIN, Double?, YVAL>.() -> Unit = {})

Add a horizontal BoxPlotMark to the current Chart.

empty

common

fun <DOMAIN, XVAL, YVAL> Chart<DOMAIN>.empty(x: Dimension<DOMAIN, XVAL>, y: Dimension<DOMAIN, YVAL>, init: EmptyMark<DOMAIN, XVAL, YVAL>.() -> Unit = {})

Add an EmptyMarkImpl to the current Chart.

line

common

fun <DOMAIN, XVAL, YVAL> Chart<DOMAIN>.line(x: Dimension<DOMAIN, XVAL>, y: Dimension<DOMAIN, YVAL>, init: LineMark<DOMAIN, XVAL, YVAL>.() -> Unit = {})

Add a LineMark to the current Chart.

lineMark

common

fun <DOMAIN, XVAL, YVAL> lineMark(dataset: Dataset<DOMAIN>, x: Dimension<DOMAIN, XVAL>, y: Dimension<DOMAIN, YVAL>, init: LineMark<DOMAIN, XVAL, YVAL>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): LineMark<DOMAIN, XVAL, YVAL>

Instantiate a new LineMark.

plot

common

fun <DOMAIN, XVAL, YVAL> Chart<DOMAIN>.plot(x: Dimension<DOMAIN, XVAL>, y: Dimension<DOMAIN, YVAL>, init: PlotMark<DOMAIN, XVAL, YVAL>.() -> Unit = {})

Add a PlotMarkImpl to the current Chart.

plotMark

common

fun <DOMAIN, XVAL, YVAL> plotMark(dataset: Dataset<DOMAIN>, x: Dimension<DOMAIN, XVAL>, y: Dimension<DOMAIN, YVAL>, init: PlotMark<DOMAIN, XVAL, YVAL>.() -> Unit, config: MarkConfig, xAxisConfig: AxisConfig, yAxisConfig: AxisConfig): PlotMark<DOMAIN, XVAL, YVAL>

Instantiate a new PlotMark.