core/io.data2viz.charts.config/ChartConfig

ChartConfig

interface ChartConfig : Font, Stroke, ChartBasicConfig, Config<ChartConfig>

The ChartConfig is the central point of the configuration that holds a lot of configuration properties.

Some of them are defined as root configuration properties. Other are grouped into specific scoped configurations (cursor, events, mark, selection, tooltip, zoom, etc.)

Types

Companion

common

object Companion

This is a library of default configurations, you can create your own configuration or use one of these.

Functions

chart

common

abstract fun chart(init: ChartBasicConfig.() -> Unit)

The ChartBasicConfig initialization lambda, use it to customize your Chart.

cursor

common

abstract fun cursor(init: CursorConfig.() -> Unit)

The CursorConfigImpl initialization lambda, use it to customize your CursorImpl.

deepCopy

common

abstract fun deepCopy(): ChartConfig

Provide a deep copy of the configuration object.

events

common

abstract fun events(confEvents: EventConfig.() -> Unit)

The EventConfig initialization lambda, use it to customize your events behaviors.

legend

common

@ExperimentalCharts()

abstract fun legend(init: LegendConfig.() -> Unit)

The LegendConfig initialization lambda, use it to customize your Legend.

mark

common

abstract fun mark(init: MarkConfig.() -> Unit)

The MarkConfig initialization lambda, use it to customize your Marks.

selection

common

abstract fun selection(init: SelectionConfig.() -> Unit)

The SelectionConfig initialization lambda, use it to customize style your selection layer.

title

common

abstract fun title(init: TitleConfig.() -> Unit)

The TitleConfig initialization lambda, , use it to customize your Title.

tooltip

common

abstract fun tooltip(init: TooltipConfig.() -> Unit)

The TooltipConfig initialization lambda, , use it to customize your Tooltip.

xAxis

common

abstract fun xAxis(init: AxisConfig.() -> Unit)

The X-AxisConfig initialization lambda, use it to customize your X Axis.

yAxis

common

abstract fun yAxis(init: AxisConfig.() -> Unit)

The Y-AxisConfig initialization lambda, use it to customize your Y Axis.

zoom

common

abstract fun zoom(init: ZoomConfig.() -> Unit)

The ZoomConfig initialization lambda, use it to customize your Zoom.

Properties

backgroundColor

common

abstract var backgroundColor: Color

The background color for the Chart, this color must have a alpha channel value of 100%.

cursor

common

abstract val cursor: CursorConfig

The cursor configuration

events

common

abstract val events: EventConfig

The events configuration

fontColor

common

abstract var fontColor: Color

The font Color.

fontFamily

common

abstract var fontFamily: FontFamily

The font family (FontFamily).

fontSize

common

abstract var fontSize: Double

The font size.

fontStyle

common

abstract var fontStyle: FontPosture

The font posture (FontPosture): italic or normal.

fontWeight

common

abstract var fontWeight: FontWeight

The font weight (FontWeight): bold or normal.

legend

common

abstract val legend: LegendConfig

The legend configuration

mark

common

abstract val mark: MarkConfig

The global mark configuration

numberLocale

common

abstract var numberLocale: Locale

The number formatting locale

padding

common

abstract var padding: Padding

The Padding for the Chart.

performanceMode

common

abstract var performanceMode: Boolean

Enable "performance mode": better Chart reactivity even with a lot of data but requires more graphic memory.

selection

common

abstract val selection: SelectionConfig

The selection configuration

strokeColor

common

abstract var strokeColor: Color?

The stroke Color, use null for no stroke.

strokeWidth

common

abstract var strokeWidth: Double?

The stroke thickness, null for no stroke.

timeLocale

common

abstract var timeLocale: Locale

The date formatting locale

title

common

abstract val title: TitleConfig

The title configuration

tooltip

common

abstract val tooltip: TooltipConfig

The tooltip configuration

common

abstract val x: AxisConfig

The x axis configuration

common

abstract val y: AxisConfig

The y axis configuration

zoom

common

abstract val zoom: ZoomConfig

The zoom configuration