Header menu logo Plotly.NET

Layout Type

A Layout object in the context of plotly charts contains all styling options that are not directly related to the visualization of the data itself, such as axes, legends, watermarks, etc.

Constructors

Constructor Description

Layout()

Full Usage: Layout()

Returns: Layout
Returns: Layout

Static members

Static member Description

Layout.combine first second

Full Usage: Layout.combine first second

Parameters:
    first : Layout - The first Layout to combine with the second
    second : Layout - The second Layout to combine with the first

Returns: Layout

Combines two Layout objects. In case of duplicate dynamic member values, the values of the second Layout are used. For the collections used for the dynamic members annotations, shapes, selections, images, sliders, hiddenlabels, updatemenus the values from the second Layout are appended to those of the first instead.

first : Layout

The first Layout to combine with the second

second : Layout

The second Layout to combine with the first

Returns: Layout

Layout.getColorAxes layout

Full Usage: Layout.getColorAxes layout

Parameters:
    layout : Layout - The layout to get the color axes from

Returns: (string * ColorAxis) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid color axes (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the color axes from

Returns: (string * ColorAxis) seq

Layout.getColorAxisById id

Full Usage: Layout.getColorAxisById id

Parameters:
Returns: Layout -> ColorAxis

Returns the ColorAxis object of the layout with the given id. If there is no color axis set, returns an empty ColorAxis object.

id : SubPlotId

The target color axis id

Returns: Layout -> ColorAxis

Layout.getGeoById id

Full Usage: Layout.getGeoById id

Parameters:
Returns: Layout -> Geo

Returns the Geo object of the layout with the given id. If there is no geo set, returns an empty Geo object.

id : SubPlotId

The target geo id

Returns: Layout -> Geo

Layout.getGeos layout

Full Usage: Layout.getGeos layout

Parameters:
    layout : Layout - The layout to get the geos from

Returns: (string * Geo) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid geo subplots (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the geos from

Returns: (string * Geo) seq

Layout.getLayoutGrid layout

Full Usage: Layout.getLayoutGrid layout

Parameters:
    layout : Layout - The layout to get the grid from

Returns: LayoutGrid

Returns the LayoutGrid object of the given layout. If there is no grid set, returns an empty LayoutGrid object.

layout : Layout

The layout to get the grid from

Returns: LayoutGrid

Layout.getLegendById id

Full Usage: Layout.getLegendById id

Parameters:
Returns: Layout -> Legend

Returns the Legend object of the layout with the given id. If there is no Legend set, returns an empty Legend object.

id : SubPlotId

The target Legend id

Returns: Layout -> Legend

Layout.getLegends layout

Full Usage: Layout.getLegends layout

Parameters:
    layout : Layout - The layout to get the color axes from

Returns: (string * Legend) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid legends (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the color axes from

Returns: (string * Legend) seq

Layout.getLinearAxisById id

Full Usage: Layout.getLinearAxisById id

Parameters:
Returns: Layout -> LinearAxis

Returns the linear axis object of the layout with the given id. If there is no linear axis set, returns an empty LinearAxis object.

id : SubPlotId

The target axis id

Returns: Layout -> LinearAxis

Layout.getMapboxById id

Full Usage: Layout.getMapboxById id

Parameters:
Returns: Layout -> Mapbox

Returns the Mapbox object of the layout with the given id. If there is no mapbox set, returns an empty Mapbox object.

id : SubPlotId

The target mapbox id

Returns: Layout -> Mapbox

Layout.getMapboxes layout

Full Usage: Layout.getMapboxes layout

Parameters:
    layout : Layout - The layout to get the mapboxes from

Returns: (string * Mapbox) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid mapbox subplots (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the mapboxes from

Returns: (string * Mapbox) seq

Layout.getPolarById id

Full Usage: Layout.getPolarById id

Parameters:
Returns: Layout -> Polar

Returns the Polar object of the layout with the given id. If there is no polar set, returns an empty Polar object.

id : SubPlotId

The target polar id

Returns: Layout -> Polar

Layout.getPolars layout

Full Usage: Layout.getPolars layout

Parameters:
    layout : Layout - The layout to get the polars from

Returns: (string * Polar) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid polar subplots (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the polars from

Returns: (string * Polar) seq

Layout.getSceneById id

Full Usage: Layout.getSceneById id

Parameters:
Returns: Layout -> Scene

Returns the Scene object of the layout with the given id. If there is no scene set, returns an empty Scene object.

id : SubPlotId

The target scene id

Returns: Layout -> Scene

Layout.getScenes layout

Full Usage: Layout.getScenes layout

Parameters:
    layout : Layout - The layout to get the scenes from

Returns: (string * Scene) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid scenes (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the scenes from

Returns: (string * Scene) seq

Layout.getSmithById id

Full Usage: Layout.getSmithById id

Parameters:
Returns: Layout -> Smith

Returns the Smith object of the layout with the given id. If there is no smith set, returns an empty Smith object.

id : SubPlotId

The target smith id

Returns: Layout -> Smith

Layout.getSmiths layout

Full Usage: Layout.getSmiths layout

Parameters:
    layout : Layout - The layout to get the smiths from

Returns: (string * Smith) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid smith subplots (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the smiths from

Returns: (string * Smith) seq

Layout.getTernaries layout

Full Usage: Layout.getTernaries layout

Parameters:
    layout : Layout - The layout to get the ternaries from

Returns: (string * Ternary) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid ternary subplots (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the ternaries from

Returns: (string * Ternary) seq

Layout.getTernaryById id

Full Usage: Layout.getTernaryById id

Parameters:
Returns: Layout -> Ternary

Returns the Ternary object of the layout with the given id. If there is no ternary set, returns an empty Ternary object.

id : SubPlotId

The target ternary id

Returns: Layout -> Ternary

Layout.getXAxes layout

Full Usage: Layout.getXAxes layout

Parameters:
    layout : Layout - The layout to get the x axes from

Returns: (string * LinearAxis) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid x axes (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the x axes from

Returns: (string * LinearAxis) seq

Layout.getYAxes layout

Full Usage: Layout.getYAxes layout

Parameters:
    layout : Layout - The layout to get the y axes from

Returns: (string * LinearAxis) seq

Returns a sequence of key-value pairs of the layout's dynamic members that are valid y axes (if the key matches and object can be cast to the correct type).

layout : Layout

The layout to get the y axes from

Returns: (string * LinearAxis) seq

Layout.init (?Title, ?ShowLegend, ?Margin, ?AutoSize, ?Width, ?Height, ?Font, ?UniformText, ?Separators, ?PaperBGColor, ?PlotBGColor, ?AutoTypeNumbers, ?Colorscale, ?Colorway, ?ModeBar, ?HoverMode, ?ClickMode, ?DragMode, ?SelectDirection, ?ActiveSelection, ?NewSelection, ?HoverDistance, ?SpikeDistance, ?Hoverlabel, ?Transition, ?DataRevision, ?UIRevision, ?EditRevision, ?SelectRevision, ?Template, ?Meta, ?Computed, ?Grid, ?Calendar, ?MinReducedHeight, ?MinReducedWidth, ?NewShape, ?ActiveShape, ?HideSources, ?ScatterGap, ?ScatterMode, ?BarGap, ?BarGroupGap, ?BarMode, ?BarNorm, ?ExtendPieColors, ?HiddenLabels, ?PieColorWay, ?BoxGap, ?BoxGroupGap, ?BoxMode, ?ViolinGap, ?ViolinGroupGap, ?ViolinMode, ?WaterfallGap, ?WaterfallGroupGap, ?WaterfallMode, ?FunnelGap, ?FunnelGroupGap, ?FunnelMode, ?ExtendFunnelAreaColors, ?FunnelAreaColorWay, ?ExtendSunBurstColors, ?SunBurstColorWay, ?ExtendTreeMapColors, ?TreeMapColorWay, ?ExtendIcicleColors, ?IcicleColorWay, ?Annotations, ?Shapes, ?Selections, ?Images, ?Sliders, ?UpdateMenus)

Full Usage: Layout.init (?Title, ?ShowLegend, ?Margin, ?AutoSize, ?Width, ?Height, ?Font, ?UniformText, ?Separators, ?PaperBGColor, ?PlotBGColor, ?AutoTypeNumbers, ?Colorscale, ?Colorway, ?ModeBar, ?HoverMode, ?ClickMode, ?DragMode, ?SelectDirection, ?ActiveSelection, ?NewSelection, ?HoverDistance, ?SpikeDistance, ?Hoverlabel, ?Transition, ?DataRevision, ?UIRevision, ?EditRevision, ?SelectRevision, ?Template, ?Meta, ?Computed, ?Grid, ?Calendar, ?MinReducedHeight, ?MinReducedWidth, ?NewShape, ?ActiveShape, ?HideSources, ?ScatterGap, ?ScatterMode, ?BarGap, ?BarGroupGap, ?BarMode, ?BarNorm, ?ExtendPieColors, ?HiddenLabels, ?PieColorWay, ?BoxGap, ?BoxGroupGap, ?BoxMode, ?ViolinGap, ?ViolinGroupGap, ?ViolinMode, ?WaterfallGap, ?WaterfallGroupGap, ?WaterfallMode, ?FunnelGap, ?FunnelGroupGap, ?FunnelMode, ?ExtendFunnelAreaColors, ?FunnelAreaColorWay, ?ExtendSunBurstColors, ?SunBurstColorWay, ?ExtendTreeMapColors, ?TreeMapColorWay, ?ExtendIcicleColors, ?IcicleColorWay, ?Annotations, ?Shapes, ?Selections, ?Images, ?Sliders, ?UpdateMenus)

Parameters:
    ?Title : Title - Sets the title of the layout.
    ?ShowLegend : bool - Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.
    ?Margin : Margin - Sets the margins around the layout.
    ?AutoSize : bool - 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.
    ?Width : int - Sets the plot's width (in px).
    ?Height : int - Sets the plot's height (in px).
    ?Font : Font - Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
    ?UniformText : UniformText - Determines how the font size for various text elements are uniformed between each trace type.
    ?Separators : string - Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.
    ?PaperBGColor : Color - Sets the background color of the paper where the graph is drawn.
    ?PlotBGColor : Color - Sets the background color of the plotting area in-between x and y axes.
    ?AutoTypeNumbers : AutoTypeNumbers - Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.
    ?Colorscale : DefaultColorScales - Sets the default colorscales that are used by plots using autocolorscale.
    ?Colorway : Color - Sets the default trace colors.
    ?ModeBar : ModeBar - Sets the modebar of the layout.
    ?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.
    ?ClickMode : ClickMode - Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.
    ?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.
    ?SelectDirection : SelectDirection - When `dragmode` is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.
    ?ActiveSelection : ActiveSelection - Sets the styling of the active selection
    ?NewSelection : NewSelection - Controls the behavior of newly drawn selections
    ?HoverDistance : int - 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.
    ?SpikeDistance : int - Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.
    ?Hoverlabel : Hoverlabel - Sets the style ov hover labels.
    ?Transition : Transition - Sets transition options used during Plotly.react updates.
    ?DataRevision : string - If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.
    ?UIRevision : string - Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.
    ?EditRevision : string - Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
    ?SelectRevision : string - Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
    ?Template : DynamicObj - Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.
    ?Meta : string - Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.
    ?Computed : string - Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-json" mode.
    ?Grid : LayoutGrid - Sets the layout grid for arranging multiple plots
    ?Calendar : Calendar - Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
    ?MinReducedHeight : int - Minimum height of the plot with margin.automargin applied (in px)
    ?MinReducedWidth : int - Minimum width of the plot with margin.automargin applied (in px)
    ?NewShape : NewShape - Controls the behavior of newly drawn shapes
    ?ActiveShape : ActiveShape - Sets the styling of the active shape
    ?HideSources : bool - Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).
    ?ScatterGap : float - Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.
    ?ScatterMode : ScatterMode - Determines how scatter points at the same location coordinate are displayed on the graph. With "group", the scatter points are plotted next to one another centered around the shared location. With "overlay", the scatter points are plotted over one another, you might need to reduce "opacity" to see multiple scatter points.
    ?BarGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?BarGroupGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?BarMode : BarMode - 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.
    ?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.
    ?ExtendPieColors : bool - If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?HiddenLabels : 'a seq - If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?PieColorWay : Color - Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.
    ?BoxGap : float - Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set.
    ?BoxGroupGap : float - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?BoxMode : BoxMode - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinGap : float - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinGroupGap : float - Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinMode : ViolinMode - Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set.
    ?WaterfallGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?WaterfallGroupGap : float - Sets the gap (in plot fraction) between bars of the same location coordinate.
    ?WaterfallMode : WaterfallMode - Determines how bars at the same location coordinate are displayed on the graph. 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.
    ?FunnelGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?FunnelGroupGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?FunnelMode : FunnelMode - 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 "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.
    ?ExtendFunnelAreaColors : bool - If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?FunnelAreaColorWay : Color - Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.
    ?ExtendSunBurstColors : bool - If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?SunBurstColorWay : Color - If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?ExtendTreeMapColors : bool - If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?TreeMapColorWay : Color - Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`.
    ?ExtendIcicleColors : bool - If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?IcicleColorWay : Color - Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.
    ?Annotations : Annotation seq - A collection containing all Annotations of this layout. 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.
    ?Shapes : Shape seq - A collection containing all Shapes of this layout.
    ?Selections : Selection seq - A collection containing all Selections of this layout.
    ?Images : LayoutImage seq - A collection containing all Images of this layout.
    ?Sliders : Slider seq - A collection containing all Sliders of this layout.
    ?UpdateMenus : UpdateMenu seq - A collection containing all UpdateMenus of this layout.

Returns: Layout

Returns a new Layout object with the given styling.

?Title : Title

Sets the title of the layout.

?ShowLegend : bool

Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.

?Margin : Margin

Sets the margins around the layout.

?AutoSize : bool

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.

?Width : int

Sets the plot's width (in px).

?Height : int

Sets the plot's height (in px).

?Font : Font

Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

?UniformText : UniformText

Determines how the font size for various text elements are uniformed between each trace type.

?Separators : string

Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.

?PaperBGColor : Color

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

?PlotBGColor : Color

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

?AutoTypeNumbers : AutoTypeNumbers

Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.

?Colorscale : DefaultColorScales

Sets the default colorscales that are used by plots using autocolorscale.

?Colorway : Color

Sets the default trace colors.

?ModeBar : ModeBar

Sets the modebar of the layout.

?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.

?ClickMode : ClickMode

Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.

?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.

?SelectDirection : SelectDirection

When `dragmode` is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.

?ActiveSelection : ActiveSelection

Sets the styling of the active selection

?NewSelection : NewSelection

Controls the behavior of newly drawn selections

?HoverDistance : int

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.

?SpikeDistance : int

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

?Hoverlabel : Hoverlabel

Sets the style ov hover labels.

?Transition : Transition

Sets transition options used during Plotly.react updates.

?DataRevision : string

If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

?UIRevision : string

Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.

?EditRevision : string

Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

?SelectRevision : string

Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

?Template : DynamicObj

Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.

?Meta : string

Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.

?Computed : string

Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-json" mode.

?Grid : LayoutGrid

Sets the layout grid for arranging multiple plots

?Calendar : Calendar

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

?MinReducedHeight : int

Minimum height of the plot with margin.automargin applied (in px)

?MinReducedWidth : int

Minimum width of the plot with margin.automargin applied (in px)

?NewShape : NewShape

Controls the behavior of newly drawn shapes

?ActiveShape : ActiveShape

Sets the styling of the active shape

?HideSources : bool

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

?ScatterGap : float

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.

?ScatterMode : ScatterMode

Determines how scatter points at the same location coordinate are displayed on the graph. With "group", the scatter points are plotted next to one another centered around the shared location. With "overlay", the scatter points are plotted over one another, you might need to reduce "opacity" to see multiple scatter points.

?BarGap : float

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

?BarGroupGap : float

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

?BarMode : BarMode

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.

?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.

?ExtendPieColors : bool

If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?HiddenLabels : 'a seq

If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?PieColorWay : Color

Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.

?BoxGap : float

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

?BoxGroupGap : float

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

?BoxMode : BoxMode

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

?ViolinGap : float

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

?ViolinGroupGap : float

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

?ViolinMode : ViolinMode

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

?WaterfallGap : float

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

?WaterfallGroupGap : float

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

?WaterfallMode : WaterfallMode

Determines how bars at the same location coordinate are displayed on the graph. 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.

?FunnelGap : float

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

?FunnelGroupGap : float

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

?FunnelMode : FunnelMode

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 "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.

?ExtendFunnelAreaColors : bool

If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?FunnelAreaColorWay : Color

Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.

?ExtendSunBurstColors : bool

If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?SunBurstColorWay : Color

If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?ExtendTreeMapColors : bool

If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?TreeMapColorWay : Color

Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`.

?ExtendIcicleColors : bool

If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?IcicleColorWay : Color

Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.

?Annotations : Annotation seq

A collection containing all Annotations of this layout. 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.

?Shapes : Shape seq

A collection containing all Shapes of this layout.

?Selections : Selection seq

A collection containing all Selections of this layout.

?Images : LayoutImage seq

A collection containing all Images of this layout.

?Sliders : Slider seq

A collection containing all Sliders of this layout.

?UpdateMenus : UpdateMenu seq

A collection containing all UpdateMenus of this layout.

Returns: Layout

Layout.setColorAxis (id, colorAxis)

Full Usage: Layout.setColorAxis (id, colorAxis)

Parameters:
    id : SubPlotId - The ColorAxis id of the new ColorAxis
    colorAxis : ColorAxis - The ColorAxis to add to the layout.

Returns: Layout -> Layout

Sets a ColorAxis object on the layout as a dynamic property with the given ColorAxis id.

id : SubPlotId

The ColorAxis id of the new ColorAxis

colorAxis : ColorAxis

The ColorAxis to add to the layout.

Returns: Layout -> Layout

Layout.setGeo (id, geo)

Full Usage: Layout.setGeo (id, geo)

Parameters:
    id : SubPlotId - The scene id of the new geo
    geo : Geo - The geo to add to the layout.

Returns: Layout -> Layout

Sets a geo object on the layout as a dynamic property with the given geo id.

id : SubPlotId

The scene id of the new geo

geo : Geo

The geo to add to the layout.

Returns: Layout -> Layout

Layout.setLayoutGrid layoutGrid

Full Usage: Layout.setLayoutGrid layoutGrid

Parameters:
    layoutGrid : LayoutGrid - The new LayoutGrid object

Returns: Layout -> Layout

Returns a function that sets the LayoutGrid object of the given trace.

layoutGrid : LayoutGrid

The new LayoutGrid object

Returns: Layout -> Layout

Layout.setLegend (id, legend)

Full Usage: Layout.setLegend (id, legend)

Parameters:
    id : SubPlotId - The Legend id of the new Legend
    legend : Legend - The Legend to add to the layout.

Returns: Layout -> Layout

Sets a linear Legend object on the layout as a dynamic property with the given Legend id.

id : SubPlotId

The Legend id of the new Legend

legend : Legend

The Legend to add to the layout.

Returns: Layout -> Layout

Layout.setLinearAxis (id, axis)

Full Usage: Layout.setLinearAxis (id, axis)

Parameters:
    id : SubPlotId - The axis id of the new axis
    axis : LinearAxis - The axis to add to the layout.

Returns: Layout -> Layout

Sets a linear axis object on the layout as a dynamic property with the given axis id.

id : SubPlotId

The axis id of the new axis

axis : LinearAxis

The axis to add to the layout.

Returns: Layout -> Layout

Layout.setMapbox (id, mapbox)

Full Usage: Layout.setMapbox (id, mapbox)

Parameters:
    id : SubPlotId - The mapbox id of the new mapbox
    mapbox : Mapbox - The mapbox to add to the layout.

Returns: Layout -> Layout

Sets a mapbox object on the layout as a dynamic property with the given mapbox id.

id : SubPlotId

The mapbox id of the new mapbox

mapbox : Mapbox

The mapbox to add to the layout.

Returns: Layout -> Layout

Layout.setPolar (id, polar)

Full Usage: Layout.setPolar (id, polar)

Parameters:
    id : SubPlotId - The scene id of the new geo
    polar : Polar - The polar to add to the layout.

Returns: Layout -> Layout

Sets a polar object on the layout as a dynamic property with the given polar id.

id : SubPlotId

The scene id of the new geo

polar : Polar

The polar to add to the layout.

Returns: Layout -> Layout

Layout.setScene (id, scene)

Full Usage: Layout.setScene (id, scene)

Parameters:
    id : SubPlotId - The scene id of the new scene
    scene : Scene - The scene to add to the layout.

Returns: Layout -> Layout

Sets a scene object on the layout as a dynamic property with the given scene id.

id : SubPlotId

The scene id of the new scene

scene : Scene

The scene to add to the layout.

Returns: Layout -> Layout

Layout.setSmith (id, smith)

Full Usage: Layout.setSmith (id, smith)

Parameters:
    id : SubPlotId - The scene id of the new geo
    smith : Smith - The smith to add to the layout.

Returns: Layout -> Layout

Sets a smith object on the layout as a dynamic property with the given smith id.

id : SubPlotId

The scene id of the new geo

smith : Smith

The smith to add to the layout.

Returns: Layout -> Layout

Layout.setTernary (id, ternary)

Full Usage: Layout.setTernary (id, ternary)

Parameters:
    id : SubPlotId - The Ternary id of the new ColorAxis
    ternary : Ternary - The Ternary to add to the layout.

Returns: Layout -> Layout

Sets a Ternary object on the layout as a dynamic property with the given Ternary id.

id : SubPlotId

The Ternary id of the new ColorAxis

ternary : Ternary

The Ternary to add to the layout.

Returns: Layout -> Layout

Layout.style (?Title, ?ShowLegend, ?Margin, ?AutoSize, ?Width, ?Height, ?Font, ?UniformText, ?Separators, ?PaperBGColor, ?PlotBGColor, ?AutoTypeNumbers, ?Colorscale, ?Colorway, ?ModeBar, ?HoverMode, ?ClickMode, ?DragMode, ?SelectDirection, ?ActiveSelection, ?NewSelection, ?HoverDistance, ?SpikeDistance, ?Hoverlabel, ?Transition, ?DataRevision, ?UIRevision, ?EditRevision, ?SelectRevision, ?Template, ?Meta, ?Computed, ?Grid, ?Calendar, ?MinReducedHeight, ?MinReducedWidth, ?NewShape, ?ActiveShape, ?HideSources, ?ScatterGap, ?ScatterMode, ?BarGap, ?BarGroupGap, ?BarMode, ?BarNorm, ?ExtendPieColors, ?HiddenLabels, ?PieColorWay, ?BoxGap, ?BoxGroupGap, ?BoxMode, ?ViolinGap, ?ViolinGroupGap, ?ViolinMode, ?WaterfallGap, ?WaterfallGroupGap, ?WaterfallMode, ?FunnelGap, ?FunnelGroupGap, ?FunnelMode, ?ExtendFunnelAreaColors, ?FunnelAreaColorWay, ?ExtendSunBurstColors, ?SunBurstColorWay, ?ExtendTreeMapColors, ?TreeMapColorWay, ?ExtendIcicleColors, ?IcicleColorWay, ?Annotations, ?Shapes, ?Selections, ?Images, ?Sliders, ?UpdateMenus)

Full Usage: Layout.style (?Title, ?ShowLegend, ?Margin, ?AutoSize, ?Width, ?Height, ?Font, ?UniformText, ?Separators, ?PaperBGColor, ?PlotBGColor, ?AutoTypeNumbers, ?Colorscale, ?Colorway, ?ModeBar, ?HoverMode, ?ClickMode, ?DragMode, ?SelectDirection, ?ActiveSelection, ?NewSelection, ?HoverDistance, ?SpikeDistance, ?Hoverlabel, ?Transition, ?DataRevision, ?UIRevision, ?EditRevision, ?SelectRevision, ?Template, ?Meta, ?Computed, ?Grid, ?Calendar, ?MinReducedHeight, ?MinReducedWidth, ?NewShape, ?ActiveShape, ?HideSources, ?ScatterGap, ?ScatterMode, ?BarGap, ?BarGroupGap, ?BarMode, ?BarNorm, ?ExtendPieColors, ?HiddenLabels, ?PieColorWay, ?BoxGap, ?BoxGroupGap, ?BoxMode, ?ViolinGap, ?ViolinGroupGap, ?ViolinMode, ?WaterfallGap, ?WaterfallGroupGap, ?WaterfallMode, ?FunnelGap, ?FunnelGroupGap, ?FunnelMode, ?ExtendFunnelAreaColors, ?FunnelAreaColorWay, ?ExtendSunBurstColors, ?SunBurstColorWay, ?ExtendTreeMapColors, ?TreeMapColorWay, ?ExtendIcicleColors, ?IcicleColorWay, ?Annotations, ?Shapes, ?Selections, ?Images, ?Sliders, ?UpdateMenus)

Parameters:
    ?Title : Title - Sets the title of the layout.
    ?ShowLegend : bool - Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.
    ?Margin : Margin - Sets the margins around the layout.
    ?AutoSize : bool - 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.
    ?Width : int - Sets the plot's width (in px).
    ?Height : int - Sets the plot's height (in px).
    ?Font : Font - Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
    ?UniformText : UniformText - Determines how the font size for various text elements are uniformed between each trace type.
    ?Separators : string - Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.
    ?PaperBGColor : Color - Sets the background color of the paper where the graph is drawn.
    ?PlotBGColor : Color - Sets the background color of the plotting area in-between x and y axes.
    ?AutoTypeNumbers : AutoTypeNumbers - Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.
    ?Colorscale : DefaultColorScales - Sets the default colorscales that are used by plots using autocolorscale.
    ?Colorway : Color - Sets the default trace colors.
    ?ModeBar : ModeBar - Sets the modebar of the layout.
    ?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.
    ?ClickMode : ClickMode - Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.
    ?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.
    ?SelectDirection : SelectDirection - When `dragmode` is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.
    ?ActiveSelection : ActiveSelection - Sets the styling of the active selection
    ?NewSelection : NewSelection - Controls the behavior of newly drawn selections
    ?HoverDistance : int - 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.
    ?SpikeDistance : int - Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.
    ?Hoverlabel : Hoverlabel - Sets the style ov hover labels.
    ?Transition : Transition - Sets transition options used during Plotly.react updates.
    ?DataRevision : string - If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.
    ?UIRevision : string - Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.
    ?EditRevision : string - Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
    ?SelectRevision : string - Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
    ?Template : DynamicObj - Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.
    ?Meta : string - Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.
    ?Computed : string - Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-json" mode.
    ?Grid : LayoutGrid - Sets the layout grid for arranging multiple plots
    ?Calendar : Calendar - Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
    ?MinReducedHeight : int - Minimum height of the plot with margin.automargin applied (in px)
    ?MinReducedWidth : int - Minimum width of the plot with margin.automargin applied (in px)
    ?NewShape : NewShape - Controls the behavior of newly drawn shapes
    ?ActiveShape : ActiveShape - Sets the styling of the active shape
    ?HideSources : bool - Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).
    ?ScatterGap : float - Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.
    ?ScatterMode : ScatterMode - Determines how scatter points at the same location coordinate are displayed on the graph. With "group", the scatter points are plotted next to one another centered around the shared location. With "overlay", the scatter points are plotted over one another, you might need to reduce "opacity" to see multiple scatter points.
    ?BarGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?BarGroupGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?BarMode : BarMode - 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.
    ?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.
    ?ExtendPieColors : bool - If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?HiddenLabels : 'a seq - If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?PieColorWay : Color - Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.
    ?BoxGap : float - Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set.
    ?BoxGroupGap : float - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?BoxMode : BoxMode - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinGap : float - Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinGroupGap : float - Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set.
    ?ViolinMode : ViolinMode - Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set.
    ?WaterfallGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?WaterfallGroupGap : float - Sets the gap (in plot fraction) between bars of the same location coordinate.
    ?WaterfallMode : WaterfallMode - Determines how bars at the same location coordinate are displayed on the graph. 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.
    ?FunnelGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?FunnelGroupGap : float - Sets the gap (in plot fraction) between bars of adjacent location coordinates.
    ?FunnelMode : FunnelMode - 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 "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.
    ?ExtendFunnelAreaColors : bool - If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?FunnelAreaColorWay : Color - Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.
    ?ExtendSunBurstColors : bool - If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?SunBurstColorWay : Color - If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?ExtendTreeMapColors : bool - If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?TreeMapColorWay : Color - Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`.
    ?ExtendIcicleColors : bool - If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
    ?IcicleColorWay : Color - Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.
    ?Annotations : Annotation seq - A collection containing all Annotations of this layout. 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.
    ?Shapes : Shape seq - A collection containing all Shapes of this layout.
    ?Selections : Selection seq - A collection containing all Selections of this layout.
    ?Images : LayoutImage seq - A collection containing all Images of this layout.
    ?Sliders : Slider seq - A collection containing all Sliders of this layout.
    ?UpdateMenus : UpdateMenu seq - A collection containing all UpdateMenus of this layout.

Returns: Layout -> Layout

Returns a function that applies the given styles to a Layout object.

?Title : Title

Sets the title of the layout.

?ShowLegend : bool

Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.

?Margin : Margin

Sets the margins around the layout.

?AutoSize : bool

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.

?Width : int

Sets the plot's width (in px).

?Height : int

Sets the plot's height (in px).

?Font : Font

Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.

?UniformText : UniformText

Determines how the font size for various text elements are uniformed between each trace type.

?Separators : string

Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.

?PaperBGColor : Color

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

?PlotBGColor : Color

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

?AutoTypeNumbers : AutoTypeNumbers

Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.

?Colorscale : DefaultColorScales

Sets the default colorscales that are used by plots using autocolorscale.

?Colorway : Color

Sets the default trace colors.

?ModeBar : ModeBar

Sets the modebar of the layout.

?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.

?ClickMode : ClickMode

Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.

?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.

?SelectDirection : SelectDirection

When `dragmode` is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.

?ActiveSelection : ActiveSelection

Sets the styling of the active selection

?NewSelection : NewSelection

Controls the behavior of newly drawn selections

?HoverDistance : int

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.

?SpikeDistance : int

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

?Hoverlabel : Hoverlabel

Sets the style ov hover labels.

?Transition : Transition

Sets transition options used during Plotly.react updates.

?DataRevision : string

If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

?UIRevision : string

Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.

?EditRevision : string

Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

?SelectRevision : string

Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.

?Template : DynamicObj

Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.

?Meta : string

Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.

?Computed : string

Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-json" mode.

?Grid : LayoutGrid

Sets the layout grid for arranging multiple plots

?Calendar : Calendar

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

?MinReducedHeight : int

Minimum height of the plot with margin.automargin applied (in px)

?MinReducedWidth : int

Minimum width of the plot with margin.automargin applied (in px)

?NewShape : NewShape

Controls the behavior of newly drawn shapes

?ActiveShape : ActiveShape

Sets the styling of the active shape

?HideSources : bool

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

?ScatterGap : float

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.

?ScatterMode : ScatterMode

Determines how scatter points at the same location coordinate are displayed on the graph. With "group", the scatter points are plotted next to one another centered around the shared location. With "overlay", the scatter points are plotted over one another, you might need to reduce "opacity" to see multiple scatter points.

?BarGap : float

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

?BarGroupGap : float

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

?BarMode : BarMode

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.

?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.

?ExtendPieColors : bool

If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?HiddenLabels : 'a seq

If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?PieColorWay : Color

Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.

?BoxGap : float

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

?BoxGroupGap : float

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

?BoxMode : BoxMode

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

?ViolinGap : float

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

?ViolinGroupGap : float

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

?ViolinMode : ViolinMode

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

?WaterfallGap : float

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

?WaterfallGroupGap : float

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

?WaterfallMode : WaterfallMode

Determines how bars at the same location coordinate are displayed on the graph. 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.

?FunnelGap : float

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

?FunnelGroupGap : float

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

?FunnelMode : FunnelMode

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 "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.

?ExtendFunnelAreaColors : bool

If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?FunnelAreaColorWay : Color

Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.

?ExtendSunBurstColors : bool

If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?SunBurstColorWay : Color

If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?ExtendTreeMapColors : bool

If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?TreeMapColorWay : Color

Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`.

?ExtendIcicleColors : bool

If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.

?IcicleColorWay : Color

Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.

?Annotations : Annotation seq

A collection containing all Annotations of this layout. 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.

?Shapes : Shape seq

A collection containing all Shapes of this layout.

?Selections : Selection seq

A collection containing all Selections of this layout.

?Images : LayoutImage seq

A collection containing all Images of this layout.

?Sliders : Slider seq

A collection containing all Sliders of this layout.

?UpdateMenus : UpdateMenu seq

A collection containing all UpdateMenus of this layout.

Returns: Layout -> Layout

Layout.tryGetColorAxisById id

Full Usage: Layout.tryGetColorAxisById id

Parameters:
Returns: Layout -> ColorAxis option

Returns Some(ColorAxis) if there is a ColorAxis object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target ColorAxis id

Returns: Layout -> ColorAxis option

Layout.tryGetGeoById id

Full Usage: Layout.tryGetGeoById id

Parameters:
Returns: Layout -> Geo option

Returns Some(Geo) if there is a geo object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target geo id

Returns: Layout -> Geo option

Layout.tryGetLegendById id

Full Usage: Layout.tryGetLegendById id

Parameters:
Returns: Layout -> Legend option

Returns Some(Legend) if there is an Legend object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target Legend id

Returns: Layout -> Legend option

Layout.tryGetLinearAxisById id

Full Usage: Layout.tryGetLinearAxisById id

Parameters:
Returns: Layout -> LinearAxis option

Returns Some(LinearAxis) if there is an axis object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target axis id

Returns: Layout -> LinearAxis option

Layout.tryGetMapboxById id

Full Usage: Layout.tryGetMapboxById id

Parameters:
Returns: Layout -> Mapbox option

Returns Some(Mapbox) if there is amapbox object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target mapbox id

Returns: Layout -> Mapbox option

Layout.tryGetPolarById id

Full Usage: Layout.tryGetPolarById id

Parameters:
Returns: Layout -> Polar option

Returns Some(Polar) if there is a polar object set on the layout with the given id, and None otherwise.

id : SubPlotId

he target polar id

Returns: Layout -> Polar option

Layout.tryGetSceneById id

Full Usage: Layout.tryGetSceneById id

Parameters:
Returns: Layout -> Scene option

Returns Some(Scene) if there is a scene object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target scene id

Returns: Layout -> Scene option

Layout.tryGetSmithById id

Full Usage: Layout.tryGetSmithById id

Parameters:
Returns: Layout -> Smith option

Returns Some(smith) if there is a smith object set on the layout with the given id, and None otherwise.

id : SubPlotId

the target Smith id

Returns: Layout -> Smith option

Layout.tryGetTernaryById id

Full Usage: Layout.tryGetTernaryById id

Parameters:
Returns: Layout -> Ternary option

Returns Some(Ternary) if there is a ColorAxis object set on the layout with the given id, and None otherwise.

id : SubPlotId

The target Ternary id

Returns: Layout -> Ternary option

Layout.tryGetTypedMember propName layout

Full Usage: Layout.tryGetTypedMember propName layout

Parameters:
    propName : string - The name of the dynamic member to get the value of
    layout : Layout - The layout to get the dynamic member value from

Returns: 'T option

Returns Some(dynamic member value) of the trace object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise.

propName : string

The name of the dynamic member to get the value of

layout : Layout

The layout to get the dynamic member value from

Returns: 'T option

Layout.updateColorAxisById (id, colorAxis)

Full Usage: Layout.updateColorAxisById (id, colorAxis)

Parameters:
    id : SubPlotId - The target ColorAxis id
    colorAxis : ColorAxis - The updated ColorAxis object.

Returns: Layout -> Layout

Combines the given colorAxis object with the one already present on the layout.

id : SubPlotId

The target ColorAxis id

colorAxis : ColorAxis

The updated ColorAxis object.

Returns: Layout -> Layout

Layout.updateGeoById (id, geo)

Full Usage: Layout.updateGeoById (id, geo)

Parameters:
    id : SubPlotId - The target geo id
    geo : Geo - The updated geo object.

Returns: Layout -> Layout

Combines the given geo object with the one already present on the layout.

id : SubPlotId

The target geo id

geo : Geo

The updated geo object.

Returns: Layout -> Layout

Layout.updateLayoutGrid layoutGrid

Full Usage: Layout.updateLayoutGrid layoutGrid

Parameters:
    layoutGrid : LayoutGrid - The updated LayoutGrid object

Returns: Layout -> Layout

Combines the given layoutGrid object with the one already present on the layout.

layoutGrid : LayoutGrid

The updated LayoutGrid object

Returns: Layout -> Layout

Layout.updateLegendById (id, legend)

Full Usage: Layout.updateLegendById (id, legend)

Parameters:
    id : SubPlotId - The target Legend id
    legend : Legend - The updated Legend object.

Returns: Layout -> Layout

Combines the given Legend object with the one already present on the layout.

id : SubPlotId

The target Legend id

legend : Legend

The updated Legend object.

Returns: Layout -> Layout

Layout.updateLinearAxisById (id, axis)

Full Usage: Layout.updateLinearAxisById (id, axis)

Parameters:
Returns: Layout -> Layout

Combines the given axis object with the one already present on the layout.

id : SubPlotId

The target axis id

axis : LinearAxis

The updated axis object.

Returns: Layout -> Layout

Layout.updateMapboxById (id, mapbox)

Full Usage: Layout.updateMapboxById (id, mapbox)

Parameters:
    id : SubPlotId - The target mapbox id
    mapbox : Mapbox - The updated mapbox object.

Returns: Layout -> Layout

Combines the given mapbox object with the one already present on the layout.

id : SubPlotId

The target mapbox id

mapbox : Mapbox

The updated mapbox object.

Returns: Layout -> Layout

Layout.updatePolarById (id, polar)

Full Usage: Layout.updatePolarById (id, polar)

Parameters:
    id : SubPlotId - The target polar id
    polar : Polar - The updated polar object.

Returns: Layout -> Layout

Combines the given polar object with the one already present on the layout.

id : SubPlotId

The target polar id

polar : Polar

The updated polar object.

Returns: Layout -> Layout

Layout.updateSceneById (id, scene)

Full Usage: Layout.updateSceneById (id, scene)

Parameters:
    id : SubPlotId - The target scene id
    scene : Scene - The updated scene object.

Returns: Layout -> Layout

Combines the given scene object with the one already present on the layout.

id : SubPlotId

The target scene id

scene : Scene

The updated scene object.

Returns: Layout -> Layout

Layout.updateSmithById (id, smith)

Full Usage: Layout.updateSmithById (id, smith)

Parameters:
    id : SubPlotId - The target smith id
    smith : Smith - The updated smith object.

Returns: Layout -> Layout

Combines the given Smith object with the one already present on the layout.

id : SubPlotId

The target smith id

smith : Smith

The updated smith object.

Returns: Layout -> Layout

Layout.updateTernaryById (id, ternary)

Full Usage: Layout.updateTernaryById (id, ternary)

Parameters:
    id : SubPlotId - The target Ternary id
    ternary : Ternary - The updated Ternary object.

Returns: Layout -> Layout

Combines the given ternary object with the one already present on the layout.

id : SubPlotId

The target Ternary id

ternary : Ternary

The updated Ternary object.

Returns: Layout -> Layout

Type something to start searching.