dcc.Graph

The dcc.Graph component can be used to render any plotly-powered data visualization, passed as the figure argument.

Primer on Plotly Graphing Library

Examples

Plotly Express in Dash

The fig object is passed directly into the figure property of dcc.Graph:

from dash import dcc
import plotly.express as px

df = px.data.iris()  # iris is a pandas DataFrame
fig = px.scatter(df, x="sepal_width", y="sepal_length")

dcc.Graph(figure=fig)

Using the Low-Level Interface with go.Figure

Using the Low-Level Interface with go.Figure

Read through (1) above to learn more about the difference between px & go.Figure.

from dash import dcc
import plotly.graph_objs as go

fig = go.Figure(data=[go.Scatter(x=[1, 2, 3], y=[4, 1, 2])])

dcc.Graph(figure=fig)

Using the Low-Level Interface with Dicts & Lists

Read through (1) above to learn more about the difference between px, go.Figure, and dicts & lists.

from dash import dcc

dcc.Graph(
    figure={
        'data': [
            {'x': [1, 2, 3], 'y': [4, 1, 2], 'type': 'bar', 'name': 'SF'},
            {'x': [1, 2, 3], 'y': [2, 4, 5], 'type': 'bar', 'name': u'Montréal'},
        ],
        'layout': {
            'title': 'Dash Data Visualization'
        }
    }
)

Interactive Graphing with Callbacks

The Interactive Visualizations tutorial explains how to capture user interaction events with a dcc.Graph, and how to update the figure property in callbacks.

Some advanced features are documented in community forum posts: * How to preserve the UI state (zoom level etc.) of a Graph when updating the Graph in a callback https://community.plot.ly/t/preserving-ui-state-like-zoom-in-dcc-graph-with-uirevision/15793 * Graph transitions for smooth transitions or animations on Graph updates https://community.plot.ly/t/exploring-a-transitions-api-for-dcc-graph/15468

Controlling the Plotly.js Version Used by dcc.Graph

There are quite a few options that you can take advantage of if you want the size of your graph to be reactive.

The default plotly.js behavior dictates that the graph should resize upon window resize. However, in some cases, you might want to resize the graph based on the size of its parent container instead.
(You can set the size of the parent container with the style.height and style.width properties.)

The responsive property of the dcc.Graph component allows you to define your desired behavior.
In short, it accepts as a value True, False, or 'auto': * True forces the graph to be responsive to window and parent resize, regardless of any other specifications in figure.layout or config * False forces the graph to be non-responsive to window and parent resize, regardless of any other specifications in figure.layout or config * 'auto' preserves the legacy behavior (size and resizability are determined by values specified in figure.layout and config.responsive)

How Resizing Works - Advanced

The properties of dcc.Graph that can control the size of the graph (other than responsive) are: * figure.layout.height - explicitly sets the height * figure.layout.width- explicitly sets the width * figure.layout.autosize - if True, sets the height and width of the graph to that of its parent container * config.responsive - if True, changes the height and width of the graph upon window resize.

The responsive property works in conjunction with the above properties in the following way:

Graph Properties

Access this documentation in your Python terminal with:
```python

help(dash.dcc.Graph)
```

Our recommended IDE for writing Dash apps is Dash Enterprise’s
Data Science Workspaces,
which has typeahead support for Dash Component Properties.
Find out if your company is using
Dash Enterprise.

id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components in
an app.

responsive (a value equal to: true, false or ‘auto’; default 'auto'):
If True, the Plotly.js plot will be fully responsive to window resize
and parent element resize event. This is achieved by overriding
config.responsive to True, figure.layout.autosize to True and
unsetting figure.layout.height and figure.layout.width. If False,
the Plotly.js plot not be responsive to window resize and parent
element resize event. This is achieved by overriding
config.responsive to False and figure.layout.autosize to False. If
‘auto’ (default), the Graph will determine if the Plotly.js plot can
be made fully responsive (True) or not (False) based on the values in
config.responsive, figure.layout.autosize, figure.layout.height,
figure.layout.width. This is the legacy behavior of the Graph
component. Needs to be combined with appropriate dimension / styling
through the style prop to fully take effect.

clickData (dict; optional):
Data from latest click event. Read-only.

clickAnnotationData (dict; optional):
Data from latest click annotation event. Read-only.

hoverData (dict; optional):
Data from latest hover event. Read-only.

clear_on_unhover (boolean; default False):
If True, clear_on_unhover will clear the hoverData property when
the user “unhovers” from a point. If False, then the hoverData
property will be equal to the data from the last point that was
hovered over.

selectedData (dict; optional):
Data from latest select event. Read-only.

relayoutData (dict; optional):
Data from latest relayout event which occurs when the user zooms or
pans on the plot or other layout-level edits. Has the form {<attr>: <value>} describing the changes made. Read-only.

extendData (list | dict; optional):
Data that should be appended to existing traces. Has the form
[updateData, traceIndices, maxPoints], where updateData is an
object containing the data to extend, traceIndices (optional) is an
array of trace indices that should be extended, and maxPoints
(optional) is either an integer defining the maximum number of points
allowed or an object with key:value pairs matching updateData
Reference the Plotly.extendTraces API for full usage:
https://plotly.com/javascript/plotlyjs-function-reference/#plotlyextendtraces.

prependData (list | dict; optional):
Data that should be prepended to existing traces. Has the form
[updateData, traceIndices, maxPoints], where updateData is an
object containing the data to prepend, traceIndices (optional) is an
array of trace indices that should be prepended, and maxPoints
(optional) is either an integer defining the maximum number of points
allowed or an object with key:value pairs matching updateData
Reference the Plotly.prependTraces API for full usage:
https://plotly.com/javascript/plotlyjs-function-reference/#plotlyprependtraces.

restyleData (list; optional):
Data from latest restyle event which occurs when the user toggles a
legend item, changes parcoords selections, or other trace-level edits.
Has the form [edits, indices], where edits is an object {<attr>: <value>} describing the changes made, and indices is an
array of trace indices that were edited. Read-only.

figure (dict; default { data: [], layout: {}, frames: [],}):
Plotly figure object. See schema:
https://plotly.com/javascript/reference config is set separately by
the config property.

figure is a dict with keys:

style (dict; optional):
Generic style overrides on the plot div.

className (string; optional):
className of the parent div.

mathjax (boolean; default False):
If True, loads mathjax v3 (tex-svg) into the page and use it in the
graph.

animate (boolean; default False):
Beta: If True, animate between updates using plotly.js’s animate
function.

animation_options (dict; default { frame: { redraw: False, }, transition: { duration: 750, ease: 'cubic-in-out', },}):
Beta: Object containing animation settings. Only applies if animate
is True.

config (dict; optional):
Plotly.js config options. See
https://plotly.com/javascript/configuration-options/ for more info.

config is a dict with keys:

loading_state (dict; optional):
Object that holds the loading state object coming from dash-renderer.

loading_state is a dict with keys: