Plotly.NET
Config Type
The Config object gets passed to the plotly renderer and contains render-specific options.
Static members
| Static member | Description |
|
|
Full Usage:
Config.init (?StaticPlot, ?TypesetMath, ?PlotlyServerUrl, ?Editable, ?Edits, ?EditSelection, ?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)
Parameters:
bool
-
Determines whether the graphs are interactive or not. If *false*, no interactivity, for export or image generation.
?TypesetMath : bool
-
Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.
?PlotlyServerUrl : string
-
When set it determines base URL form 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.
?Editable : bool
-
Determines whether the graph is editable or not. Sets all pieces of `edits` unless a separate `edits` config item overrides individual parts.
?Edits : Edits
-
Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).
?EditSelection : bool
-
Enables moving selections.
?Autosizable : bool
-
Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.
?Responsive : bool
-
Determines whether to change the layout size when window is resized. In v3, this option will be removed and will always be true.
?FillFrame : bool
-
When `layout.autosize` is turned on, determines whether the grap fills the container (the default) or the screen (if set to *true*).
?FrameMargins : float
-
When `layout.autosize` is turned on, set the frame margins in fraction of the graph size.'
?ScrollZoom : 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.
?DoubleClick : 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.
?DoubleClickDelay : int
-
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.
?ShowAxisDragHandles : bool
-
Set to *false* to omit cartesian axis pan/zoom drag handles.
?ShowAxisRangeEntryBoxes : bool
-
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 : bool
-
Determines whether or not tips are shown while interacting with the resulting graphs.
?ShowLink : bool
-
Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with `sendData` and `linkText`.
?LinkText : string
-
Sets the text appearing in the `showLink` link.
?SendData : bool
-
If *showLink* is true, does it contain data just link to a Chart Studio Cloud file?
?ShowSources : obj
-
Adds a source-displaying function to show sources on the resulting graphs.
?DisplayModeBar : bool
-
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.
?ShowSendToCloud : bool
-
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".
?ShowEditInChartStudio : bool
-
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.
?ModeBarButtonsToRemove : ModeBarButton seq
-
Remove mode bar buttons by name. See ./components/modebar/buttons.js for the list of names.
?ModeBarButtonsToAdd : ModeBarButton seq
-
Add mode bar button using config objects. See ./components/modebar/buttons.js for list of arguments. To enable predefined modebar buttons e.g. shape drawing, hover and spikelines simply provide their string name(s). This could include: *v1hovermode*, *hoverclosest*, *hovercompare*, *togglehover*, *togglespikelines*, *drawline*, *drawopenpath*, *drawclosedpath*, *drawcircle*, *drawrect* and *eraseshape*. Please note that these predefined buttons will only be shown if they are compatible with all trace types used in a graph.
?ModeBarButtons : ModeBarButton seq seq
-
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 : ToImageButtonOptions
-
Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale', see ../components/modebar/buttons.js
?Displaylogo : bool
-
Determines whether or not the plotly logo is displayed on the end of the mode bar.
?Watermark : bool
-
watermark the images with the company\'s logo
?plotGlPixelRatio : float
-
Set the pixel ratio during WebGL image export. This config option was formerly named `plot3dPixelRatio` which is now deprecated.
?SetBackground : obj
-
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.
?TopojsonURL : string
-
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: ?MapboxAccessToken : string
-
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 : int
-
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 : int
-
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
?QueueLength : int
-
Sets the length of the undo/redo queue.
?GlobalTransforms : obj
-
Set global transform to be applied to all traces with no specification needed
?Locale : string
-
Which localization should we use? Should be a string like \'en\' or \'en-US\'.
?Locales : obj
-
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.
Returns: Config
|
|
Full Usage:
Config.style (?StaticPlot, ?TypesetMath, ?PlotlyServerUrl, ?Editable, ?Edits, ?EditSelection, ?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)
Parameters:
bool
-
Determines whether the graphs are interactive or not. If *false*, no interactivity, for export or image generation.
?TypesetMath : bool
-
Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.
?PlotlyServerUrl : string
-
When set it determines base URL form 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.
?Editable : bool
-
Determines whether the graph is editable or not. Sets all pieces of `edits` unless a separate `edits` config item overrides individual parts.
?Edits : Edits
-
Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).
?EditSelection : bool
-
Enables moving selections.
?Autosizable : bool
-
Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.
?Responsive : bool
-
Determines whether to change the layout size when window is resized. In v3, this option will be removed and will always be true.
?FillFrame : bool
-
When `layout.autosize` is turned on, determines whether the grap fills the container (the default) or the screen (if set to *true*).
?FrameMargins : float
-
When `layout.autosize` is turned on, set the frame margins in fraction of the graph size.'
?ScrollZoom : 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.
?DoubleClick : 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.
?DoubleClickDelay : int
-
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.
?ShowAxisDragHandles : bool
-
Set to *false* to omit cartesian axis pan/zoom drag handles.
?ShowAxisRangeEntryBoxes : bool
-
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 : bool
-
Determines whether or not tips are shown while interacting with the resulting graphs.
?ShowLink : bool
-
Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with `sendData` and `linkText`.
?LinkText : string
-
Sets the text appearing in the `showLink` link.
?SendData : bool
-
If *showLink* is true, does it contain data just link to a Chart Studio Cloud file?
?ShowSources : obj
-
Adds a source-displaying function to show sources on the resulting graphs.
?DisplayModeBar : bool
-
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.
?ShowSendToCloud : bool
-
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".
?ShowEditInChartStudio : bool
-
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.
?ModeBarButtonsToRemove : ModeBarButton seq
-
Remove mode bar buttons by name. See ./components/modebar/buttons.js for the list of names.
?ModeBarButtonsToAdd : ModeBarButton seq
-
Add mode bar button using config objects. See ./components/modebar/buttons.js for list of arguments. To enable predefined modebar buttons e.g. shape drawing, hover and spikelines simply provide their string name(s). This could include: *v1hovermode*, *hoverclosest*, *hovercompare*, *togglehover*, *togglespikelines*, *drawline*, *drawopenpath*, *drawclosedpath*, *drawcircle*, *drawrect* and *eraseshape*. Please note that these predefined buttons will only be shown if they are compatible with all trace types used in a graph.
?ModeBarButtons : ModeBarButton seq seq
-
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 : ToImageButtonOptions
-
Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale', see ../components/modebar/buttons.js
?Displaylogo : bool
-
Determines whether or not the plotly logo is displayed on the end of the mode bar.
?Watermark : bool
-
watermark the images with the company\'s logo
?plotGlPixelRatio : float
-
Set the pixel ratio during WebGL image export. This config option was formerly named `plot3dPixelRatio` which is now deprecated.
?SetBackground : obj
-
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.
?TopojsonURL : string
-
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: ?MapboxAccessToken : string
-
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 : int
-
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 : int
-
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
?QueueLength : int
-
Sets the length of the undo/redo queue.
?GlobalTransforms : obj
-
Set global transform to be applied to all traces with no specification needed
?Locale : string
-
Which localization should we use? Should be a string like \'en\' or \'en-US\'.
?Locales : obj
-
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.
Returns: Config -> Config
|
|