Layout

public struct Layout : Encodable

Specification of element arrangement on a Figure that applies to all traces.

See also

Documentation for Python, JavaScript or R

FunnelArea

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

    Declaration

    Swift

    public var funnelAreaColorWay: ColorList?

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

    Declaration

    Swift

    public var extendFunnelAreaColors: Bool?

Treemap

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

    Declaration

    Swift

    public var treemapColorWay: ColorList?

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

    Declaration

    Swift

    public var extendTreemapColors: Bool?

Sunburst

  • Sets the default sunburst 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 extendsunburstcolors.

    Declaration

    Swift

    public var sunburstColorWay: ColorList?

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

    Declaration

    Swift

    public var extendSunburstColors: Bool?

Pie

  • hiddenlabels is the funnelarea & pie chart analog of visible:‘legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

    Declaration

    Swift

    public var hiddenLabels: [Double]?

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

    Declaration

    Swift

    public var pieColorWay: ColorList?

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

    Declaration

    Swift

    public var extendPieColors: Bool?

Waterfall

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

    See more

    Declaration

    Swift

    public enum WaterfallMode : String, Encodable

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

    Declaration

    Swift

    public var waterfallMode: WaterfallMode?

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

    Declaration

    Swift

    public var waterfallGap: Double?

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

    Declaration

    Swift

    public var waterfallGroupGap: Double?

Funnel

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

    See more

    Declaration

    Swift

    public enum FunnelMode : String, Encodable

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

    Declaration

    Swift

    public var funnelMode: FunnelMode?

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

    Declaration

    Swift

    public var funnelGap: Double?

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

    Declaration

    Swift

    public var funnelGroupGap: Double?

Violin

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

    See more

    Declaration

    Swift

    public enum ViolinMode : String, Encodable

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

    Declaration

    Swift

    public var violinMode: ViolinMode?

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

    Has no effect on traces that have width set.

    Declaration

    Swift

    public var violinGap: Double?

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

    Has no effect on traces that have width set.

    Declaration

    Swift

    public var violinGroupGap: Double?

Box and Candlestick

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

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

    See more

    Declaration

    Swift

    public enum BoxMode : String, Encodable

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

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

    Declaration

    Swift

    public var boxMode: BoxMode?

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

    Has no effect on traces that have width set.

    Declaration

    Swift

    public var boxGap: Double?

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

    Has no effect on traces that have width set.

    Declaration

    Swift

    public var boxGroupGap: Double?

Bar, BarPolar and Histogram

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

    See more

    Declaration

    Swift

    public enum BarMode : String, Encodable

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

    Declaration

    Swift

    public var barMode: BarMode?

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

    See more

    Declaration

    Swift

    public enum BarNormalization : String, Encodable

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

    Declaration

    Swift

    public var barNormalization: BarNormalization?

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

    Declaration

    Swift

    public var barGap: Double?

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

    Declaration

    Swift

    public var barGroupGap: Double?

Design, Look and Feel

  • Sets the global font.

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

    Declaration

    Swift

    public var font: Font?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Title : Encodable
    extension Layout.Title: ExpressibleByStringLiteral

  • Undocumented

    Declaration

    Swift

    public var title: Title?

  • Undocumented

    See more

    Declaration

    Swift

    public struct UniformText : Encodable

  • Undocumented

    Declaration

    Swift

    public var uniformText: UniformText?

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

    Declaration

    Swift

    public var autoSize: Bool?

  • Sets the plot’s width (in px).

    Declaration

    Swift

    public var width: Double?

  • Sets the plot’s height (in px).

    Declaration

    Swift

    public var height: Double?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Margin : Encodable

  • Undocumented

    Declaration

    Swift

    public var margin: Margin?

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

    Declaration

    Swift

    public var computed: Anything?

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

    Declaration

    Swift

    public var paperBackgroundColor: Color?

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

    Declaration

    Swift

    public var plotBackgroundColor: Color?

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

    Declaration

    Swift

    public var autoTypeNumbers: AutoTypeNumbers?

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

    Declaration

    Swift

    public var separators: String?

  • 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).

    Declaration

    Swift

    public var hideSources: 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.

    Declaration

    Swift

    public var showLegend: Bool?

  • Sets the default trace colors.

    Declaration

    Swift

    public var colorWay: ColorList?

Templating and Events

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

    Declaration

    Swift

    public var dataRevision: Anything?

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

    Declaration

    Swift

    public var uiRevision: Anything?

  • Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles.

    Defaults to layout.uirevision.

    Declaration

    Swift

    public var editRevision: Anything?

  • Controls persistence of user-driven changes in selected points from all traces.

    Declaration

    Swift

    public var selectionRevision: Anything?

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

    Declaration

    Swift

    public var template: Anything?

User Interface

  • Undocumented

    See more

    Declaration

    Swift

    public struct ModeBar : Encodable

  • Undocumented

    Declaration

    Swift

    public var modeBar: ModeBar?

  • Undocumented

    See more

    Declaration

    Swift

    public struct NewShape : Encodable

  • Undocumented

    Declaration

    Swift

    public var newShape: NewShape?

  • Undocumented

    See more

    Declaration

    Swift

    public struct ActiveShape : Encodable

  • Undocumented

    Declaration

    Swift

    public var activeShape: ActiveShape?

  • 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]}.

    Declaration

    Swift

    public var meta: Data<Anything>?

  • Sets transition options used during Plotly.react updates.

    See more

    Declaration

    Swift

    public struct Transition : Encodable

  • Sets transition options used during Plotly.react updates.

    Declaration

    Swift

    public var transition: Transition?

User Interaction

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

    See more

    Declaration

    Swift

    public struct ClickMode : OptionSet, Encodable

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

    Declaration

    Swift

    public var clickMode: ClickMode?

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

    See more

    Declaration

    Swift

    public enum DragMode : Encodable

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

    Declaration

    Swift

    public var dragMode: DragMode?

  • Determines the mode of hover interactions.

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

    See more

    Declaration

    Swift

    public enum HoverMode : Encodable

  • Determines the mode of hover interactions.

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

    Declaration

    Swift

    public var hoverMode: HoverMode?

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

    Declaration

    Swift

    public var hoverDistance: 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.

    Declaration

    Swift

    public var spikeDistance: Int?

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

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

    See more

    Declaration

    Swift

    public enum SelectDirection : String, Encodable

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

    Declaration

    Swift

    public var selectDirection: SelectDirection?

Subplots and Axes

  • Undocumented

    See more

    Declaration

    Swift

    public struct Grid : Encodable

  • Undocumented

    Declaration

    Swift

    public var grid: Grid?

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

    Declaration

    Swift

    public var calendar: Calendar?

  • Undocumented

    Declaration

    Swift

    public var xAxis: [XAxis]

  • Undocumented

    Declaration

    Swift

    public var yAxis: [YAxis]

  • Undocumented

    Declaration

    Swift

    public var ternary: [Ternary]

  • Undocumented

    Declaration

    Swift

    public var scene: [Scene]
  • geo

    Undocumented

    Declaration

    Swift

    public var geo: [Geo]

  • Undocumented

    Declaration

    Swift

    public var mapbox: [Mapbox]

  • Undocumented

    Declaration

    Swift

    public var polar: [Polar]

Legend, Labels and Shapes

  • Undocumented

    See more

    Declaration

    Swift

    public struct Legend : Encodable

  • Undocumented

    Declaration

    Swift

    public var legend: Legend?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Annotation : Encodable

  • Undocumented

    Declaration

    Swift

    public var annotations: [Annotation]?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Shape : Encodable

  • Undocumented

    Declaration

    Swift

    public var shapes: [Shape]?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Image : Encodable

  • Undocumented

    Declaration

    Swift

    public var images: [Image]?

  • Undocumented

    See more

    Declaration

    Swift

    public struct UpdateMenu : Encodable

  • Undocumented

    Declaration

    Swift

    public var updateMenus: [UpdateMenu]?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Slider : Encodable

  • Undocumented

    Declaration

    Swift

    public var sliders: [Slider]?

Color Visualization

  • Undocumented

    See more

    Declaration

    Swift

    public struct ColorMap : Encodable

  • Undocumented

    Declaration

    Swift

    public var colorScale: ColorMap?

  • Undocumented

    Declaration

    Swift

    public var colorAxis: [ColorAxis]
  • init(funnelAreaColorWay:extendFunnelAreaColors:treemapColorWay:extendTreemapColors:sunburstColorWay:extendSunburstColors:hiddenLabels:pieColorWay:extendPieColors:waterfallMode:waterfallGap:waterfallGroupGap:funnelMode:funnelGap:funnelGroupGap:violinMode:violinGap:violinGroupGap:boxMode:boxGap:boxGroupGap:barMode:barNormalization:barGap:barGroupGap:font:title:uniformText:autoSize:width:height:margin:computed:paperBackgroundColor:plotBackgroundColor:autoTypeNumbers:separators:hideSources:showLegend:colorWay:dataRevision:uiRevision:editRevision:selectionRevision:template:modeBar:newShape:activeShape:meta:transition:clickMode:dragMode:hoverMode:hoverDistance:spikeDistance:hoverLabel:selectDirection:grid:calendar:xAxis:yAxis:ternary:scene:geo:mapbox:polar:legend:annotations:shapes:images:updateMenus:sliders:colorScale:colorAxis:)

    Creates Layout object with specified properties.

    Declaration

    Swift

    public init(funnelAreaColorWay: ColorList? = nil, extendFunnelAreaColors: Bool? = nil,
        treemapColorWay: ColorList? = nil, extendTreemapColors: Bool? = nil, sunburstColorWay:
        ColorList? = nil, extendSunburstColors: Bool? = nil, hiddenLabels: [Double]? = nil, pieColorWay:
        ColorList? = nil, extendPieColors: Bool? = nil, waterfallMode: WaterfallMode? = nil,
        waterfallGap: Double? = nil, waterfallGroupGap: Double? = nil, funnelMode: FunnelMode? = nil,
        funnelGap: Double? = nil, funnelGroupGap: Double? = nil, violinMode: ViolinMode? = nil,
        violinGap: Double? = nil, violinGroupGap: Double? = nil, boxMode: BoxMode? = nil, boxGap:
        Double? = nil, boxGroupGap: Double? = nil, barMode: BarMode? = nil, barNormalization:
        BarNormalization? = nil, barGap: Double? = nil, barGroupGap: Double? = nil, font: Font? = nil,
        title: Title? = nil, uniformText: UniformText? = nil, autoSize: Bool? = nil, width: Double? =
        nil, height: Double? = nil, margin: Margin? = nil, computed: Anything? = nil,
        paperBackgroundColor: Color? = nil, plotBackgroundColor: Color? = nil, autoTypeNumbers:
        AutoTypeNumbers? = nil, separators: String? = nil, hideSources: Bool? = nil, showLegend: Bool? =
        nil, colorWay: ColorList? = nil, dataRevision: Anything? = nil, uiRevision: Anything? = nil,
        editRevision: Anything? = nil, selectionRevision: Anything? = nil, template: Anything? = nil,
        modeBar: ModeBar? = nil, newShape: NewShape? = nil, activeShape: ActiveShape? = nil, meta:
        Data<Anything>? = nil, transition: Transition? = nil, clickMode: ClickMode? = nil, dragMode:
        DragMode? = nil, hoverMode: HoverMode? = nil, hoverDistance: Int? = nil, spikeDistance: Int? =
        nil, hoverLabel: HoverLabel? = nil, selectDirection: SelectDirection? = nil, grid: Grid? = nil,
        calendar: Calendar? = nil, xAxis: [XAxis] = [], yAxis: [YAxis] = [], ternary: [Ternary] = [],
        scene: [Scene] = [], geo: [Geo] = [], mapbox: [Mapbox] = [], polar: [Polar] = [], legend:
        Legend? = nil, annotations: [Annotation]? = nil, shapes: [Shape]? = nil, images: [Image]? = nil,
        updateMenus: [UpdateMenu]? = nil, sliders: [Slider]? = nil, colorScale: ColorMap? = nil,
        colorAxis: [ColorAxis] = [])

    Parameters

    funnelAreaColorWay

    Sets the default funnelarea slice colors.
    extendFunnelAreaColors

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

    Sets the default treemap slice colors.
    extendTreemapColors

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

    Sets the default sunburst slice colors.
    extendSunburstColors

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

    hiddenlabels is the funnelarea & pie chart analog of visible:‘legendonly’ but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts
    pieColorWay

    Sets the default pie slice colors.
    extendPieColors

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Sets the normalization for bar traces on the graph.
    barGap

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

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

    Sets the global font.
    title

    uniformText

    autoSize

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

    Sets the plot’s width (in px).
    height

    Sets the plot’s height (in px).
    margin

    computed

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

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

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

    Using strict a numeric string in trace data is not converted to a number.
    separators

    Sets the decimal and thousand separators.
    hideSources

    Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure.
    showLegend

    Determines whether or not a legend is drawn.
    colorWay

    Sets the default trace colors.
    dataRevision

    If provided, a changed value tells Plotly.react that one or more data arrays has changed.
    uiRevision

    Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions.
    editRevision

    Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles.
    selectionRevision

    Controls persistence of user-driven changes in selected points from all traces.
    template

    Default attributes to be applied to the plot.
    modeBar

    newShape

    activeShape

    meta

    Assigns extra meta information that can be used in various text attributes.
    transition

    Sets transition options used during Plotly.react updates.
    clickMode

    Determines the mode of single click interactions.
    dragMode

    Determines the mode of drag interactions.
    hoverMode

    Determines the mode of hover interactions.
    hoverDistance

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

    Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data).
    hoverLabel

    selectDirection

    When dragmode is set to select, this limits the selection of the drag to horizontal, vertical or diagonal.
    grid

    calendar

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

    yAxis

    ternary

    scene

    geo

    mapbox

    polar

    legend

    annotations

    shapes

    images

    updateMenus

    sliders

    colorScale

    colorAxis

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws