You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/dash-core-components/dash_core_components/Graph.py
+20-1Lines changed: 20 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,10 @@ class Graph(Component):
51
51
Only applies if `animate` is `true`
52
52
- config (optional): Plotly.js config options.
53
53
See https://plot.ly/javascript/configuration-options/
54
-
for more info.. config has the following type: dict containing keys 'staticPlot', 'editable', 'edits', 'autosizable', 'queueLength', 'fillFrame', 'frameMargins', 'scrollZoom', 'doubleClick', 'showTips', 'showAxisDragHandles', 'showAxisRangeEntryBoxes', 'showLink', 'sendData', 'linkText', 'displayModeBar', 'modeBarButtonsToRemove', 'modeBarButtonsToAdd', 'modeBarButtons', 'displaylogo', 'plotGlPixelRatio', 'topojsonURL', 'mapboxAccessToken'.
54
+
for more info.. config has the following type: dict containing keys 'staticPlot', 'plotlyServerURL', 'editable', 'edits', 'autosizable', 'responsive', 'queueLength', 'fillFrame', 'frameMargins', 'scrollZoom', 'doubleClick', 'showTips', 'showAxisDragHandles', 'showAxisRangeEntryBoxes', 'showLink', 'sendData', 'linkText', 'displayModeBar', 'showSendToCloud', 'modeBarButtonsToRemove', 'modeBarButtonsToAdd', 'modeBarButtons', 'toImageButtonOptions', 'displaylogo', 'watermark', 'plotGlPixelRatio', 'topojsonURL', 'mapboxAccessToken', 'locale', 'locales'.
55
55
Those keys have the following types:
56
56
- staticPlot (boolean; optional): no interactivity, for export or image generation
57
+
- plotlyServerURL (string; optional): base URL for a Plotly cloud instance, if `showSendToCloud` is enabled
57
58
- editable (boolean; optional): we can edit titles, move annotations, etc - sets all pieces of `edits`
58
59
unless a separate `edits` config item overrides individual parts
59
60
- edits (optional): a set of editable properties. edits has the following type: dict containing keys 'annotationPosition', 'annotationTail', 'annotationText', 'axisTitleText', 'colorbarPosition', 'colorbarTitleText', 'legendPosition', 'legendText', 'shapePosition', 'titleText'.
@@ -72,6 +73,7 @@ class Graph(Component):
72
73
- titleText (boolean; optional): the global `layout.title`
73
74
- autosizable (boolean; optional): DO autosize once regardless of layout.autosize
74
75
(use default width or height values otherwise)
76
+
- responsive (boolean; optional): Whether to change layout size when the window size changes
75
77
- queueLength (number; optional): set the length of the undo/redo queue
76
78
- fillFrame (boolean; optional): if we DO autosize, do we fill the container or the screen?
77
79
- frameMargins (number; optional): if we DO autosize, set the frame margins in percents of plot size
@@ -85,6 +87,9 @@ class Graph(Component):
85
87
- sendData (boolean; optional): if we show a link, does it contain data or just link to a plotly file?
86
88
- linkText (string; optional): text appearing in the sendData link
87
89
- displayModeBar (a value equal to: true, false, 'hover'; optional): display the mode bar (true, false, or 'hover')
90
+
- showSendToCloud (boolean; optional): should we include a modebar button to send this data to a
91
+
Plotly Cloud instance, linked by `plotlyServerURL`.
92
+
By default this is false.
88
93
- modeBarButtonsToRemove (list; optional): remove mode bar button by name.
89
94
All modebar button names at https://github.com/plotly/plotly.js/blob/master/src/components/modebar/buttons.js
90
95
Common names include:
@@ -98,12 +103,26 @@ class Graph(Component):
98
103
- modeBarButtons (boolean | number | string | dict | list; optional): fully custom mode bar buttons as nested array,
99
104
where the outer arrays represents button groups, and
100
105
the inner arrays have buttons config objects or names of default buttons
106
+
- toImageButtonOptions (optional): . toImageButtonOptions has the following type: dict containing keys 'format', 'filename', 'width', 'height', 'scale'.
107
+
Those keys have the following types:
108
+
- format (a value equal to: 'jpeg', 'png', 'webp', 'svg'; optional): The file format to create
109
+
- filename (string; optional): The name given to the downloaded file
110
+
- width (number; optional): Width of the downloaded file, in px
111
+
- height (number; optional): Height of the downloaded file, in px
112
+
- scale (number; optional): Extra resolution to give the file after
113
+
rendering it with the given width and height
101
114
- displaylogo (boolean; optional): add the plotly logo on the end of the mode bar
115
+
- watermark (boolean; optional): add the plotly logo even with no modebar
102
116
- plotGlPixelRatio (number; optional): increase the pixel ratio for Gl plot images
103
117
- topojsonURL (string; optional): URL to topojson files used in geo charts
- locales (dict; optional): Localization definitions, if you choose to provide them with the
125
+
plot rather than registering them globally.
107
126
- loading_state (optional): Object that holds the loading state object coming from dash-renderer. loading_state has the following type: dict containing keys 'is_loading', 'prop_name', 'component_name'.
108
127
Those keys have the following types:
109
128
- is_loading (boolean; optional): Determines if the component is loading or not
0 commit comments