holoviews.mpl Package


mpl Package

holoviews.plotting.mpl. set_style ( key ) [source]

Select a style by name, e.g. set_style(‘default’). To revert to the previous style use the key ‘unset’ or False.


annotation Module

Inheritance diagram of holoviews.plotting.mpl.annotation

class holoviews.plotting.mpl.annotation. AnnotationPlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.element.ElementPlot

AnnotationPlot handles the display of all annotation elements.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.annotation. ArrowPlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.annotation.AnnotationPlot

Draw an arrow using the information supplied to the Arrow annotation

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.annotation. HLinePlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.annotation.AnnotationPlot

Draw a horizontal line on the axis

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

draw_annotation ( axis , position , opts ) [source]

Draw a horizontal line on the axis

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.annotation. SplinePlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.annotation.AnnotationPlot

Draw the supplied Spline annotation (see Spline docstring)

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.annotation. TextPlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.annotation.AnnotationPlot

Draw the Text annotation object

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.annotation. VLinePlot ( annotation , **params ) [source]

Bases: holoviews.plotting.mpl.annotation.AnnotationPlot

Draw a vertical line on the axis

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.


chart Module

Inheritance diagram of holoviews.plotting.mpl.chart

class holoviews.plotting.mpl.chart. BoxPlot ( element , **params ) [source]

Bases: holoviews.plotting.mpl.chart.ChartPlot

BoxPlot plots the ErrorBar Element type and supporting both horizontal and vertical error bars via the ‘horizontal’ plot option.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. CurvePlot ( element , **params ) [source]

Bases: holoviews.plotting.mpl.chart.ChartPlot

CurvePlot can plot Curve and ViewMaps of Curve, which can be displayed as a single frame or animation. Axes, titles and legends are automatically generated from dim_info.

If the dimension is set to cyclic in the dim_info it will rotate the curve so that minimum y values are at the minimum x value to make the plots easier to interpret.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean relative_labels ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
If plotted quantity is cyclic and center_cyclic is enabled, will compute tick labels relative to the center.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean autotick ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to let matplotlib automatically compute tick marks or to allow the user to control tick marks.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param ObjectSelector interpolation ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=linear, instantiate=False, objects=[u’linear’, u’steps-mid’, u’steps-pre’, u’steps-post’], pickle_default_value=True, precedence=None, readonly=False )
Defines how the samples of the Curve are interpolated, default is ‘linear’, other options include ‘steps-mid’, ‘steps-pre’ and ‘steps-post’.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Enable axis grid.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. ErrorPlot ( element , **params ) [source]

Bases: holoviews.plotting.mpl.chart.ChartPlot

ErrorPlot plots the ErrorBar Element type and supporting both horizontal and vertical error bars via the ‘horizontal’ plot option.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. HistogramPlot ( histograms , **params ) [source]

Bases: holoviews.plotting.mpl.chart.ChartPlot

HistogramPlot can plot DataHistograms and ViewMaps of DataHistograms, which can be displayed as a single frame or animation.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. PointPlot ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.chart.ChartPlot , holoviews.plotting.mpl.element.ColorbarPlot

Note that the ‘cmap’, ‘vmin’ and ‘vmax’ style arguments control how point magnitudes are rendered to different colors.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param ClassSelector color_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the color will the drawn
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Number scaling_factor ( allow_None=False, bounds=(0, None), constant=False, default=1, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Scaling factor which is applied to either the width or area of each point, depending on the value of scaling_method .
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param ObjectSelector scaling_method ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=area, instantiate=False, objects=[u’width’, u’area’], pickle_default_value=True, precedence=None, readonly=False )
Determines whether the scaling_factor should be applied to the width or area of each point (default: “area”).
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a colorbar.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Callable size_fn ( allow_None=False, constant=False, default=<ufunc ‘absolute’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Function applied to size values before applying scaling, to remove values lower than zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw grid lines at the tick positions.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param ClassSelector size_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the sizes will the drawn.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
size_fn = <ufunc 'absolute'>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. SpreadPlot ( element , **params ) [source]

Bases: holoviews.plotting.mpl.chart.AreaPlot

SpreadPlot plots the Spread Element type.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart. VectorFieldPlot ( *args , **params ) [source]

Bases: holoviews.plotting.mpl.element.ColorbarPlot

Renders vector fields in sheet coordinates. The vectors are expressed in polar coordinates and may be displayed according to angle alone (with some common, arbitrary arrow length) or may be true polar vectors.

The color or magnitude can be mapped onto any dimension using the color_index and size_index.

The length of the arrows is controlled by the ‘scale’ style option. The scaling of the arrows may also be controlled via the normalize_lengths and rescale_lengths plot option, which will normalize the lengths to a maximum of 1 and scale them according to the minimum distance respectively.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param ClassSelector color_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the color will the drawn
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param Boolean arrow_heads ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to draw arrow heads. If arrowheads are enabled, they may be customized with the ‘headlength’ and ‘headaxislength’ style options.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a colorbar.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean rescale_lengths ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether the lengths will be rescaled to take into account the smallest non-zero distance between two vectors.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Boolean normalize_lengths ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to normalize vector magnitudes automatically. If False, it will be assumed that the lengths have already been correctly normalized.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param ClassSelector size_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the sizes will the drawn.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.


chart3d Module

Inheritance diagram of holoviews.plotting.mpl.chart3d

class holoviews.plotting.mpl.chart3d. Plot3D ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.element.ColorbarPlot

Plot3D provides a common baseclass for mplot3d based plots.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param ObjectSelector projection ( allow_None=True, check_on_set=True, compute_default_fn=None, constant=False, default=3d, instantiate=False, objects=[‘3d’], pickle_default_value=True, precedence=None, readonly=False )
The projection of the matplotlib axis.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Integer azimuth ( allow_None=False, bounds=(-180, 180), constant=False, default=-60, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Azimuth angle in the x,y plane.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a colorbar.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param String bgcolor ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default=white, instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Background color of the axis.
param Boolean disable_axes ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Disable all axes.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param ObjectSelector zaxis ( allow_None=False, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Integer elevation ( allow_None=False, bounds=(0, 180), constant=False, default=30, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Elevation angle in the z-axis.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’, ‘z’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’, ‘y’ and ‘z’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a grid in the figure.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param Integer distance ( allow_None=False, bounds=(7, 15), constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Distance from the plotted object.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart3d. Scatter3DPlot ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.chart3d.Plot3D , holoviews.plotting.mpl.chart.PointPlot

Subclass of PointPlot allowing plotting of Points on a 3D axis, also allows mapping color and size onto a particular Dimension of the data.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param ObjectSelector projection ( allow_None=True, check_on_set=True, compute_default_fn=None, constant=False, default=3d, instantiate=False, objects=[‘3d’], pickle_default_value=True, precedence=None, readonly=False )
The projection of the matplotlib axis.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param ClassSelector color_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the color will the drawn
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Integer azimuth ( allow_None=False, bounds=(-180, 180), constant=False, default=-60, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Azimuth angle in the x,y plane.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Number scaling_factor ( allow_None=False, bounds=(0, None), constant=False, default=1, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Scaling factor which is applied to either the width or area of each point, depending on the value of scaling_method .
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param ObjectSelector scaling_method ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=area, instantiate=False, objects=[u’width’, u’area’], pickle_default_value=True, precedence=None, readonly=False )
Determines whether the scaling_factor should be applied to the width or area of each point (default: “area”).
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a colorbar.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param String bgcolor ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default=white, instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Background color of the axis.
param Boolean disable_axes ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Disable all axes.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param ObjectSelector zaxis ( allow_None=False, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Integer elevation ( allow_None=False, bounds=(0, 180), constant=False, default=30, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Elevation angle in the z-axis.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Callable size_fn ( allow_None=False, constant=False, default=<ufunc ‘absolute’>, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Function applied to size values before applying scaling, to remove values lower than zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’, ‘z’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’, ‘y’ and ‘z’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a grid in the figure.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param Integer distance ( allow_None=False, bounds=(7, 15), constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Distance from the plotted object.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param ClassSelector size_index ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Index of the dimension from which the sizes will the drawn.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
size_fn = <ufunc 'absolute'>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart3d. SurfacePlot ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.chart3d.Plot3D

Plots surfaces wireframes and contours in 3D space. Provides options to switch the display type via the plot_type parameter has support for a number of styling options including strides and colors.

param ObjectSelector plot_type ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=surface, instantiate=False, objects=[‘surface’, ‘wireframe’, ‘contour’], pickle_default_value=True, precedence=None, readonly=False )
Specifies the type of visualization for the Surface object. Valid values are ‘surface’, ‘wireframe’ and ‘contour’.
param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param ObjectSelector projection ( allow_None=True, check_on_set=True, compute_default_fn=None, constant=False, default=3d, instantiate=False, objects=[‘3d’], pickle_default_value=True, precedence=None, readonly=False )
The projection of the matplotlib axis.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Integer azimuth ( allow_None=False, bounds=(-180, 180), constant=False, default=-60, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Azimuth angle in the x,y plane.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to add a colorbar to the plot.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param String bgcolor ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default=white, instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Background color of the axis.
param Boolean disable_axes ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Disable all axes.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param ObjectSelector zaxis ( allow_None=False, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Integer elevation ( allow_None=False, bounds=(0, 180), constant=False, default=30, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Elevation angle in the z-axis.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’, ‘z’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’, ‘y’ and ‘z’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a grid in the figure.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param Integer distance ( allow_None=False, bounds=(7, 15), constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Distance from the plotted object.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.

class holoviews.plotting.mpl.chart3d. TrisurfacePlot ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.chart3d.Plot3D

Plots a trisurface given a Trisurface element, containing X, Y and Z coordinates.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param ObjectSelector projection ( allow_None=True, check_on_set=True, compute_default_fn=None, constant=False, default=3d, instantiate=False, objects=[‘3d’], pickle_default_value=True, precedence=None, readonly=False )
The projection of the matplotlib axis.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Integer azimuth ( allow_None=False, bounds=(-180, 180), constant=False, default=-60, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Azimuth angle in the x,y plane.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to add a colorbar to the plot.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param String bgcolor ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default=white, instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Background color of the axis.
param Boolean disable_axes ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Disable all axes.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param ObjectSelector zaxis ( allow_None=False, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Integer elevation ( allow_None=False, bounds=(0, 180), constant=False, default=30, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Elevation angle in the z-axis.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’, ‘z’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’, ‘y’ and ‘z’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a grid in the figure.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value. The min, max or NaN color may specify an RGB(A) color as a color hex string of the form #FFFFFF or #FFFFFFFF or a length 3 or length 4 tuple specifying values in the range 0-1 or a named HTML color.
param Integer distance ( allow_None=False, bounds=(7, 15), constant=False, default=10, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Distance from the plotted object.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=fixed, instantiate=False, objects=[‘fixed’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param Parameter cbar_ticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along colorbar-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Number cbar_width ( allow_None=False, bounds=None, constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Width of the colorbar as a fraction of the main plot
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_extents ( view , ranges )

Gets the extents for the axes from the current View. The globally computed ranges can optionally override the extents.

get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.


comms Module

Inheritance diagram of holoviews.plotting.mpl.comms

class holoviews.plotting.mpl.comms. NbAggCommSocket ( manager , target=None ) [source]

Bases: matplotlib.backends.backend_nbagg.CommSocket

NbAggCommSocket subclasses the matplotlib CommSocket allowing the opening of a comms channel to be delayed until the plot is displayed.

class holoviews.plotting.mpl.comms. NbAggJupyterComm ( plot , id=None , on_msg=None ) [source]

Bases: holoviews.plotting.comms.JupyterComm

Wraps a NbAggCommSocket to provide a consistent API to work for updating nbagg plots.

decode ( msg )

Decodes messages following Jupyter messaging protocol. If JSON decoding fails data is assumed to be a regular string.


element Module

Inheritance diagram of holoviews.plotting.mpl.element

class holoviews.plotting.mpl.element. OverlayPlot ( overlay , ranges=None , **params ) [source]

Bases: holoviews.plotting.mpl.element.LegendPlot , holoviews.plotting.plot.GenericOverlayPlot

OverlayPlot supports compositors processing of Overlays across maps.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean batched ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot Elements NdOverlay in a batched plotting call if possible. Disables legends and zorder may not be preserved.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param ObjectSelector legend_position ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=inner, instantiate=False, objects=[‘inner’, ‘right’, ‘bottom’, ‘top’, ‘left’, ‘best’, ‘top_right’, ‘top_left’, ‘bottom_left’, ‘bottom_right’], pickle_default_value=True, precedence=None, readonly=False )
Allows selecting between a number of predefined legend position options. The predefined options may be customized in the legend_specs class attribute. By default, ‘inner’, ‘right’, ‘bottom’, ‘top’, ‘left’, ‘best’, ‘top_right’, ‘top_left’, ‘bottom_right’ and ‘bottom_left’ are supported.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Integer legend_limit ( allow_None=False, bounds=None, constant=False, default=25, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Number of rendered glyphs before legends are disabled.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Integer style_grouping ( allow_None=False, bounds=None, constant=False, default=2, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
The length of the type.group.label spec that will be used to group Elements into style groups, i.e. a style_grouping value of 1 will group just by type, a value of 2 will group by type and group and a value of 3 will group by the full specification.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Integer legend_cols ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Number of legend columns in the legend.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Parameter yticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , element , ranges , style )

Update the elements of the plot.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.


pandas Module

Inheritance diagram of holoviews.plotting.mpl.pandas

class holoviews.plotting.mpl.pandas. DFrameViewPlot ( view , **params ) [source]

Bases: holoviews.plotting.mpl.element.ElementPlot

DFramePlot provides a wrapper around Pandas dataframe plots. It takes a single DataFrameView or DFrameMap as input and plots it using the plotting command selected via the plot_type.

The plot_options specifies the valid options to be supplied to the selected plot_type via options.style_opts.

param ObjectSelector plot_type ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=scatter_matrix, instantiate=False, objects=[‘plot’, ‘boxplot’, ‘hist’, ‘scatter_matrix’, ‘autocorrelation_plot’], pickle_default_value=True, precedence=None, readonly=False )
Selects which Pandas plot type to use, valid options include: ‘plot’, ‘boxplot’, ‘hist’, ‘scatter_matrix’ and ‘autocorrelation_plot’.
param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Aspect ratio defaults to square, ‘equal’ or numeric values are also supported.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Number xticks ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
By default we don’t mess with Pandas based tickmarks
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param ObjectSelector yaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=left, instantiate=False, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the yaxis, bare options allow suppressing all axis labels including ticks and ylabel. Valid options are ‘left’, ‘right’, ‘bare’ ‘left-bare’ and ‘right-bare’.
param Boolean fig_latex ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to use LaTeX text in the overall figure.
param NumericTuple fig_bounds ( allow_None=False, constant=False, default=(0.15, 0.15, 0.85, 0.85), instantiate=False, length=4, pickle_default_value=True, precedence=None, readonly=False )
The bounds of the overall figure as a 4-tuple of the form (left, bottom, right, top), defining the size of the border around the subplots.
param HookList final_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter zticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param String title_format ( allow_None=False, basestring=<type ‘basestring’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
param Number yticks ( allow_None=True, bounds=None, constant=False, default=None, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
By default we don’t mess with Pandas based tickmarks
param HookList initial_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called before plotting the data onto the axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
anim ( start=0 , stop=None , fps=30 )

Method to return a matplotlib animation. The start and stop frames may be specified as well as the fps.

compute_ranges ( obj , key , ranges )

Given an object, a specific key and the normalization options this method will find the specified normalization options on the appropriate OptionTree, group the elements according to the selected normalization option (i.e. either per frame or over the whole animation) and finally compute the dimension ranges in each group. The new set of ranges is returned.

debug ( msg , *args , **kw )

Print msg merged with args as a debugging statement.

See Python’s logging module for details of message formatting.

defaults ( )

Return {parameter_name:parameter.default} for all non-constant Parameters.

Note that a Parameter for which instantiate==True has its default instantiated.

force_new_dynamic_value = <functools.partial object>
get_param_values ( onlychanged=False )

Return a list of name,value pairs for all Parameters of this object.

If onlychanged is True, will only return values that are not equal to the default value.

get_value_generator = <functools.partial object>
get_zorder ( overlay , key , el )

Computes the z-order of element in the NdOverlay taking into account possible batching of elements.

init_artists ( ax , plot_args , plot_kwargs )

Initializes the artist based on the plot method declared on the plot.

init_comm ( )

Initializes comm and attaches streams.

inspect_value = <functools.partial object>
matches ( spec )

Matches a specification against the current Plot.

message ( msg , *args , **kw )

Print msg merged with args as a message.

See Python’s logging module for details of message formatting.

params ( parameter_name=None )

Return the Parameters of this class as the dictionary {name: parameter_object}

Includes Parameters from this class and its superclasses.

pprint ( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' )

(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.

print_param_defaults ( )

Print the default values of all cls’s Parameters.

print_param_values ( )

Print the values of all this object’s Parameters.

push ( )

Pushes updated plot data via the Comm.

refresh ( **kwargs )

Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.

script_repr ( imports=[] , prefix=' ' )

Variant of __repr__ designed for generating a runnable script.

set_default ( param_name , value )

Set the default value of param_name.

Equivalent to setting param_name on the class.

set_dynamic_time_fn = <functools.partial object>
set_param = <functools.partial object>
state_pop ( )

Restore the most recently saved state.

See state_push() for more details.

state_push ( )

Save this instance’s state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects’ state.

teardown_handles ( )

If no custom update_handles method is supplied this method is called to tear down any previous handles before replacing them.

traverse ( fn=None , specs=None , full_breadth=True )

Traverses any nested DimensionedPlot returning a list of all plots that match the specs. The specs should be supplied as a list of either Plot types or callables, which should return a boolean given the plot class.

update_handles ( key , axis , view , ranges , style ) [source]

Update the plot for an animation.

verbose ( msg , *args , **kw )

Print msg merged with args as a verbose message.

See Python’s logging module for details of message formatting.

warning ( msg , *args , **kw )

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

See Python’s logging module for details of message formatting.


path Module

Inheritance diagram of holoviews.plotting.mpl.path

class holoviews.plotting.mpl.path. PolygonPlot ( *args , **kwargs ) [source]

Bases: holoviews.plotting.mpl.element.ColorbarPlot

PolygonPlot draws the polygon paths in the supplied Polygons object. If the Polygon has an associated value the color of Polygons will be drawn from the supplied cmap, otherwise the supplied facecolor will apply. Facecolor also determines the color for non-finite values.

param Integer xrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the xticks.
param Parameter projection ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The projection of the plot axis, default of None is equivalent to 2D plot, ‘3d’ and ‘polar’ are also supported by matplotlib by default. May also supply a custom projection that is either a matplotlib projection type or implements the _as_mpl_axes method.
param String sublabel_format ( allow_None=True, basestring=<type ‘basestring’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Allows labeling the subaxes in each plot with various formatters including {Alpha}, {alpha}, {numeric} and {roman}.
param Boolean logz ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean logx ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the x-axis of the Chart.
param NumericTuple sublabel_position ( allow_None=False, constant=False, default=(-0.35, 0.85), instantiate=False, length=2, pickle_default_value=True, precedence=None, readonly=False )
Position relative to the plot for placing the optional subfigure label.
param Boolean show_legend ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show legend for the plot.
param HookList finalize_hooks ( allow_None=False, bounds=(0, None), constant=False, default=[], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Optional list of hooks called when finalizing an axis. The hook is passed the plot object and the displayed object, other plotting handles can be accessed via plot.handles.
param Parameter aspect ( allow_None=False, constant=False, default=square, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The aspect ratio mode of the plot. By default, a plot may select its own appropriate aspect ratio but sometimes it may be necessary to force a square aspect ratio (e.g. to display the plot as an element of a grid). The modes ‘auto’ and ‘equal’ correspond to the axis modes of the same name in matplotlib, a numeric value may also be passed.
param Boolean invert_yaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot y-axis.
param Boolean invert_xaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot x-axis.
param Boolean normalize ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
param Boolean colorbar ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to draw a colorbar.
param Boolean apply_extents ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply extent overrides on the Elements
param Integer zrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the zticks.
param ClassSelector bgcolor ( allow_None=True, constant=False, default=None, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
If set bgcolor overrides the background color of the axis.
param ObjectSelector invert_axes ( allow_None=None, check_on_set=False, compute_default_fn=None, constant=False, default=False, instantiate=False, objects=[], pickle_default_value=True, precedence=None, readonly=False )
Inverts the axes of the plot. Note that this parameter may not always be respected by all plots but should be respected by adjoined plots when appropriate.
param Parameter xticks ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations and labels or a matplotlib tick locator object. If set to None default matplotlib ticking behavior is applied.
param Boolean apply_ranges ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to compute the plot bounds from the data itself.
param Boolean zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the z-axis.
param ObjectSelector xaxis ( allow_None=None, check_on_set=True, compute_default_fn=None, constant=False, default=bottom, instantiate=False, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None], pickle_default_value=True, precedence=None, readonly=False )
Whether and where to display the xaxis, bare options allow suppressing all axis labels including ticks and xlabel. Valid options are ‘top’, ‘bottom’, ‘bare’, ‘top-bare’ and ‘bottom-bare’.
param Parameter fig_inches ( allow_None=False, constant=False, default=4, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
The overall matplotlib figure size in inches. May be set as an integer in which case it will be used to autocompute a size. Alternatively may be set with an explicit tuple or list, in which case it will be applied directly after being scaled by fig_size. If either the width or height is set to None, it will be computed automatically.
param Number fig_alpha ( allow_None=False, bounds=(0, 1), constant=False, default=1.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Alpha of the overall figure background.
param Boolean show_frame ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether or not to show a complete frame around the plot.
param Number cbar_padding ( allow_None=False, bounds=None, constant=False, default=0.01, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Padding between colorbar and other plots.
param Boolean apply_ticks ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply custom ticks.
param Dict fig_rcparams ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
matplotlib rc parameters to apply to the overall figure.
param Boolean symmetric ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to make the colormap symmetric around zero.
param Integer yrotation ( allow_None=False, bounds=(0, 360), constant=False, default=0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Rotation angle of the yticks.
param Number fig_size ( allow_None=False, bounds=(1, None), constant=False, default=100.0, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size relative to the supplied overall fig_inches in percent.
param Parameter fontsize ( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Specifies various fontsizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys reverts to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the fontsize of both ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.
param List labelled ( allow_None=False, bounds=(0, None), constant=False, default=[‘x’, ‘y’], instantiate=True, pickle_default_value=True, precedence=None, readonly=False )
Whether to plot the ‘x’ and ‘y’ labels.
param Boolean show_title ( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to display the plot title.
param Boolean show_grid ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to show a Cartesian grid on the plot.
param Number sublabel_size ( allow_None=False, bounds=None, constant=False, default=18, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001> )
Size of optional subfigure label.
param Boolean logy ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to apply log scaling to the y-axis of the Chart.
param Boolean invert_zaxis ( allow_None=False, bounds=(0, 1), constant=False, default=False, instantiate=False, pickle_default_value=True, precedence=None, readonly=False )
Whether to invert the plot z-axis.
param Dict clipping_colors ( allow_None=False, constant=False, default={}, instantiate=True, is_instance=True, pickle_default_value=True, precedence=None, readonly=False )
Dictionary to specify colors for clipped values, allows setting color for NaN values and for values above and below the min and max value