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

Hoverlabel

class Hoverlabel : Scheme

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Hoverlabel>

Properties

Link copied to clipboard
var align: TraceValues

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines.

Link copied to clipboard
var bgcolor: Color

Sets the background color of the hover labels for this trace.

Link copied to clipboard
var bordercolor: Color

Sets the border color of the hover labels for this trace.

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

Sets the font used in hover labels.

Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard
var namelength: Number

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

Link copied to clipboard
var namelengths: List<Number>

Complementary property to namelength to allow passing a list of lengths.

Functions

Link copied to clipboard
fun align(vararg alignments: HorizontalAlign)
fun align(alignments: List<HorizontalAlign>)
fun align(align: HorizontalAlign)
Link copied to clipboard
fun bgcolors(array: Iterable<Any>)
Link copied to clipboard
fun bordercolors(array: Iterable<Any>)
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
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