Layout

Constructors

Constructor	Description
`new()` Signature: unit -> Layout

Instance members

Instance member	Description
`angularaxis()` Signature: unit -> AngularAxis	Links a dictionary describing the angular axis in a polar plot.
`angularaxis()` Signature: unit -> unit	Links a dictionary describing the angular axis in a polar plot.
`annotations()` Signature: unit -> Annotation []	Links an array that contains one or multiple annotation dictionaries.
`annotations()` Signature: unit -> unit	Links an array that contains one or multiple annotation dictionaries.
`autosize()` Signature: unit -> bool	Toggle whether or not the dimensions of the figure are automatically picked by Plotly. Plotly picks figure's dimensions as a function of your machine's display resolution. Once 'autosize' is set to FALSE, the figure's dimensions can be set with 'width' and 'height'.
`autosize()` Signature: unit -> unit	Toggle whether or not the dimensions of the figure are automatically picked by Plotly. Plotly picks figure's dimensions as a function of your machine's display resolution. Once 'autosize' is set to FALSE, the figure's dimensions can be set with 'width' and 'height'.
`bargap()` Signature: unit -> float	For bar and histogram plots only. Sets the gap between bars (or sets of bars) at different locations.
`bargap()` Signature: unit -> unit	For bar and histogram plots only. Sets the gap between bars (or sets of bars) at different locations.
`bargroupgap()` Signature: unit -> float	For bar and histogram plots only. Sets the gap between bars in the same group. That is, when multiple bar objects are plotted and share the same locations, this sets the distance between bars at each location.
`bargroupgap()` Signature: unit -> unit	For bar and histogram plots only. Sets the gap between bars in the same group. That is, when multiple bar objects are plotted and share the same locations, this sets the distance between bars at each location.
`barmode()` Signature: unit -> string	For bar and histogram plots only. This sets how multiple bar objects are plotted together. In other words, this defines how bars at the same location appear on the plot. If set to 'stack' the bars are stacked on top of one another. If set to 'group', the bars are plotted next to one another, centered around the shared location. If set to 'overlay', the bars are simply plotted over one another, you may need to set the opacity to see this.
`barmode()` Signature: unit -> unit	For bar and histogram plots only. This sets how multiple bar objects are plotted together. In other words, this defines how bars at the same location appear on the plot. If set to 'stack' the bars are stacked on top of one another. If set to 'group', the bars are plotted next to one another, centered around the shared location. If set to 'overlay', the bars are simply plotted over one another, you may need to set the opacity to see this.
`barnorm()` Signature: unit -> string	Sets the type of normalization for this bar trace. By default, 'barnorm' is set to '', which results in the height of each bar being displayed. If set to 'fraction', the value of each bar is divided by the sum of the values in the bar group. If set to 'percent', each bar's height is set to the fractional value * 100.
`barnorm()` Signature: unit -> unit	Sets the type of normalization for this bar trace. By default, 'barnorm' is set to '', which results in the height of each bar being displayed. If set to 'fraction', the value of each bar is divided by the sum of the values in the bar group. If set to 'percent', each bar's height is set to the fractional value * 100.
`boxgap()` Signature: unit -> float	For box plots only. Sets the gap between boxes at different locations (i.e. x-labels). If there are multiple boxes at a single x-label, then this sets the gap between these sets of boxes.For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width (or width of the set of boxes) occupies the remaining 75%.
`boxgap()` Signature: unit -> unit	For box plots only. Sets the gap between boxes at different locations (i.e. x-labels). If there are multiple boxes at a single x-label, then this sets the gap between these sets of boxes.For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width (or width of the set of boxes) occupies the remaining 75%.
`boxgroupgap()` Signature: unit -> float	For box plots only. Sets the gap between boxes in the same group, where a group is the set of boxes with the same location (i.e. x-label). For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width occupies the remaining 75%.
`boxgroupgap()` Signature: unit -> unit	For box plots only. Sets the gap between boxes in the same group, where a group is the set of boxes with the same location (i.e. x-label). For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width occupies the remaining 75%.
`boxmode()` Signature: unit -> string	For box plots only. Sets how groups of box plots appear. If set to 'overlay', a group of boxes will be plotted directly on top of one another at their specified location. If set to 'group', the boxes will be centered around their shared location, but they will not overlap.
`boxmode()` Signature: unit -> unit	For box plots only. Sets how groups of box plots appear. If set to 'overlay', a group of boxes will be plotted directly on top of one another at their specified location. If set to 'group', the boxes will be centered around their shared location, but they will not overlap.
`direction()` Signature: unit -> string	For polar plots only. Sets the direction corresponding to positive angles.
`direction()` Signature: unit -> unit	For polar plots only. Sets the direction corresponding to positive angles.
`dragmode()` Signature: unit -> string	Sets this figure's behavior when a user preforms a mouse 'drag' in the plot area. When set to 'zoom', a portion of the plot will be highlighted, when the viewer exits the drag, this highlighted section will be zoomed in on. When set to 'pan', data in the plot will move along with the viewers dragging motions. A user can always depress the 'shift' key to access the whatever functionality has not been set as the default. In 3D plots, the default drag mode is 'rotate' which rotates the scene.
`dragmode()` Signature: unit -> unit	Sets this figure's behavior when a user preforms a mouse 'drag' in the plot area. When set to 'zoom', a portion of the plot will be highlighted, when the viewer exits the drag, this highlighted section will be zoomed in on. When set to 'pan', data in the plot will move along with the viewers dragging motions. A user can always depress the 'shift' key to access the whatever functionality has not been set as the default. In 3D plots, the default drag mode is 'rotate' which rotates the scene.
`font()` Signature: unit -> Font	Links a dictionary describing the global font settings for this figure (e.g. all axis titles and labels).
`font()` Signature: unit -> unit	Links a dictionary describing the global font settings for this figure (e.g. all axis titles and labels).
`height()` Signature: unit -> float	Sets the height in pixels of the figure you are generating.
`height()` Signature: unit -> unit	Sets the height in pixels of the figure you are generating.
`hidesources()` Signature: unit -> string	Toggle whether or not an annotation citing the data source is placed at the bottom-right corner of the figure.This key has an effect only on graphs that have been generated from forked graphs from plot.ly.
`hidesources()` Signature: unit -> unit	Toggle whether or not an annotation citing the data source is placed at the bottom-right corner of the figure.This key has an effect only on graphs that have been generated from forked graphs from plot.ly.
`hovermode()` Signature: unit -> string	Sets this figure's behavior when a user hovers over it. When set to 'x', all data sharing the same 'x' coordinate will be shown on screen with corresponding trace labels. When set to 'y' all data sharing the same 'y' coordinates will be shown on the screen with corresponding trace labels. When set to 'closest', information about the data point closest to where the viewer is hovering will appear.
`hovermode()` Signature: unit -> unit	Sets this figure's behavior when a user hovers over it. When set to 'x', all data sharing the same 'x' coordinate will be shown on screen with corresponding trace labels. When set to 'y' all data sharing the same 'y' coordinates will be shown on the screen with corresponding trace labels. When set to 'closest', information about the data point closest to where the viewer is hovering will appear.
`legend()` Signature: unit -> Legend	Links a dictionary containing the legend parameters for this figure.
`legend()` Signature: unit -> unit	Links a dictionary containing the legend parameters for this figure.
`margin()` Signature: unit -> Margin	Links a dictionary containing the margin parameters for this figure.
`margin()` Signature: unit -> unit	Links a dictionary containing the margin parameters for this figure.
`orientation()` Signature: unit -> float	For polar plots only. Rotates the entire polar by the given angle.
`orientation()` Signature: unit -> unit	For polar plots only. Rotates the entire polar by the given angle.
`paper_bgcolor()` Signature: unit -> string	Sets the color of the figure's paper (i.e. area representing the canvas of the figure).
`paper_bgcolor()` Signature: unit -> unit	Sets the color of the figure's paper (i.e. area representing the canvas of the figure).
`plot_bgcolor()` Signature: unit -> string	Sets the background color of the plot (i.e. the area laying inside this figure's axes.
`plot_bgcolor()` Signature: unit -> unit	Sets the background color of the plot (i.e. the area laying inside this figure's axes.
`radialaxis()` Signature: unit -> RadialAxis	Links a dictionary describing the radial axis in a polar plot.
`radialaxis()` Signature: unit -> unit	Links a dictionary describing the radial axis in a polar plot.
`scene()` Signature: unit -> Scene	Links a dictionary describing a scene in a 3D plot. The first scene object can be entered into 'layout' by linking it to 'scene' OR 'scene1', both keys are identical to Plotly. Link subsequent scene objects using 'scene2', 'scene3', etc.
`scene()` Signature: unit -> unit	Links a dictionary describing a scene in a 3D plot. The first scene object can be entered into 'layout' by linking it to 'scene' OR 'scene1', both keys are identical to Plotly. Link subsequent scene objects using 'scene2', 'scene3', etc.
`separators()` Signature: unit -> string	Sets the decimal (the first character) and thousands (the second character) separators to be displayed on this figure's tick labels and hover mode. This is meant for internationalization purposes. For example, if 'separator' is set to ', ', then decimals are separated by commas and thousands by spaces. One may have to set 'exponentformat' to 'none' in the corresponding axis object(s) to see the effects.
`separators()` Signature: unit -> unit	Sets the decimal (the first character) and thousands (the second character) separators to be displayed on this figure's tick labels and hover mode. This is meant for internationalization purposes. For example, if 'separator' is set to ', ', then decimals are separated by commas and thousands by spaces. One may have to set 'exponentformat' to 'none' in the corresponding axis object(s) to see the effects.
`ShouldSerializeangularaxis()` Signature: unit -> bool
`ShouldSerializeannotations()` Signature: unit -> bool
`ShouldSerializeautosize()` Signature: unit -> bool
`ShouldSerializebargap()` Signature: unit -> bool
`ShouldSerializebargroupgap()` Signature: unit -> bool
`ShouldSerializebarmode()` Signature: unit -> bool
`ShouldSerializebarnorm()` Signature: unit -> bool
`ShouldSerializeboxgap()` Signature: unit -> bool
`ShouldSerializeboxgroupgap()` Signature: unit -> bool
`ShouldSerializeboxmode()` Signature: unit -> bool
`ShouldSerializedirection()` Signature: unit -> bool
`ShouldSerializedragmode()` Signature: unit -> bool
`ShouldSerializefont()` Signature: unit -> bool
`ShouldSerializeheight()` Signature: unit -> bool
`ShouldSerializehidesources()` Signature: unit -> bool
`ShouldSerializehovermode()` Signature: unit -> bool
`ShouldSerializelegend()` Signature: unit -> bool
`ShouldSerializemargin()` Signature: unit -> bool
`ShouldSerializeorientation()` Signature: unit -> bool
`ShouldSerializepaper_bgcolor()` Signature: unit -> bool
`ShouldSerializeplot_bgcolor()` Signature: unit -> bool
`ShouldSerializeradialaxis()` Signature: unit -> bool
`ShouldSerializescene()` Signature: unit -> bool
`ShouldSerializeseparators()` Signature: unit -> bool
`ShouldSerializeshowlegend()` Signature: unit -> bool
`ShouldSerializetitle()` Signature: unit -> bool
`ShouldSerializetitlefont()` Signature: unit -> bool
`ShouldSerializewidth()` Signature: unit -> bool
`ShouldSerializexaxis()` Signature: unit -> bool
`ShouldSerializexaxis2()` Signature: unit -> bool
`ShouldSerializeyaxis()` Signature: unit -> bool
`ShouldSerializeyaxis2()` Signature: unit -> bool
`showlegend()` Signature: unit -> bool	Toggle whether or not the legend will be shown in this figure.
`showlegend()` Signature: unit -> unit	Toggle whether or not the legend will be shown in this figure.
`title()` Signature: unit -> string	The title of the figure.
`title()` Signature: unit -> unit	The title of the figure.
`titlefont()` Signature: unit -> Font	Links a dictionary describing the font settings of the figure's title.
`titlefont()` Signature: unit -> unit	Links a dictionary describing the font settings of the figure's title.
`width()` Signature: unit -> float	Sets the width in pixels of the figure you are generating.
`width()` Signature: unit -> unit	Sets the width in pixels of the figure you are generating.
`xaxis()` Signature: unit -> XAxis	Links a dictionary describing an x-axis (i.e. an horizontal axis). The first xaxis object can be entered into 'layout' by linking it to 'xaxis' OR 'xaxis1', both keys are identical to Plotly. To create references other than x-axes, you need to define them in 'layout' using keys 'xaxis2', 'xaxis3' and so on. Note that in 3D plots, xaxis objects must be linked from a scene object.
`xaxis()` Signature: unit -> unit	Links a dictionary describing an x-axis (i.e. an horizontal axis). The first xaxis object can be entered into 'layout' by linking it to 'xaxis' OR 'xaxis1', both keys are identical to Plotly. To create references other than x-axes, you need to define them in 'layout' using keys 'xaxis2', 'xaxis3' and so on. Note that in 3D plots, xaxis objects must be linked from a scene object.
`xaxis2()` Signature: unit -> XAxis	Links a dictionary describing an x-axis (i.e. an horizontal axis). The first xaxis object can be entered into 'layout' by linking it to 'xaxis' OR 'xaxis1', both keys are identical to Plotly. To create references other than x-axes, you need to define them in 'layout' using keys 'xaxis2', 'xaxis3' and so on. Note that in 3D plots, xaxis objects must be linked from a scene object.
`xaxis2()` Signature: unit -> unit	Links a dictionary describing an x-axis (i.e. an horizontal axis). The first xaxis object can be entered into 'layout' by linking it to 'xaxis' OR 'xaxis1', both keys are identical to Plotly. To create references other than x-axes, you need to define them in 'layout' using keys 'xaxis2', 'xaxis3' and so on. Note that in 3D plots, xaxis objects must be linked from a scene object.
`yaxis()` Signature: unit -> YAxis	Links a dictionary describing an y-axis (i.e. an vertical axis). The first yaxis object can be entered into 'layout' by linking it to 'yaxis' OR 'yaxis1', both keys are identical to Plotly. To create references other than y-axes, you need to define them in 'layout' using keys 'yaxis2', 'yaxis3' and so on. Note that in 3D plots, yaxis objects must be linked from a scene object.
`yaxis()` Signature: unit -> unit	Links a dictionary describing an y-axis (i.e. an vertical axis). The first yaxis object can be entered into 'layout' by linking it to 'yaxis' OR 'yaxis1', both keys are identical to Plotly. To create references other than y-axes, you need to define them in 'layout' using keys 'yaxis2', 'yaxis3' and so on. Note that in 3D plots, yaxis objects must be linked from a scene object.
`yaxis2()` Signature: unit -> YAxis	Links a dictionary describing an y-axis (i.e. an vertical axis). The first yaxis object can be entered into 'layout' by linking it to 'yaxis' OR 'yaxis1', both keys are identical to Plotly. To create references other than y-axes, you need to define them in 'layout' using keys 'yaxis2', 'yaxis3' and so on. Note that in 3D plots, yaxis objects must be linked from a scene object.
`yaxis2()` Signature: unit -> unit	Links a dictionary describing an y-axis (i.e. an vertical axis). The first yaxis object can be entered into 'layout' by linking it to 'yaxis' OR 'yaxis1', both keys are identical to Plotly. To create references other than y-axes, you need to define them in 'layout' using keys 'yaxis2', 'yaxis3' and so on. Note that in 3D plots, yaxis objects must be linked from a scene object.

XPlot

Layout

Constructors

Instance members