core/io.data2viz.charts.config/AxisConfig

AxisConfig

interface AxisConfig : Font, Stroke, TickConfig

The configuration interface for an axis.

Functions

smartTickCount

common

abstract fun smartTickCount(rangeSize: Double): Int

Compute a "smart" tick count for the given scale.

Properties

alternateBackgroundColor

common

abstract var alternateBackgroundColor: Color

The color of the alternate background bands.

autoFit

common

abstract var autoFit: Boolean

When autofit is enabled, the start and end of the axis is rounded to "nice values".

axisLabelLayout

common

abstract var axisLabelLayout: AxisLabelLayout

Layout of the ticks labels over the axis line (below, over...).

bandwidthRatio

common

abstract var bandwidthRatio: Percent

The ratio of the drawable zone on a discrete axis.

discreteTickSkip

common

abstract var discreteTickSkip: TickSkip

Tick-sipping behavior for a discrete axis.

enableAlternateBackground

common

abstract var enableAlternateBackground: Boolean

Show hide alternate background (colored bands, drawn on ticks under the Marks).

enableAxis

common

abstract var enableAxis: Boolean

Show or hide the whole axis component.

enableAxisLine

common

abstract var enableAxisLine: Boolean

Show or hide the axis line.

enableBandwidth

common

abstract var enableBandwidth: Bandwidth

Enable bandwith.

enableGridLines

common

abstract var enableGridLines: Boolean

Show hide gridlines (lines drawn on ticks under the Marks).

enableTicks

common

abstract var enableTicks: Boolean

Show or hide the axis ticks.

enableTicksLabels

common

abstract var enableTicksLabels: Boolean

Show or hide the axis ticks labels.

enableTitle

common

abstract var enableTitle: Boolean

Show / hide axis title.

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.

gridLinesColor

common

abstract var gridLinesColor: Color

The color used to draw the grid lines.

gridLinesDashed

common

abstract var gridLinesDashed: DoubleArray?

The "dash style" of the grid lines, use null for a solid line.

gridLinesWidth

common

abstract var gridLinesWidth: Double

The thickness of the grid lines.

layoutPosition

common

abstract var layoutPosition: LayoutPosition

Expected position for the axis relative to the main charting zone.

orientation

common

abstract val orientation: Orientation

The Orientation of this axis 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.

tickCount

common

abstract var tickCount: Int?

The expected tick count for the Axis, null for activating "smart tick count".

tickPadding

common

abstract var tickPadding: Double

The padding between the tick and its label.

tickSize

common

abstract var tickSize: Double

The size (length) of a tick.

tickStroke

common

abstract var tickStroke: Color?

The ticks stroke Color, if null ticks won't draw.

tickStrokeWidth

common

abstract var tickStrokeWidth: Double?

The ticks stroke thickness, if null ticks won't draw.

Inheritors

Axis