plotlykt-core/space.kscience.plotly.models/ColorBar

ColorBar

class ColorBar : Scheme

Constructors

constructor()

Types

object Companion : SchemeSpec<ColorBar>

Properties

val bgcolor: Color

Sets the color of padded area. Default: rgba(0, 0, 0, 0).

val bordercolor: Color

Sets the axis line color. Default: #444.

var borderwidth: Number

Sets the width (in px) or the border enclosing this color bar. Default: 0.

var constraintext: ConstrainText

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

override var descriptor: MetaDescriptor?

var len: Number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends. Default: 1.

var lenmode: MeasureMode

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" (default) or in "pixels. Use len to set the value.

override val meta: ObservableMutableMeta

val outlinecolor: Color

Sets the axis line color. Default: #444.

var outlinewidth: Number

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

var thickness: Number

Sets the thickness of the color bar. This measure excludes the size of the padding, ticks and labels. Default: 30.

var thicknessmode: MeasureMode

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels" (default). Use thickness to set the value.

var tickfont: Font

Sets the color bar's tick label font

var title: Title

Sets the x position of the color bar (in plot fraction). Default: 1.02.

var xanchor: XAnchor

Sets this color bar's horizontal position anchor. This anchor binds the x position to the "left" (default), "center" or "right" of the color bar.

var xpad: Number

Sets the amount of padding (in px) along the x direction. Default: 10.

Sets the y position of the color bar (in plot fraction). Default: 0.5.

var yanchor: YAnchor

Sets this color bar's vertical position anchor. This anchor binds the y position to the "top", "middle" (default) or "bottom" of the color bar.

Sets the amount of padding (in px) along the y direction. Default: 10.

Functions

fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>

open operator override fun get(name: Name): MutableMeta?

open override fun getValue(name: Name): Value?

numberGreaterThan

fun Scheme.numberGreaterThan(minValue: Number, default: Number = minValue, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number ray

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

A safe Number range

open operator override fun set(name: Name, node: Meta?)

open override fun setValue(name: Name, value: Value?)

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

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

fun Scheme.toJsonString(): String

Convert any type-safe configurator to json string

open override fun toMeta(): Laminate

open override fun toString(): String

open fun validate(name: Name, meta: Meta?): Boolean