Axis

class Axis : Scheme

Axis scheme

Constructors

Axis

common

fun Axis()

Types

Companion

common

object Companion : SchemeSpec<Axis>

Functions

getItem

common

open override fun getItem(name: Name): MetaItem?

onChange

common

open override fun onChange(owner: Any?, action: (Name, MetaItem?, MetaItem?) -> Unit)

range

common

fun range(value: ClosedFloatingPointRange<Double>)

Set range using double kotlin range

fun range(value: ClosedRange<String>)

Set range using kotlin string range

fun range(from: Value, to: Value)

Set the range using arbitrary values

removeListener

common

open override fun removeListener(owner: Any?)

setItem

common

open override fun setItem(name: Name, item: MetaItem?)

tickfont

common

fun tickfont(block: Font.() -> Unit)

ticktext

common

fun ticktext(array: Iterable<Any>)

tickvals

common

fun tickvals(array: Iterable<Any>)

title

common

fun title(block: Title.() -> Unit)

toMeta

common

open override fun toMeta(): Laminate

validateItem

common

open fun validateItem(name: Name, item: MetaItem?): Boolean

Properties

anchor

common

var anchor: String?

Enumerated, one of ( "free" | "/^x(2-9|0-9+)?

automargin

common

var automargin: Boolean?

Determines whether long tick labels automatically grow the figure margins.

autorange

common

var autorange: Boolean

Determines whether or not the range of this axis is computed in relation to the input data.

autotick

common

var autotick: Boolean?

color

common

val color: Color

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

dtick

common

var dtick: Value?

Sets the step in-between ticks on this axis.

gridcolor

common

val gridcolor: Color

Sets the color of the grid lines.

gridwidth

common

var gridwidth: Number

Sets the width (in px) of the grid lines.

linecolor

common

val linecolor: Color

Sets the axis line color.

linewidth

common

var linewidth: Number

Sets the width (in px) of the axis line.

position

common

var position: Number

Sets the position of this axis in the plotting space (in normalized coordinates).

range

common

var range: ClosedFloatingPointRange<Double>?

Sets the range of this axis.

showgrid

common

var showgrid: Boolean?

Determines whether or not grid lines are drawn.

showline

common

var showline: Boolean?

Determines whether or not a line bounding this axis is drawn.

showticklabels

common

var showticklabels: Boolean?

Determines whether or not the tick labels are drawn.

tickangle

common

var tickangle: Number

Sets the angle of the tick labels with respect to the horizontal.

tickcolor

common

val tickcolor: Color

Sets the tick color.

tickfont

common

var tickfont: Font

Sets the tick font.

ticklen

common

var ticklen: Number

Sets the tick length (in px).

tickmode

common

var tickmode: TickMode

Sets the tick mode for this axis.

ticks

common

var ticks: Ticks

Determines whether ticks are drawn or not.

ticktext

common

var ticktext: List<Value>

Sets the text displayed at the ticks position via tickvals.

tickvals

common

var tickvals: List<Value>

Sets the values at which ticks on this axis appear.

tickwidth

common

var tickwidth: Number

Sets the tick width (in px).

title

common

var title: String?

Sets the title of this axis.

type

common

var type: AxisType

visible

common

var visible: Boolean?

A single toggle to hide the axis while preserving interaction like dragging.

zeroline

common

var zeroline: Boolean?

Determines whether or not a line is drawn at along the 0 value of this axis.

zerolinecolor

common

val zerolinecolor: Color

Sets the line color of the zero line.

zerolinewidth

common

var zerolinewidth: Number

Sets the width (in px) of the zero line.