Title

class Title : Scheme

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Title>

Properties

Link copied to clipboard
override var descriptor: MetaDescriptor?
Link copied to clipboard
var font: Font

Sets the title font.

Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard
var pad: Margin

Sets the padding of the title. Each padding value only applies when the corresponding xanchor/yanchor value is set accordingly. E.g. for left padding to take effect, xanchor must be set to "left". The same rule applies if xanchor/yanchor is determined automatically. Padding is muted if the respective anchor value is "middle"/"center".

Link copied to clipboard
var text: String?

Sets the plot's title.

Link copied to clipboard
var x: Number

Sets the x position with respect to xref in normalized coordinates from "0" (left) to "1" (right). Default: 0.5

Link copied to clipboard

Sets the title's horizontal alignment with respect to its x position. "left" means that the title starts at x, "right" means that the title ends at x and "center" means that the title's center is at x. "auto" divides xref by three and calculates the xanchor value automatically based on the value of x.

Link copied to clipboard
var xref: Ref

Sets the container x refers to. "container" spans the entire width of the plot. "paper" refers to the width of the plotting area only. Default: container.

Link copied to clipboard
var y: Number

Sets the y position with respect to yref in normalized coordinates from "0" (bottom) to "1" (top). "auto" places the baseline of the title onto the vertical center of the top margin. Default: auto.

Link copied to clipboard

Sets the title's vertical alignment with respect to its y position. "top" means that the title's cap line is at y, "bottom" means that the title's baseline is at y and "middle" means that the title's midline is at y. "auto" divides yref by three and calculates the yanchor value automatically based on the value of y.

Link copied to clipboard
var yref: Ref

Sets the container y refers to. "container" spans the entire height of the plot. "paper" refers to the height of the plotting area only. Default: container.

Functions

Link copied to clipboard
fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>
Link copied to clipboard
fun font(block: Font.() -> Unit)
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
fun pad(block: Margin.() -> Unit)
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 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