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

Layout

class Layout : Scheme

Constructors

Layout

constructor()

Types

Companion

object Companion : SchemeSpec<Layout>

Properties

annotations

var annotations: List<Text>

An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow.

autosize

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. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

bargap

var bargap: Number

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

bargroupgap

var bargroupgap: Number

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

barmode

var barmode: BarMode

Enumerated, one of ( "stack" | "group" | "overlay" | "relative" ) Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars. Default: "group".

barnorm

var barnorm: BarNorm

Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages. Default: "".

boxgap

var boxgap: Number

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set. Default: 0.3

boxgroupgap

var boxgroupgap: Number

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set. Default: 0.3

boxmode

var boxmode: BoxMode

Determines how boxes at the same location coordinate are displayed on the graph. If "group", the boxes are plotted next to one another centered around the shared location. If "overlay", the boxes are plotted over one another, you might need to set "opacity" to see them multiple boxes. Has no effect on traces that have "width" set.

calendar

var calendar: Calendar

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

descriptor

override var descriptor: MetaDescriptor?

dragmode

var dragmode: DragMode

Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes.

height

var height: Number

Sets the plot's height (in px). Number greater than or equal to 10, default: 450.

hoverdistance

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). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict. Default: 20.

hovermode

var hovermode: HoverMode

Determines the mode of hover interactions. If "closest", a single hoverlabel will appear for the "closest" point within the hoverdistance. If "x" (or "y"), multiple hoverlabels will appear for multiple points at the "closest" x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If "x unified" (or "y unified"), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled. If clickmode includes the "select" flag, hovermode defaults to "closest". If clickmode lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's orientation value) for plots based on cartesian coordinates. For anything else the default value is "closest".