plotly.express
.line_polar¶
-
plotly.express.
line_polar
(data_frame=None, r=None, theta=None, color=None, line_dash=None, hover_name=None, hover_data=None, custom_data=None, line_group=None, text=None, symbol=None, animation_frame=None, animation_group=None, category_orders=None, labels=None, color_discrete_sequence=None, color_discrete_map=None, line_dash_sequence=None, line_dash_map=None, symbol_sequence=None, symbol_map=None, markers=False, direction='clockwise', start_angle=90, line_close=False, line_shape=None, render_mode='auto', range_r=None, range_theta=None, log_r=False, title=None, template=None, width=None, height=None) → plotly.graph_objects._figure.Figure¶ In a polar line plot, each row of
data_frame
is represented as vertex of a polyline mark in polar coordinates.- Parameters
data_frame (DataFrame or array-like or dict) – This argument needs to be passed for column names (and not keyword names) to be used. Array-like and dict are transformed internally to a pandas DataFrame. Optional: if missing, a DataFrame gets constructed under the hood using the other arguments.
r (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to position marks along the radial axis in polar coordinates.theta (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to position marks along the angular axis in polar coordinates.color (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to assign color to marks.line_dash (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to assign dash-patterns to lines.hover_name (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like appear in bold in 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 pandas Series, or array_like objects or a dict with column names as keys, with values True (for default formatting) False (in order to remove this column from hover information), or a formatting string, for example ‘:.3f’ or ‘|%a’ or list-like data to appear in the hover tooltip or tuples with a bool or formatting string as first element, and list-like data to appear in hover as second element Values from these columns appear 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 pandas Series, or array_like objects Values from these columns are extra data, to be used in widgets or Dash callbacks for example. This data is not user-visible but is included in events emitted by the figure (lasso selection etc.)line_group (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to group rows ofdata_frame
into lines.text (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like appear in the figure as text labels.symbol (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to assign symbols to marks.animation_frame (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to assign marks to animation frames.animation_group (str or int or Series or array-like) – Either a name of a column in
data_frame
, or a pandas Series or array_like object. Values from this column or array_like are used to provide object-constancy across animation frames: rows with matching `animation_group`s will be treated as if they describe the same object in each frame.category_orders (dict with str keys and list of str values (default
{}
)) – By default, in Python 3.6+, the order of categorical values in axes, legends and facets depends on the order in which these values are first encountered indata_frame
(and no order is guaranteed by default in Python below 3.6). This parameter is used to force a specific ordering of values per column. The keys of this dict should correspond to column names, and the values should be lists of strings corresponding to the specific display order desired.labels (dict with str keys and str values (default
{}
)) – By default, column names are used in the figure for axis titles, legend entries and hovers. This parameter allows this to be overridden. The keys of this dict should correspond to column names, and the values should correspond to the desired label to be displayed.color_discrete_sequence (list of str) – Strings should define valid CSS-colors. When
color
is set and the values in the corresponding column are not numeric, values in that column are assigned colors by cycling throughcolor_discrete_sequence
in the order described incategory_orders
, unless the value ofcolor
is a key incolor_discrete_map
. Various useful color sequences are available in theplotly.express.colors
submodules, specificallyplotly.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 marks corresponding with specific values. Keys incolor_discrete_map
should be values in the column denoted bycolor
. Alternatively, if the values ofcolor
are valid colors, the string'identity'
may be passed to cause them to be used directly.line_dash_sequence (list of str) – Strings should define valid plotly.js dash-patterns. When
line_dash
is set, values in that column are assigned dash-patterns by cycling throughline_dash_sequence
in the order described incategory_orders
, unless the value ofline_dash
is a key inline_dash_map
.line_dash_map (dict with str keys and str values (default
{}
)) – Strings values define plotly.js dash-patterns. Used to overrideline_dash_sequences
to assign a specific dash-patterns to lines corresponding with specific values. Keys inline_dash_map
should be values in the column denoted byline_dash
. Alternatively, if the values ofline_dash
are valid line-dash names, the string'identity'
may be passed to cause them to be used directly.symbol_sequence (list of str) – Strings should define valid plotly.js symbols. When
symbol
is set, values in that column are assigned symbols by cycling throughsymbol_sequence
in the order described incategory_orders
, unless the value ofsymbol
is a key insymbol_map
.symbol_map (dict with str keys and str values (default
{}
)) – String values should define plotly.js symbols Used to overridesymbol_sequence
to assign a specific symbols to marks corresponding with specific values. Keys insymbol_map
should be values in the column denoted bysymbol
. Alternatively, if the values ofsymbol
are valid symbol names, the string'identity'
may be passed to cause them to be used directly.markers (boolean (default
False
)) – IfTrue
, markers are shown on lines.direction (str) – One of ‘
counterclockwise'
or'clockwise'
. Default is'clockwise'
Sets the direction in which increasing values of the angular axis are drawn.start_angle (int (default
90
)) – Sets start angle for the angular axis, with 0 being due east and 90 being due north.line_close (boolean (default
False
)) – IfTrue
, an extra line segment is drawn between the first and last point.line_shape (str (default
'linear'
)) – One of'linear'
,'spline'
,'hv'
,'vh'
,'hvh'
, or'vhv'
render_mode (str) – One of
'auto'
,'svg'
or'webgl'
, default'auto'
Controls the browser API used to draw marks.'svg'
is appropriate for figures of less than 1000 data points, and will allow for fully-vectorized output.'webgl'
is likely necessary for acceptable performance above 1000 points but rasterizes part of the output.'auto'
uses heuristics to choose the mode.range_r (list of two numbers) – If provided, overrides auto-scaling on the radial axis in polar coordinates.
range_theta (list of two numbers) – If provided, overrides auto-scaling on the angular axis in polar coordinates.
log_r (boolean (default
False
)) – IfTrue
, the radial axis is log-scaled in polar coordinates.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) or definition.
width (int (default
None
)) – The figure width in pixels.height (int (default
None
)) – The figure height in pixels.
- Returns
- Return type