plotly.express.sunburst — 5.22.0 documentation (2024)

data_frame (DataFrame or array-like or dict) – This argument needs to be passed for column names (and not keywordnames) to be used. Array-like and dict are transformed internally to apandas DataFrame. Optional: if missing, a DataFrame gets constructedunder the hood using the other arguments.

names (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used aslabels for sectors.

values (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toset values associated to sectors.

parents (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used asparents in sunburst and treemap charts.

path (list of str or int, or Series or array-like) – Either names of columns in data_frame, or pandas Series, orarray_like objects List of columns names or columns of a rectangulardataframe defining the hierarchy of sectors, from root to leaves. Anerror is raised if path AND ids or parents is passed

ids (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toset ids of sectors

color (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like are used toassign color to marks.

color_continuous_scale (list of str) – Strings should define valid CSS-colors This list is used to build acontinuous color scale when the column denoted by color containsnumeric data. Various useful color scales are available in theplotly.express.colors submodules, specificallyplotly.express.colors.sequential, plotly.express.colors.divergingand plotly.express.colors.cyclical.

range_color (list of two numbers) – If provided, overrides auto-scaling on the continuous color scale.

color_continuous_midpoint (number (default None)) – If set, computes the bounds of the continuous color scale to have thedesired midpoint. Setting this value is recommended when usingplotly.express.colors.diverging color scales as the inputs tocolor_continuous_scale.

color_discrete_sequence (list of str) – Strings should define valid CSS-colors. When color is set and thevalues in the corresponding column are not numeric, values in thatcolumn are assigned colors by cycling through color_discrete_sequencein the order described in category_orders, unless the value ofcolor is a key in color_discrete_map. Various useful colorsequences are available in the plotly.express.colors submodules,specifically plotly.express.colors.qualitative.

color_discrete_map (dict with str keys and str values (default {})) – String values should define valid CSS-colors Used to overridecolor_discrete_sequence to assign a specific colors to markscorresponding with specific values. Keys in color_discrete_map shouldbe values in the column denoted by color. Alternatively, if thevalues of color are valid colors, the string 'identity' may bepassed to cause them to be used directly.

hover_name (str or int or Series or array-like) – Either a name of a column in data_frame, or a pandas Series orarray_like object. Values from this column or array_like appear in boldin the hover tooltip.

hover_data (str, or list of str or int, or Series or array-like, or dict) – Either a name or list of names of columns in data_frame, or pandasSeries, or array_like objects or a dict with column names as keys, withvalues True (for default formatting) False (in order to remove thiscolumn from hover information), or a formatting string, for example‘:.3f’ or ‘|%a’ or list-like data to appear in the hover tooltip ortuples with a bool or formatting string as first element, and list-likedata to appear in hover as second element Values from these columnsappear as extra data in the hover tooltip.

custom_data (str, or list of str or int, or Series or array-like) – Either name or list of names of columns in data_frame, or pandasSeries, or array_like objects Values from these columns are extra data,to be used in widgets or Dash callbacks for example. This data is notuser-visible but is included in events emitted by the figure (lassoselection etc.)

labels (dict with str keys and str values (default {})) – By default, column names are used in the figure for axis titles, legendentries and hovers. This parameter allows this to be overridden. Thekeys of this dict should correspond to column names, and the valuesshould correspond to the desired label to be displayed.

title (str) – The figure title.

template (str or dict or plotly.graph_objects.layout.Template instance) – The figure template name (must be a key in plotly.io.templates) ordefinition.

width (int (default None)) – The figure width in pixels.

height (int (default None)) – The figure height in pixels.

branchvalues (str) – ‘total’ or ‘remainder’ Determines how the items in values are summed.Whenset to ‘total’, items in values are taken to be valueof all itsdescendants. When set to ‘remainder’, itemsin values corresponding tothe root and the branches:sectors are taken to be the extra part notpart of thesum of the values at their leaves.

maxdepth (int) – Positive integer Sets the number of rendered sectors from any givenlevel. Set maxdepth to -1 to render all thelevels in the hierarchy.