Layout

class Layout : Scheme

Types

Companion

common

object Companion : SchemeSpec<Layout>

Functions

annotation

common

fun annotation(anBuilder: Text.() -> Unit)

fun annotation(an: Text)

figure

common

fun figure(shBuilder: Shape.() -> Unit)

fun figure(sh: Shape)

getItem

common

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

legend

common

fun legend(block: Legend.() -> Unit)

margin

common

fun margin(block: Margin.() -> Unit)

onChange

common

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

removeListener

common

open override fun removeListener(owner: Any?)

setItem

common

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

title

common

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

toMeta

common

open override fun toMeta(): Laminate

validateItem

common

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

xaxis

common

fun xaxis(block: Axis.() -> Unit)

yaxis

common

fun yaxis(block: Axis.() -> Unit)

Properties

annotations

common

var annotations: List<Text>

An annotation is a text element that can be placed anywhere in the plot.

autosize

common

var autosize: Boolean?

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout.

bargap

common

var bargap: Number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

bargroupgap

common

var bargroupgap: Number

Sets the gap (in plot fraction) between bars of the same location coordinate.

barmode

common

var barmode: BarMode

Enumerated, one of ( "stack" | "group" | "overlay" | "relative" ) Determines how bars at the same location coordinate are displayed on the graph.

barnorm

common

var barnorm: BarNorm

Sets the normalization for bar traces on the graph.

boxgap

common

var boxgap: Number

Sets the gap (in plot fraction) between boxes of adjacent location coordinates.

boxgroupgap

common

var boxgroupgap: Number

Sets the gap (in plot fraction) between boxes of the same location coordinate.

boxmode

common

var boxmode: BoxMode

Determines how boxes at the same location coordinate are displayed on the graph.

calendar

common

var calendar: Calendar

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

dragmode

common

var dragmode: DragMode

Determines the mode of drag interactions.

height

common

var height: Number

Sets the plot's height (in px).

hoverdistance

common

var hoverdistance: Number

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data).

hovermode

common

var hovermode: HoverMode

Determines the mode of hover interactions.

legend

common

var legend: Legend

margin

common

var margin: Margin

paper_bgcolor

common

val paper_bgcolor: Color

Sets the background color of the paper where the graph is drawn.

plot_bgcolor

common

val plot_bgcolor: Color

Sets the background color of the plotting area in-between x and y axes.

separators

common

var separators: String?

Sets the decimal and thousand separators.

shapes

common

var shapes: List<Shape>

showlegend

common

var showlegend: Boolean?

Determines whether or not a legend is drawn.

title

common

var title: String?

Sets the plot's title.

violingap

common

var violingap: Number

Sets the gap (in plot fraction) between violins of adjacent location coordinates.

violingroupgap

common

var violingroupgap: Number

Sets the gap (in plot fraction) between violins of the same location coordinate.

violinmode

common

var violinmode: ViolinMode

Determines how violins at the same location coordinate are displayed on the graph.

width

common

var width: Number

Sets the plot's width (in px).

xaxis

common

var xaxis: Axis

yaxis

common

var yaxis: Axis