datasim.PlotOptions

class datasim.PlotOptions(title: str | None = None, name: str | None = None, auto_name: bool = False, aggregate_only: bool = False, plot_type: PlotType = PlotType.none, legend_x: str | None = '', legend_y: str | None = '', secondary_y: bool = False, color: str | None = None, color_continuous_scale: Any | None = None, color_continuous_midpoint: Any | None = None, color_discrete_map: Any | None = None, color_discrete_sequence: Any | None = None, range_color: Any | None = None, hover_name: Any | None = None, hover_data: Any | None = None, custom_data: Any | None = None, text: Any | None = None, facet_row: Any | None = None, facet_col: Any | None = None, facet_row_spacing: Any | None = None, facet_col_spacing: Any | None = None, facet_col_wrap: int = 0, error_x: Any | None = None, error_y: Any | None = None, error_x_minus: Any | None = None, error_y_minus: Any | None = None, category_orders: Any | None = None, labels: Any | None = None, orientation: Any | None = None, opacity: Any | None = None, log_x: bool = False, log_y: bool = False, range_x: Any | None = None, range_y: Any | None = None, pattern_shape: Any | None = None, pattern_shape_map: Any | None = None, pattern_shape_sequence: Any | None = None, base: Any | None = None, barmode: str = 'relative', text_auto: bool = False, template: Any | None = None, width: Any | None = None, height: Any | None = None, animation_frame: Any | None = None, animation_group: Any | None = None, symbol: Any | None = None, symbol_map: Any | None = None, symbol_sequence: Any | None = None, render_mode: str = 'auto', line_dash: Any | None = None, line_dash_map: Any | None = None, line_dash_sequence: Any | None = None, line_group: Any | None = None, line_shape: Any | None = None, markers: bool = False, hole: Any | None = None, size: Any | None = None, size_max: Any | None = None, marginal_x: Any | None = None, marginal_y: Any | None = None, trendline: Any | None = None, trendline_options: Any | None = None, trendline_scope: str = 'trace', trendline_color_override: Any | None = None)

Defines the options for plotting a Data.

__init__(title: str | None = None, name: str | None = None, auto_name: bool = False, aggregate_only: bool = False, plot_type: PlotType = PlotType.none, legend_x: str | None = '', legend_y: str | None = '', secondary_y: bool = False, color: str | None = None, color_continuous_scale: Any | None = None, color_continuous_midpoint: Any | None = None, color_discrete_map: Any | None = None, color_discrete_sequence: Any | None = None, range_color: Any | None = None, hover_name: Any | None = None, hover_data: Any | None = None, custom_data: Any | None = None, text: Any | None = None, facet_row: Any | None = None, facet_col: Any | None = None, facet_row_spacing: Any | None = None, facet_col_spacing: Any | None = None, facet_col_wrap: int = 0, error_x: Any | None = None, error_y: Any | None = None, error_x_minus: Any | None = None, error_y_minus: Any | None = None, category_orders: Any | None = None, labels: Any | None = None, orientation: Any | None = None, opacity: Any | None = None, log_x: bool = False, log_y: bool = False, range_x: Any | None = None, range_y: Any | None = None, pattern_shape: Any | None = None, pattern_shape_map: Any | None = None, pattern_shape_sequence: Any | None = None, base: Any | None = None, barmode: str = 'relative', text_auto: bool = False, template: Any | None = None, width: Any | None = None, height: Any | None = None, animation_frame: Any | None = None, animation_group: Any | None = None, symbol: Any | None = None, symbol_map: Any | None = None, symbol_sequence: Any | None = None, render_mode: str = 'auto', line_dash: Any | None = None, line_dash_map: Any | None = None, line_dash_sequence: Any | None = None, line_group: Any | None = None, line_shape: Any | None = None, markers: bool = False, hole: Any | None = None, size: Any | None = None, size_max: Any | None = None, marginal_x: Any | None = None, marginal_y: Any | None = None, trendline: Any | None = None, trendline_options: Any | None = None, trendline_scope: str = 'trace', trendline_color_override: Any | None = None)

Create plot options.

Parameters:

  • title (Optional[str], optional) – Title of the plot. Defaults to None.

  • name (Optional[str], optional) – Name of the plot source/series/trace. Defaults to None.

  • auto_name (bool, optional) – Auto name the plot source/series/trace based on the source object. Defaults to False.

  • aggregate_only (bool, optional) – Only make aggregate plots for this data. Defaults to False.

  • plot_type (Optional[PlotType], optional) – TODO. Defaults to None.

  • legend_x (str, optional) – TODO. Defaults to “”.

  • legend_y (str, optional) – TODO. Defaults to “”.

  • secondary_y (bool, optional) – TODO. Defaults to False.

  • color (Optional[str], optional) – TODO. Defaults to None.

  • color_continuous_scale (Optional[Any], optional) – TODO. Defaults to None.

  • color_continuous_midpoint (Optional[Any], optional) – TODO. Defaults to None.

  • color_discrete_map (Optional[Any], optional) – TODO. Defaults to None.

  • color_discrete_sequence (Optional[Any], optional) – TODO. Defaults to None.

  • range_color (Optional[Any], optional) – TODO. Defaults to None.

  • hover_name (Optional[Any], optional) – TODO. Defaults to None.

  • hover_data (Optional[Any], optional) – TODO. Defaults to None.

  • custom_data (Optional[Any], optional) – TODO. Defaults to None.

  • text (Optional[Any], optional) – TODO. Defaults to None.

  • facet_row (Optional[Any], optional) – TODO. Defaults to None.

  • facet_col (Optional[Any], optional) – TODO. Defaults to None.

  • facet_row_spacing (Optional[Any], optional) – TODO. Defaults to None.

  • facet_col_spacing (Optional[Any], optional) – TODO. Defaults to None.

  • facet_col_wrap (int, optional) – TODO. Defaults to 0.

  • error_x (Optional[Any], optional) – TODO. Defaults to None.

  • error_y (Optional[Any], optional) – TODO. Defaults to None.

  • error_x_minus (Optional[Any], optional) – TODO. Defaults to None.

  • error_y_minus (Optional[Any], optional) – TODO. Defaults to None.

  • category_orders (Optional[Any], optional) – TODO. Defaults to None.

  • labels (Optional[Any], optional) – TODO. Defaults to None.

  • orientation (Optional[Any], optional) – TODO. Defaults to None.

  • opacity (Optional[Any], optional) – TODO. Defaults to None.

  • log_x (bool, optional) – TODO. Defaults to False.

  • log_y (bool, optional) – TODO. Defaults to False.

  • range_x (Optional[Any], optional) – TODO. Defaults to None.

  • range_y (Optional[Any], optional) – TODO. Defaults to None.

  • pattern_shape (Optional[Any], optional) – TODO. Defaults to None.

  • pattern_shape_map (Optional[Any], optional) – TODO. Defaults to None.

  • pattern_shape_sequence (Optional[Any], optional) – TODO. Defaults to None.

  • base (Optional[Any], optional) – TODO. Defaults to None.

  • barmode (str, optional) – TODO. Defaults to “relative”.

  • text_auto (bool, optional) – TODO. Defaults to False.

  • template (Optional[Any], optional) – TODO. Defaults to None.

  • width (Optional[Any], optional) – TODO. Defaults to None.

  • height (Optional[Any], optional) – TODO. Defaults to None.

  • animation_frame (Optional[Any], optional) – TODO. Defaults to None.

  • animation_group (Optional[Any], optional) – TODO. Defaults to None.

  • symbol (Optional[Any], optional) – TODO. Defaults to None.

  • symbol_map (Optional[Any], optional) – TODO. Defaults to None.

  • symbol_sequence (Optional[Any], optional) – TODO. Defaults to None.

  • render_mode (str, optional) – TODO. Defaults to “auto”.

  • line_dash (Optional[Any], optional) – TODO. Defaults to None.

  • line_dash_map (Optional[Any], optional) – TODO. Defaults to None.

  • line_dash_sequence (Optional[Any], optional) – TODO. Defaults to None.

  • line_group (Optional[Any], optional) – TODO. Defaults to None.

  • line_shape (Optional[Any], optional) – TODO. Defaults to None.

  • markers (bool, optional) – TODO. Defaults to False.

  • hole (Optional[Any], optional) – TODO. Defaults to None.

  • size (Optional[Any], optional) – TODO. Defaults to None.

  • size_max (Optional[Any], optional) – TODO. Defaults to None.

  • marginal_x (Optional[Any], optional) – TODO. Defaults to None.

  • marginal_y (Optional[Any], optional) – TODO. Defaults to None.

  • trendline (Optional[Any], optional) – TODO. Defaults to None.

  • trendline_options (Optional[Any], optional) – TODO. Defaults to None.

  • trendline_scope (str, optional) – TODO. Defaults to “trace”.

  • trendline_color_override (Optional[Any], optional) – TODO. Defaults to None.

Methods

__init__([title, name, auto_name, ...])

Create plot options.

Attributes

title

name

auto_name

aggregate_only

plot_type

legend_x

legend_y

secondary_y

color

color_continuous_scale

color_continuous_midpoint

color_discrete_map

color_discrete_sequence

range_color

hover_name

hover_data

custom_data

text

facet_row

facet_col

facet_row_spacing

facet_col_spacing

facet_col_wrap

error_x

error_y

error_x_minus

error_y_minus

category_orders

labels

orientation

opacity

log_x

log_y

range_x

range_y

pattern_shape

pattern_shape_map

pattern_shape_sequence

base

barmode

text_auto

template

width

height

animation_frame

animation_group

symbol

symbol_map

symbol_sequence

render_mode

line_dash

line_dash_map

line_dash_sequence

line_group

line_shape

markers

hole

size

size_max

marginal_x

marginal_y

trendline

trendline_options

trendline_scope

trendline_color_override