clickData (dict; optional): Data from latest click event
hoverData (dict; optional): Data from latest hover event
clear_on_unhover (boolean; optional): 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
relayoutData (dict; optional): Data from latest relayout event which occurs
when the user zooms or pans on the plot
style (dict; optional): Generic style overrides on the plot div
className (string; optional): className of the parent div
animate (boolean; optional): Beta: If true, animate between updates using
plotly.jsâs animate function
animation_options (dict; optional): Beta: Object containing animation settings.
Only applies if animate is true
config (optional): Plotly.js config options.
See Configuration options in JavaScript
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â.
Those keys have the following types:
staticPlot (boolean; optional): no interactivity, for export or image generation
editable (boolean; optional): we can edit titles, move annotations, etc - sets all pieces of edits
unless a separate edits config item overrides individual parts
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â.
Those keys have the following types:
annotationPosition (boolean; optional): annotationPosition: the main anchor of the annotation, which is the
text (if no arrow) or the arrow (which drags the whole thing leaving
the arrow length & direction unchanged)
annotationTail (boolean; optional): just for annotations with arrows, change the length and direction of the arrow
annotationText (boolean; optional)
axisTitleText (boolean; optional)
colorbarPosition (boolean; optional)
colorbarTitleText (boolean; optional)
legendPosition (boolean; optional)
legendText (boolean; optional): edit the trace name fields from the legend
shapePosition (boolean; optional)
titleText (boolean; optional): the global layout.title
autosizable (boolean; optional): DO autosize once regardless of layout.autosize
(use default width or height values otherwise)
queueLength (number; optional): set the length of the undo/redo queue
fillFrame (boolean; optional): if we DO autosize, do we fill the container or the screen?
frameMargins (number; optional): if we DO autosize, set the frame margins in percents of plot size
scrollZoom (boolean; optional): mousewheel or two-finger scroll zooms the plot
doubleClick (a value equal to: false, âresetâ, âautosizeâ, âreset+autosizeâ; optional): double click interaction (false, âresetâ, âautosizeâ or âreset+autosizeâ)
showTips (boolean; optional): new users see some hints about interactivity
modeBarButtonsToAdd (list; optional): add mode bar button using config objects
modeBarButtons (boolean | number | string | dict | list; optional): 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
displaylogo (boolean; optional): add the plotly logo on the end of the mode bar
plotGlPixelRatio (number; optional): increase the pixel ratio for Gl plot images
topojsonURL (string; optional): URL to topojson files used in geo charts
mapboxAccessToken (boolean | number | string | dict | list; optional): 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.