Axis

class Axis : Scheme

Axis scheme

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Axis>

Properties

Link copied to clipboard

Enumerated, one of ( "free" | "/^x(2-9|0-9+)?$/" | "/^y(2-9|0-9+)?$/" ) If set to an opposite-letter axis id (e.g. x2, y), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by position.

Link copied to clipboard

Determines whether long tick labels automatically grow the figure margins.

Link copied to clipboard

Determines whether or not the range of this axis is computed in relation to the input data. See rangemode for more info. If range is provided, then autorange is set to "false". Default: true.

Link copied to clipboard
Link copied to clipboard

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. Default: #444.

Link copied to clipboard
override var descriptor: MetaDescriptor?
Link copied to clipboard
var dtick: Value?

Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to "log" and "date" axes. If the axis type is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L", where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). tick0 is ignored for "D1" and "D2". If the axis type is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to "2000-01-15" and dtick to "M3". To set ticks every 4 years, set dtick to "M48"

Link copied to clipboard

Sets the color of the grid lines. Default: #eee

Link copied to clipboard

Sets the width (in px) of the grid lines. Default: 1.

Link copied to clipboard

Sets the axis line color. Default: #444.

Link copied to clipboard

Sets the width (in px) of the axis line. Default: 1.

Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

Link copied to clipboard

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to "free". Default: 0.

Link copied to clipboard

Sets the range of this axis. If the axis type is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

Link copied to clipboard

Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.

Link copied to clipboard

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

Link copied to clipboard

Determines whether or not the tick labels are drawn.

Link copied to clipboard

Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.

Link copied to clipboard

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

Link copied to clipboard

Sets the tick color. Default: #444.

Link copied to clipboard

Sets the tick font.

Link copied to clipboard

Sets the tick length (in px). Default: 5.

Link copied to clipboard

Sets the tick mode for this axis. If "auto", the number of ticks is set via nticks. If "linear", the placement of the ticks is determined by a starting position tick0 and a tick step dtick ("linear" is the default value if tick0 and dtick are provided). If "array", the placement of the ticks is set via tickvals and the tick text is ticktext. ("array" is the default value if tickvals is provided).

Link copied to clipboard

Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

Link copied to clipboard
var ticktext: List<Value>

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.

Link copied to clipboard
var tickvals: List<Value>

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.

Link copied to clipboard

Sets the tick width (in px). Default: 1.

Link copied to clipboard

Sets the title of this axis.

Link copied to clipboard

Enumerated, one of ( "-" | "linear" | "log" | "date" | "category" | "multicategory" ) . Sets the axis type. By default, plotly attempts to determine the axis type by looking into the data of the traces that referenced the axis in question. Default: "-"

Link copied to clipboard

A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

Link copied to clipboard

Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.

Link copied to clipboard

Sets the line color of the zero line. Default: #444

Link copied to clipboard

Sets the width (in px) of the zero line. Default: 1.

Functions

Link copied to clipboard
fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>
Link copied to clipboard
open operator override fun get(name: Name): MutableMeta?
Link copied to clipboard
open override fun getValue(name: Name): Value?
Link copied to clipboard
fun Scheme.numberGreaterThan(minValue: Number, default: Number = minValue, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number ray

Link copied to clipboard
fun Scheme.numberInRange(range: ClosedRange<Double>, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number range

Link copied to clipboard

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

Link copied to clipboard
open operator override fun set(name: Name, node: Meta?)
Link copied to clipboard
open override fun setValue(name: Name, value: Value?)
Link copied to clipboard
fun tickfont(block: Font.() -> Unit)
Link copied to clipboard
fun ticktext(array: Iterable<Any>)
Link copied to clipboard
fun tickvals(array: Iterable<Any>)
Link copied to clipboard
fun title(block: Title.() -> Unit)
Link copied to clipboard
fun Scheme.toJsonString(): String

Convert any type-safe configurator to json string

Link copied to clipboard
open override fun toMeta(): Laminate
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun validate(name: Name, meta: Meta?): Boolean