Chart

interface Chart<DOMAIN> : EventListener<DOMAIN> , ChartController<DOMAIN>

The Chart class is the main entry point when creating a chart, use the VizContainer.chart function to create one.

Functions

addMark

common

abstract fun addMark(markCreator: MarkCreator<DOMAIN>)

Add a Mark to the current chart.

config

common

abstract fun config(init: ChartConfig.() -> Unit)

Allow to override the default config or the config passed into the Chart.

highlight

common

@JvmName(name = "highlightDomains")

abstract fun highlight(domains: Collection<DOMAIN>)

Highlight the given DOMAIN objects.

@JvmName(name = "highlightData")

abstract fun highlight(data: Collection<Datum<DOMAIN>>)

Highlight the given Datums.

legend

common

abstract fun legend(init: Legend<DOMAIN>.() -> Unit)

The Legend initialization DSL.

onHighlight

common

abstract fun onHighlight(listener: (event: HighlightEvent<DOMAIN>) -> Unit)

Add a listener on a HighlightEvent.

onPan

common

abstract fun onPan(listener: (event: PanEvent) -> Unit)

Add a listener on a PanEvent.

onSelect

common

abstract fun onSelect(listener: (event: SelectEvent<DOMAIN>) -> Unit)

Add a listener on a SelectEvent.

onZoom

common

abstract fun onZoom(listener: (event: ZoomEvent) -> Unit)

Add a listener on a ZoomEvent.

pan

common

abstract fun pan(panX: Percent, panY: Percent)

Move the "viewport" of the Chart by a certain percentage in X or Y direction.

pushEvent

common

abstract fun pushEvent(event: ChartEvent)

Push a ChartEvent on the Chart.

select

common

@JvmName(name = "selectDomains")

abstract fun select(domains: Collection<DOMAIN>)

Select the given DOMAIN objects.

@JvmName(name = "selectData")

abstract fun select(data: Collection<Datum<DOMAIN>>)

Select the given Datums.

tooltip

common

abstract fun tooltip(init: Tooltip<DOMAIN>.() -> Unit)

The Tooltip initialization DSL.

viewReset

common

abstract fun viewReset()

Reset the view, setting the pan and zoom to their origin values.

zoom

common

abstract fun zoom(zoomOriginX: Percent, zoomOriginY: Percent, zoomFactorX: Percent, zoomFactorY: Percent)

Zoom the "viewport" of the Chart by a certain percentage in X or Y direction, knowing the zoom origin.

Properties

config

common

abstract val config: ChartConfig

The main configuration object ChartConfig, stores all configurations for the underlying marks, axes, ...

dataset

common

abstract val dataset: Dataset<DOMAIN>

The Chart, a data container giving access to all the original data and several useful properties.

series

common

abstract var series: Discrete<DOMAIN, *>

The series Discrete dimension is used to "split" your data into multiple series allowing to display them differently.

size

common

abstract var size: Size

The external size of the chart.

title

common

abstract var title: String?

Give a title to your Chart.

zoom

common

abstract val zoom: Zoom

The current Zoom for this Chart.

Extensions

area

common

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.

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.

bar

common

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.

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.

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.

constant

common

fun <DOMAIN, VALUE> Chart<DOMAIN>.constant(constantValue: VALUE, init: Constant<DOMAIN, VALUE>.() -> Unit = {}): Constant<DOMAIN, VALUE>

Create a Constant dimension for the Chart.

discrete

common

fun <DOMAIN, VALUE> Chart<DOMAIN>.discrete(accessor: Datum<DOMAIN>.() -> VALUE, init: Discrete<DOMAIN, VALUE>.() -> Unit = {}): Discrete<DOMAIN, VALUE>

Create a Discrete dimension for the 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.

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.

quantitative

common

fun <DOMAIN> Chart<DOMAIN>.quantitative(accessor: Datum<DOMAIN>.() -> Double?, init: Quantitative<DOMAIN>.() -> Unit = {}): Quantitative<DOMAIN>

Create a Quantitative dimension for the Chart.

temporal

common

fun <DOMAIN> Chart<DOMAIN>.temporal(accessor: Datum<DOMAIN>.() -> Instant, init: Temporal<DOMAIN>.() -> Unit = {}): Temporal<DOMAIN>

Create a Temporal dimension for the Chart.