Skip to content
New: Star-import, signal unraveling, Python 3.12 support, and more

#
accessors module

Pandas accessors for Plotly Express.

Note

Accessors do not utilize caching.

## attach_px_methods function

    attach_px_methods(
        cls
    )

Class decorator to attach Plotly Express methods.

## PXAccessor class

    PXAccessor(
        wrapper,
        obj=None,
        **kwargs
    )

Accessor for running Plotly Express functions.

Accessible via `pd.Series.vbt.px` and `pd.DataFrame.vbt.px`.

Usage

    >>> from vectorbtpro import *

    >>> pd.Series([1, 2, 3]).vbt.px.bar().show()

Superclasses

- AttrResolverMixin
- BaseAccessor
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PandasIndexer
- Pickleable
- Prettified
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- BaseAccessor.align()
- BaseAccessor.align_to()
- BaseAccessor.apply()
- BaseAccessor.apply_and_concat()
- BaseAccessor.apply_on_index()
- BaseAccessor.broadcast()
- BaseAccessor.broadcast_combs()
- BaseAccessor.broadcast_to()
- BaseAccessor.cls_dir
- BaseAccessor.column_only_select
- BaseAccessor.column_stack()
- BaseAccessor.combine()
- BaseAccessor.concat()
- BaseAccessor.config
- BaseAccessor.cross()
- BaseAccessor.cross()
- BaseAccessor.cross_with()
- BaseAccessor.df_accessor_cls
- BaseAccessor.drop_duplicate_levels()
- BaseAccessor.drop_levels()
- BaseAccessor.drop_redundant_levels()
- BaseAccessor.empty()
- BaseAccessor.empty_like()
- BaseAccessor.eval()
- BaseAccessor.get()
- BaseAccessor.group_select
- BaseAccessor.iloc
- BaseAccessor.indexing_func()
- BaseAccessor.indexing_kwargs
- BaseAccessor.indexing_setter_func()
- BaseAccessor.loc
- BaseAccessor.make_symmetric()
- BaseAccessor.obj
- BaseAccessor.range_only_select
- BaseAccessor.rec_state
- BaseAccessor.rename_levels()
- BaseAccessor.repeat()
- BaseAccessor.resolve_column_stack_kwargs()
- BaseAccessor.resolve_row_stack_kwargs()
- BaseAccessor.resolve_shape()
- BaseAccessor.row_stack()
- BaseAccessor.select_levels()
- BaseAccessor.self_aliases
- BaseAccessor.set()
- BaseAccessor.set_between()
- BaseAccessor.sr_accessor_cls
- BaseAccessor.stack_index()
- BaseAccessor.tile()
- BaseAccessor.to_1d_array()
- BaseAccessor.to_2d_array()
- BaseAccessor.to_dict()
- BaseAccessor.unstack_to_array()
- BaseAccessor.unstack_to_df()
- BaseAccessor.wrapper
- BaseAccessor.xloc
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- Wrapping.regroup()
- Wrapping.resample()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

Subclasses

- PXDFAccessor
- PXSRAccessor

### area method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### bar method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### bar_polar method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### box method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### choropleth method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### choropleth_mapbox method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### density_contour method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### density_heatmap method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### density_mapbox method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### ecdf method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### funnel method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### funnel_area method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### histogram method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### icicle method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### imshow method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line_3d method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line_geo method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line_mapbox method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line_polar method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### line_ternary method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### parallel_categories method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### parallel_coordinates method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### pie method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_3d method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_geo method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_mapbox method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_matrix method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_polar method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### scatter_ternary method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### strip method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### sunburst method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### timeline method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### treemap method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

### violin method

    attach_px_methods.<locals>.plot_func(
        *args,
        layout=None,
        **kwargs
    )

## PXDFAccessor class

    PXDFAccessor(
        wrapper,
        obj=None,
        **kwargs
    )

Accessor for running Plotly Express functions. For DataFrames only.

Accessible via `pd.DataFrame.vbt.px`.

Superclasses

- AttrResolverMixin
- BaseAccessor
- BaseDFAccessor
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PXAccessor
- PandasIndexer
- Pickleable
- Prettified
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- BaseAccessor.align()
- BaseAccessor.align_to()
- BaseAccessor.apply()
- BaseAccessor.apply_and_concat()
- BaseAccessor.apply_on_index()
- BaseAccessor.broadcast()
- BaseAccessor.broadcast_combs()
- BaseAccessor.broadcast_to()
- BaseAccessor.column_stack()
- BaseAccessor.combine()
- BaseAccessor.concat()
- BaseAccessor.cross()
- BaseAccessor.cross()
- BaseAccessor.cross_with()
- BaseAccessor.drop_duplicate_levels()
- BaseAccessor.drop_levels()
- BaseAccessor.drop_redundant_levels()
- BaseAccessor.empty()
- BaseAccessor.empty_like()
- BaseAccessor.eval()
- BaseAccessor.get()
- BaseAccessor.indexing_func()
- BaseAccessor.indexing_setter_func()
- BaseAccessor.make_symmetric()
- BaseAccessor.rename_levels()
- BaseAccessor.repeat()
- BaseAccessor.resolve_column_stack_kwargs()
- BaseAccessor.resolve_row_stack_kwargs()
- BaseAccessor.resolve_shape()
- BaseAccessor.row_stack()
- BaseAccessor.select_levels()
- BaseAccessor.set()
- BaseAccessor.set_between()
- BaseAccessor.stack_index()
- BaseAccessor.tile()
- BaseAccessor.to_1d_array()
- BaseAccessor.to_2d_array()
- BaseAccessor.to_dict()
- BaseAccessor.unstack_to_array()
- BaseAccessor.unstack_to_df()
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- PXAccessor.cls_dir
- PXAccessor.column_only_select
- PXAccessor.config
- PXAccessor.df_accessor_cls
- PXAccessor.group_select
- PXAccessor.iloc
- PXAccessor.indexing_kwargs
- PXAccessor.loc
- PXAccessor.obj
- PXAccessor.range_only_select
- PXAccessor.rec_state
- PXAccessor.self_aliases
- PXAccessor.sr_accessor_cls
- PXAccessor.wrapper
- PXAccessor.xloc
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- Wrapping.regroup()
- Wrapping.resample()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

## PXSRAccessor class

    PXSRAccessor(
        wrapper,
        obj=None,
        **kwargs
    )

Accessor for running Plotly Express functions. For Series only.

Accessible via `pd.Series.vbt.px`.

Superclasses

- AttrResolverMixin
- BaseAccessor
- BaseSRAccessor
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PXAccessor
- PandasIndexer
- Pickleable
- Prettified
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- BaseAccessor.align()
- BaseAccessor.align_to()
- BaseAccessor.apply()
- BaseAccessor.apply_and_concat()
- BaseAccessor.apply_on_index()
- BaseAccessor.broadcast()
- BaseAccessor.broadcast_combs()
- BaseAccessor.broadcast_to()
- BaseAccessor.column_stack()
- BaseAccessor.combine()
- BaseAccessor.concat()
- BaseAccessor.cross()
- BaseAccessor.cross()
- BaseAccessor.cross_with()
- BaseAccessor.drop_duplicate_levels()
- BaseAccessor.drop_levels()
- BaseAccessor.drop_redundant_levels()
- BaseAccessor.empty()
- BaseAccessor.empty_like()
- BaseAccessor.eval()
- BaseAccessor.get()
- BaseAccessor.indexing_func()
- BaseAccessor.indexing_setter_func()
- BaseAccessor.make_symmetric()
- BaseAccessor.rename_levels()
- BaseAccessor.repeat()
- BaseAccessor.resolve_column_stack_kwargs()
- BaseAccessor.resolve_row_stack_kwargs()
- BaseAccessor.resolve_shape()
- BaseAccessor.row_stack()
- BaseAccessor.select_levels()
- BaseAccessor.set()
- BaseAccessor.set_between()
- BaseAccessor.stack_index()
- BaseAccessor.tile()
- BaseAccessor.to_1d_array()
- BaseAccessor.to_2d_array()
- BaseAccessor.to_dict()
- BaseAccessor.unstack_to_array()
- BaseAccessor.unstack_to_df()
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- PXAccessor.cls_dir
- PXAccessor.column_only_select
- PXAccessor.config
- PXAccessor.df_accessor_cls
- PXAccessor.group_select
- PXAccessor.iloc
- PXAccessor.indexing_kwargs
- PXAccessor.loc
- PXAccessor.obj
- PXAccessor.range_only_select
- PXAccessor.rec_state
- PXAccessor.self_aliases
- PXAccessor.sr_accessor_cls
- PXAccessor.wrapper
- PXAccessor.xloc
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- Wrapping.regroup()
- Wrapping.resample()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

#### Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

- Google Analytics
- GitHub

Manage settings