Text

class Text : Scheme

Text annotation

Constructors

Text

common

fun Text()

Types

Companion

common

object Companion : SchemeSpec<Text>

Functions

font

common

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

getItem

common

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

onChange

common

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

position

common

fun position(x: Number, y: Number)

removeListener

common

open override fun removeListener(owner: Any?)

setItem

common

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

toMeta

common

open override fun toMeta(): Laminate

validateItem

common

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

Properties

align

common

var align: HorizontalAlign

Sets the horizontal alignment of the text within the box.

arrowcolor

common

val arrowcolor: Color

Sets the color of the annotation arrow.

common

var ax: Value?

Sets the x component of the arrow tail about the arrow head.

common

var ay: Value?

Sets the y component of the arrow tail about the arrow head.

bgcolor

common

val bgcolor: Color

Sets the background color of the annotation.

bordercolor

common

val bordercolor: Color

Sets the background color of the annotation.

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

font

common

var font: Font

Sets the annotation text font.

height

common

var height: Number

Sets an explicit height for the text box.

opacity

common

var opacity: Number

Sets the opacity of the annotation (text + arrow).

showarrow

common

var showarrow: Boolean?

Determines whether or not the annotation is drawn with an arrow.

standoff

common

var standoff: Number

Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.

text

common

var text: String?

Sets the text associated with this annotation.

textangle

common

var textangle: Number

Sets the angle at which the text is drawn with respect to the horizontal.

valign

common

var valign: VerticalAlign

Sets the vertical alignment of the text within the box.

visible

common

var visible: Boolean?

Determines whether or not this annotation is visible.

width

common

var width: Number

Sets an explicit width for the text box.

common

var x: Value?

Sets the annotation's x position.

xanchor

common

var xanchor: XAnchor

Sets the text box's horizontal position anchor This anchor binds the x position to the "left", "center" or "right" of the annotation.

xref

common

var xref: String?

Sets the annotation's x coordinate axis.

common

var y: Value?

Sets the annotation's y position.

yanchor

common

var yanchor: YAnchor

Sets the text box's vertical position anchor This anchor binds the y position to the "top", "middle" or "bottom" of the annotation.

yref

common

var yref: String?

Sets the annotation's y coordinate axis.