Config Structure Reference


                    
                    
                    staticPlot

Determines whether the graphs are interactive or not.

If false, no interactivity, for export or image generation.

Declaration

Swift

public var staticPlot: Bool?


                    
                    
                    plotlyServerURL

When set it determines base URL for the ‘Edit in Chart Studio’ showEditInChartStudio/showSendToCloud mode bar button and the showLink/sendData on-graph link.

To enable sending your data to Chart Studio Cloud, you need to set both plotlyServerURL to ‘https://chart-studio.plotly.com’ and also set showSendToCloud to true.

Declaration

Swift

public var plotlyServerURL: String?


                    
                    
                    editable

Determines whether the graph is editable or not.

Sets all pieces of edits unless a separate edits config item overrides individual parts.

Declaration

Swift

public var editable: Bool?


                    
                    
                    Edits

Undocumented

Declaration

Swift

public struct Edits : Encodable


                    
                    
                    edits

Undocumented

Declaration

Swift

public var edits: Edits?


                    
                    
                    autosizable

Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.

Declaration

Swift

public var autosizable: Bool?


                    
                    
                    responsive

Determines whether to change the layout size when window is resized.

In v2, this option will be removed and will always be true.

Declaration

Swift

public var responsive: Bool?


                    
                    
                    fillFrame

When layout.autosize is turned on, determines whether the graph fills the container (the default) or the screen (if set to true).

Declaration

Swift

public var fillFrame: Bool?


                    
                    
                    frameMargins

When layout.autosize is turned on, set the frame margins in fraction of the graph size.

Declaration

Swift

public var frameMargins: Double?


                    
                    
                    ScrollZoom

Determines whether mouse wheel or two-finger scroll zooms is enable.

Turned on by default for gl3d, geo and mapbox subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set scrollZoom to false to disable scrolling for all subplots.

Declaration

Swift

public struct ScrollZoom : OptionSet, Encodable


                    
                    
                    scrollZoom

Determines whether mouse wheel or two-finger scroll zooms is enable.

Turned on by default for gl3d, geo and mapbox subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set scrollZoom to false to disable scrolling for all subplots.

Declaration

Swift

public var scrollZoom: ScrollZoom?


                    
                    
                    DoubleClick

Sets the double click interaction mode.

Has an effect only in cartesian plots. If false, double click is disable. If reset, double click resets the axis ranges to their initial values. If autosize, double click set the axis ranges to their autorange values. If reset+autosize, the odd double clicks resets the axis ranges to their initial values and even double clicks set the axis ranges to their autorange values.

Declaration

Swift

public enum DoubleClick : Encodable


                    
                    
                    doubleClick

Sets the double click interaction mode.

Has an effect only in cartesian plots. If false, double click is disable. If reset, double click resets the axis ranges to their initial values. If autosize, double click set the axis ranges to their autorange values. If reset+autosize, the odd double clicks resets the axis ranges to their initial values and even double clicks set the axis ranges to their autorange values.

Declaration

Swift

public var doubleClick: DoubleClick?


                    
                    
                    doubleClickDelay

Sets the delay for registering a double-click in ms.

This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo and mapbox) and on-legend double clicks.

Declaration

Swift

public var doubleClickDelay: Double?


                    
                    
                    showAxisDragHandles

Set to false to omit cartesian axis pan/zoom drag handles.

Declaration

Swift

public var showAxisDragHandles: Bool?


                    
                    
                    showAxisRangeEntryBoxes

Set to false to omit direct range entry at the pan/zoom drag points, note that showAxisDragHandles must be enabled to have an effect.

Declaration

Swift

public var showAxisRangeEntryBoxes: Bool?


                    
                    
                    showTips

Determines whether or not tips are shown while interacting with the resulting graphs.

Declaration

Swift

public var showTips: Bool?


                    
                    
                    showLink

Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs.

Use with sendData and linkText.

Declaration

Swift

public var showLink: Bool?


                    
                    
                    linkText

Sets the text appearing in the showLink link.

Declaration

Swift

public var linkText: String?


                    
                    
                    sendData

If showLink is true, does it contain data just link to a Chart Studio Cloud file?

Declaration

Swift

public var sendData: Bool?


                    
                    
                    showSources

Adds a source-displaying function to show sources on the resulting graphs.

Declaration

Swift

public var showSources: Anything?


                    
                    
                    DisplayModeBar

Determines the mode bar display mode.

If true, the mode bar is always visible. If false, the mode bar is always hidden. If hover, the mode bar is visible while the mouse cursor is on the graph container.

Declaration

Swift

public enum DisplayModeBar : Encodable


                    
                    
                    displayModeBar

Determines the mode bar display mode.

If true, the mode bar is always visible. If false, the mode bar is always hidden. If hover, the mode bar is visible while the mouse cursor is on the graph container.

Declaration

Swift

public var displayModeBar: DisplayModeBar?


                    
                    
                    showSendToCloud

Should we include a ModeBar button, labeled “Edit in Chart Studio”, that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server as specified by plotlyServerURL for editing, export, etc? Prior to version 1.43.0 this button was included by default, now it is opt-in using this flag.

Note that this button can (depending on plotlyServerURL being set) send your data to an external server. However that server does not persist your data until you arrive at the Chart Studio and explicitly click “Save”.

Declaration

Swift

public var showSendToCloud: Bool?


                    
                    
                    showEditInChartStudio

Same as showSendToCloud, but use a pencil icon instead of a floppy-disk.

Note that if both showSendToCloud and showEditInChartStudio are turned, only showEditInChartStudio will be honored.

Declaration

Swift

public var showEditInChartStudio: Bool?


                    
                    
                    modeBarButtonsToRemove

Remove mode bar buttons by name.

See ./components/modebar/buttons.js for the list of names.

Declaration

Swift

public var modeBarButtonsToRemove: Anything?


                    
                    
                    modeBarButtonsToAdd

Add mode bar button using config objects See ./components/modebar/buttons.js for list of arguments.

Declaration

Swift

public var modeBarButtonsToAdd: Anything?


                    
                    
                    modeBarButtons

Define fully custom mode bar buttons as nested array, where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons See ./components/modebar/buttons.js for more info.

Declaration

Swift

public var modeBarButtons: Anything?


                    
                    
                    toImageButtonOptions

Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale see ../components/modebar/buttons.js

Declaration

Swift

public var toImageButtonOptions: Anything?


                    
                    
                    displayLogo

Determines whether or not the plotly logo is displayed on the end of the mode bar.

Declaration

Swift

public var displayLogo: Bool?


                    
                    
                    watermark

watermark the images with the company’s logo

Declaration

Swift

public var watermark: Bool?


                    
                    
                    plotGlPixelRatio

Set the pixel ratio during WebGL image export.

This config option was formerly named plot3dPixelRatio which is now deprecated.

Declaration

Swift

public var plotGlPixelRatio: Double?


                    
                    
                    setBackground

Set function to add the background color (i.e.

layout.paper_color) to a different container. This function take the graph div as first argument and the current background color as second argument. Alternatively, set to string opaque to ensure there is white behind it.

Declaration

Swift

public var setBackground: Anything?


                    
                    
                    topoJsonURL

Set the URL to topojson used in geo charts.

By default, the topojson files are fetched from cdn.plot.ly. For example, set this option to: /dist/topojson/ to render geographical feature using the topojson files that ship with the plotly.js module.

Declaration

Swift

public var topoJsonURL: String?


                    
                    
                    mapboxAccessToken

Mapbox access token (required to plot mapbox trace types) If using an Mapbox Atlas server, set this option to “ so that plotly.js won’t attempt to authenticate to the public Mapbox server.

Declaration

Swift

public var mapboxAccessToken: String?


                    
                    
                    logging

Turn all console logging on or off (errors will be thrown) This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs

Declaration

Swift

public var logging: Int?


                    
                    
                    notifyOnLogging

Set on-graph logging (notifier) level This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no on-graph logs 1: warnings and errors, but not informational messages 2: verbose logs

Declaration

Swift

public var notifyOnLogging: Int?


                    
                    
                    queueLength

Sets the length of the undo/redo queue.

Declaration

Swift

public var queueLength: Int?


                    
                    
                    globalTransforms

Set global transform to be applied to all traces with no specification needed

Declaration

Swift

public var globalTransforms: Anything?


                    
                    
                    locale

Which localization should we use? Should be a string like ‘en’ or ‘en-US’.

Declaration

Swift

public var locale: String?


                    
                    
                    locales

Localization definitions Locales can be provided either here (specific to one chart) or globally by registering them as modules.

Should be an object of objects {locale: {dictionary: {…}, format: {…}}} { da: { dictionary: {‘Reset axes’: ‘Nulstil aksler’, …}, format: {months: […], shortMonths: […]} }, … } All parts are optional. When looking for translation or format fields, we look first for an exact match in a config locale, then in a registered module. If those fail, we strip off any regionalization (‘en-US’ -> ‘en’) and try each (config, registry) again. The final fallback for translation is untranslated (which is US English) and for formats is the base English (the only consequence being the last fallback date format %x is DD/MM/YYYY instead of MM/DD/YYYY). Currently grouping and currency are ignored for our automatic number formatting, but can be used in custom formats.

Declaration

Swift

public var locales: Anything?


                    
                    
                    init(staticPlot:plotlyServerURL:editable:edits:autosizable:responsive:fillFrame:frameMargins:scrollZoom:doubleClick:doubleClickDelay:showAxisDragHandles:showAxisRangeEntryBoxes:showTips:showLink:linkText:sendData:showSources:displayModeBar:showSendToCloud:showEditInChartStudio:modeBarButtonsToRemove:modeBarButtonsToAdd:modeBarButtons:toImageButtonOptions:displayLogo:watermark:plotGlPixelRatio:setBackground:topoJsonURL:mapboxAccessToken:logging:notifyOnLogging:queueLength:globalTransforms:locale:locales:)

Creates Config object with specified properties.

Declaration

Swift

public init(staticPlot: Bool? = nil, plotlyServerURL: String? = nil, editable: Bool? = nil,
        edits: Edits? = nil, autosizable: Bool? = nil, responsive: Bool? = nil, fillFrame: Bool? = nil,
        frameMargins: Double? = nil, scrollZoom: ScrollZoom? = nil, doubleClick: DoubleClick? = nil,
        doubleClickDelay: Double? = nil, showAxisDragHandles: Bool? = nil, showAxisRangeEntryBoxes:
        Bool? = nil, showTips: Bool? = nil, showLink: Bool? = nil, linkText: String? = nil, sendData:
        Bool? = nil, showSources: Anything? = nil, displayModeBar: DisplayModeBar? = nil,
        showSendToCloud: Bool? = nil, showEditInChartStudio: Bool? = nil, modeBarButtonsToRemove:
        Anything? = nil, modeBarButtonsToAdd: Anything? = nil, modeBarButtons: Anything? = nil,
        toImageButtonOptions: Anything? = nil, displayLogo: Bool? = nil, watermark: Bool? = nil,
        plotGlPixelRatio: Double? = nil, setBackground: Anything? = nil, topoJsonURL: String? = nil,
        mapboxAccessToken: String? = nil, logging: Int? = nil, notifyOnLogging: Int? = nil, queueLength:
        Int? = nil, globalTransforms: Anything? = nil, locale: String? = nil, locales: Anything? = nil)

Parameters

`staticPlot`	Determines whether the graphs are interactive or not.
`plotlyServerURL`	When set it determines base URL for the ‘Edit in Chart Studio’ `showEditInChartStudio`/`showSendToCloud` mode bar button and the showLink/sendData on-graph link.
`editable`	Determines whether the graph is editable or not.
`edits`
`autosizable`	Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.
`responsive`	Determines whether to change the layout size when window is resized.
`fillFrame`	When `layout.autosize` is turned on, determines whether the graph fills the container (the default) or the screen (if set to true).
`frameMargins`	When `layout.autosize` is turned on, set the frame margins in fraction of the graph size.
`scrollZoom`	Determines whether mouse wheel or two-finger scroll zooms is enable.
`doubleClick`	Sets the double click interaction mode.
`doubleClickDelay`	Sets the delay for registering a double-click in ms.
`showAxisDragHandles`	Set to false to omit cartesian axis pan/zoom drag handles.
`showAxisRangeEntryBoxes`	Set to false to omit direct range entry at the pan/zoom drag points, note that `showAxisDragHandles` must be enabled to have an effect.
`showTips`	Determines whether or not tips are shown while interacting with the resulting graphs.
`showLink`	Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs.
`linkText`	Sets the text appearing in the `showLink` link.
`sendData`	If showLink is true, does it contain data just link to a Chart Studio Cloud file?
`showSources`	Adds a source-displaying function to show sources on the resulting graphs.
`displayModeBar`	Determines the mode bar display mode.
`showSendToCloud`	Should we include a ModeBar button, labeled “Edit in Chart Studio”, that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server as specified by `plotlyServerURL` for editing, export, etc? Prior to version 1.43.0 this button was included by default, now it is opt-in using this flag.
`showEditInChartStudio`	Same as `showSendToCloud`, but use a pencil icon instead of a floppy-disk.
`modeBarButtonsToRemove`	Remove mode bar buttons by name.
`modeBarButtonsToAdd`	Add mode bar button using config objects See ./components/modebar/buttons.js for list of arguments.
`modeBarButtons`	Define fully custom mode bar buttons as nested array, where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons See ./components/modebar/buttons.js for more info.
`toImageButtonOptions`	Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale see ../components/modebar/buttons.js
`displayLogo`	Determines whether or not the plotly logo is displayed on the end of the mode bar.
`watermark`	watermark the images with the company’s logo
`plotGlPixelRatio`	Set the pixel ratio during WebGL image export.
`setBackground`	Set function to add the background color (i.e.
`topoJsonURL`	Set the URL to topojson used in geo charts.
`mapboxAccessToken`	Mapbox access token (required to plot mapbox trace types) If using an Mapbox Atlas server, set this option to “ so that plotly.js won’t attempt to authenticate to the public Mapbox server.
`logging`	Turn all console logging on or off (errors will be thrown) This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs
`notifyOnLogging`	Set on-graph logging (notifier) level This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no on-graph logs 1: warnings and errors, but not informational messages 2: verbose logs
`queueLength`	Sets the length of the undo/redo queue.
`globalTransforms`	Set global transform to be applied to all traces with no specification needed
`locale`	Which localization should we use? Should be a string like ‘en’ or ‘en-US’.
`locales`	Localization definitions Locales can be provided either here (specific to one chart) or globally by registering them as modules.