holoviews.plotly Package


plotly Package


annotation Module

digraph inheritance3a481677af { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.annotation.LabelPlot" [URL="#holoviews.plotting.plotly.annotation.LabelPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ScatterPlot" -> "holoviews.plotting.plotly.annotation.LabelPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ChartPlot" [URL="#holoviews.plotting.plotly.chart.ChartPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart.ChartPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ScatterPlot" [URL="#holoviews.plotting.plotly.chart.ScatterPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" [URL="#holoviews.plotting.plotly.element.ColorbarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.ColorbarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.annotation.LabelPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart.ScatterPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

color_index = param.ClassSelector(class_=(<class ‘str’>, <class ‘int’>))

Index of the dimension from which the color will the drawn

xoffset = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Amount of offset to apply to labels along x-axis.

yoffset = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Amount of offset to apply to labels along x-axis.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.annotation.LabelPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


callbacks Module

digraph inheritance313241c306 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plotly.callbacks.BoundsCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.PlotlyCallback" -> "holoviews.plotting.plotly.callbacks.BoundsCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsXCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsCallback" -> "holoviews.plotting.plotly.callbacks.BoundsXCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsXYCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsCallback" -> "holoviews.plotting.plotly.callbacks.BoundsXYCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsYCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.BoundsCallback" -> "holoviews.plotting.plotly.callbacks.BoundsYCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.PlotlyCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.PlotlyCallbackMetaClass" [URL="#holoviews.plotting.plotly.callbacks.PlotlyCallbackMetaClass",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Metaclass for PlotlyCallback classes."]; "holoviews.plotting.plotly.callbacks.RangeCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.PlotlyCallback" -> "holoviews.plotting.plotly.callbacks.RangeCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeXCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeCallback" -> "holoviews.plotting.plotly.callbacks.RangeXCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeXYCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeCallback" -> "holoviews.plotting.plotly.callbacks.RangeXYCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeYCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.RangeCallback" -> "holoviews.plotting.plotly.callbacks.RangeYCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.Selection1DCallback" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.callbacks.PlotlyCallback" -> "holoviews.plotting.plotly.callbacks.Selection1DCallback" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
class holoviews.plotting.plotly.callbacks.PlotlyCallbackMetaClass(name, bases, attrs)[source]

Bases: type

Metaclass for PlotlyCallback classes.

We want each callback class to keep track of all of the instances of the class. Using a meta class here lets us keep the logic for instance tracking in one place.

mro()

Return a type’s method resolution order.


chart Module

digraph inheritancea4c95a0d66 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.mixins.AreaMixin" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.mixins.BarsMixin" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.AreaPlot" [URL="#holoviews.plotting.plotly.chart.AreaPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.mixins.AreaMixin" -> "holoviews.plotting.plotly.chart.AreaPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.AreaPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.BarPlot" [URL="#holoviews.plotting.plotly.chart.BarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.mixins.BarsMixin" -> "holoviews.plotting.plotly.chart.BarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart.BarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ChartPlot" [URL="#holoviews.plotting.plotly.chart.ChartPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart.ChartPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.CurvePlot" [URL="#holoviews.plotting.plotly.chart.CurvePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.CurvePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.CurvePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ErrorBarsPlot" [URL="#holoviews.plotting.plotly.chart.ErrorBarsPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.ErrorBarsPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.ErrorBarsPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.HistogramPlot" [URL="#holoviews.plotting.plotly.chart.HistogramPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart.HistogramPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ScatterPlot" [URL="#holoviews.plotting.plotly.chart.ScatterPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.SpreadPlot" [URL="#holoviews.plotting.plotly.chart.SpreadPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.SpreadPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" [URL="#holoviews.plotting.plotly.element.ColorbarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.ColorbarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.chart.AreaPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.mixins.AreaMixin, holoviews.plotting.plotly.chart.ChartPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=(0, 0.1))

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.AreaPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.BarPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.mixins.BarsMixin, holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=True)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

multi_level = param.Boolean(bounds=(0, 1), default=True)

Whether the Bars should be grouped into a second categorical axis level.

stacked = param.Boolean(bounds=(0, 1), default=False)

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined')[source]

Make adjustments to plot extents by computing stacked bar heights, adjusting the bar baseline and forcing the x-axis to be categorical.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.BarPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.ChartPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ChartPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.CurvePlot(element, plot=None, **params)[source]

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

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=(0, 0.1))

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

interpolation = param.ObjectSelector(default=’linear’, objects=[‘linear’, ‘steps-mid’, ‘steps-pre’, ‘steps-post’])

Defines how the samples of the Curve are interpolated, default is ‘linear’, other options include ‘steps-mid’, ‘steps-pre’ and ‘steps-post’.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.CurvePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.ErrorBarsPlot(element, plot=None, **params)[source]

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

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ErrorBarsPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.HistogramPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.HistogramPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.ScatterPlot(element, plot=None, **params)[source]

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

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

color_index = param.ClassSelector(class_=(<class ‘str’>, <class ‘int’>))

Index of the dimension from which the color will the drawn

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.ScatterPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart.SpreadPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart.ChartPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=(0, 0.1))

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart.SpreadPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


chart3d Module

digraph inheritancef8e5599f35 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ChartPlot" [URL="#holoviews.plotting.plotly.chart.ChartPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart.ChartPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.CurvePlot" [URL="#holoviews.plotting.plotly.chart.CurvePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.CurvePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.CurvePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ScatterPlot" [URL="#holoviews.plotting.plotly.chart.ScatterPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart.ChartPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart.ScatterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart3d.Chart3DPlot" [URL="#holoviews.plotting.plotly.chart3d.Chart3DPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.chart3d.Chart3DPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart3d.Path3DPlot" [URL="#holoviews.plotting.plotly.chart3d.Path3DPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart3d.Chart3DPlot" -> "holoviews.plotting.plotly.chart3d.Path3DPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.CurvePlot" -> "holoviews.plotting.plotly.chart3d.Path3DPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart3d.Scatter3DPlot" [URL="#holoviews.plotting.plotly.chart3d.Scatter3DPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart3d.Chart3DPlot" -> "holoviews.plotting.plotly.chart3d.Scatter3DPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart.ScatterPlot" -> "holoviews.plotting.plotly.chart3d.Scatter3DPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart3d.SurfacePlot" [URL="#holoviews.plotting.plotly.chart3d.SurfacePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart3d.Chart3DPlot" -> "holoviews.plotting.plotly.chart3d.SurfacePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart3d.SurfacePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.chart3d.TriSurfacePlot" [URL="#holoviews.plotting.plotly.chart3d.TriSurfacePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.chart3d.Chart3DPlot" -> "holoviews.plotting.plotly.chart3d.TriSurfacePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.chart3d.TriSurfacePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" [URL="#holoviews.plotting.plotly.element.ColorbarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.ColorbarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.chart3d.Chart3DPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.String(default=’3d’)

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

camera_angle = param.NumericTuple(default=(0.2, 0.5, 0.1, 0.2), length=4)

camera_position = param.NumericTuple(default=(0.1, 0, -0.1), length=3)

camera_zoom = param.Integer(default=3, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Chart3DPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart3d.Path3DPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart3d.Chart3DPlot, holoviews.plotting.plotly.chart.CurvePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.String(default=’3d’)

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=(0, 0.1))

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

interpolation = param.ObjectSelector(default=’linear’, objects=[‘linear’, ‘steps-mid’, ‘steps-pre’, ‘steps-post’])

Defines how the samples of the Curve are interpolated, default is ‘linear’, other options include ‘steps-mid’, ‘steps-pre’ and ‘steps-post’.

camera_angle = param.NumericTuple(default=(0.2, 0.5, 0.1, 0.2), length=4)

camera_position = param.NumericTuple(default=(0.1, 0, -0.1), length=3)

camera_zoom = param.Integer(default=3, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Path3DPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart3d.Scatter3DPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart3d.Chart3DPlot, holoviews.plotting.plotly.chart.ScatterPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.String(default=’3d’)

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

color_index = param.ClassSelector(class_=(<class ‘str’>, <class ‘int’>))

Index of the dimension from which the color will the drawn

camera_angle = param.NumericTuple(default=(0.2, 0.5, 0.1, 0.2), length=4)

camera_position = param.NumericTuple(default=(0.1, 0, -0.1), length=3)

camera_zoom = param.Integer(default=3, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.Scatter3DPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart3d.SurfacePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart3d.Chart3DPlot, holoviews.plotting.plotly.element.ColorbarPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.String(default=’3d’)

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

camera_angle = param.NumericTuple(default=(0.2, 0.5, 0.1, 0.2), length=4)

camera_position = param.NumericTuple(default=(0.1, 0, -0.1), length=3)

camera_zoom = param.Integer(default=3, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.SurfacePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.chart3d.TriSurfacePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.chart3d.Chart3DPlot, holoviews.plotting.plotly.element.ColorbarPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.String(default=’3d’)

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=500, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

camera_angle = param.NumericTuple(default=(0.2, 0.5, 0.1, 0.2), length=4)

camera_position = param.NumericTuple(default=(0.1, 0, -0.1), length=3)

camera_zoom = param.Integer(default=3, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)[source]

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.chart3d.TriSurfacePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


element Module

digraph inheritance3a501ba5b4 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericOverlayPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericOverlayPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render (Nd)Overlay objects. It implements"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plot.GenericOverlayPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" [URL="#holoviews.plotting.plotly.element.ColorbarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.ColorbarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.OverlayPlot" [URL="#holoviews.plotting.plotly.element.OverlayPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.GenericOverlayPlot" -> "holoviews.plotting.plotly.element.OverlayPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.OverlayPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.element.ColorbarPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ColorbarPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.element.ElementPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.plot.PlotlyPlot, holoviews.plotting.plot.GenericElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
get_aspect(xspan, yspan)[source]

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)[source]

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)[source]

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.ElementPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)[source]

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.element.OverlayPlot(overlay, ranges=None, batched=True, keys=None, group_counter=None, **params)[source]

Bases: holoviews.plotting.plot.GenericOverlayPlot, holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=True)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

batched = param.Boolean(bounds=(0, 1), default=True)

Whether to plot Elements NdOverlay in a batched plotting call if possible. Disables legends and zorder may not be preserved.

legend_limit = param.Integer(default=25, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Number of rendered glyphs before legends are disabled.

style_grouping = param.Integer(default=2, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

The length of the type.group.label spec that will be used to group Elements into style groups. 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.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(overlay, ranges, range_type='combined')

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)[source]

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.element.OverlayPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)[source]

Set the plot(s) to the given frame number. Operates by manipulating the matplotlib objects held in the self._handles dictionary.

If n is greater than the number of available frames, update using the last available frame.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


images Module

digraph inheritanceeabc873251 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.images.RGBPlot" [URL="#holoviews.plotting.plotly.images.RGBPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.images.RGBPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.images.RGBPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ElementPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)[source]

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.images.RGBPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


plot Module

digraph inheritance7fdbf36658 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericAdjointLayoutPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericAdjointLayoutPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="AdjointLayoutPlot allows placing up to three Views in a number of"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.GenericAdjointLayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericCompositePlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericCompositePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericCompositePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericLayoutPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericLayoutPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A GenericLayoutPlot accepts either a Layout or a NdLayout and"]; "holoviews.plotting.plot.GenericCompositePlot" -> "holoviews.plotting.plot.GenericLayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.AdjointLayoutPlot" [URL="#holoviews.plotting.plotly.plot.AdjointLayoutPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.plot.AdjointLayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericAdjointLayoutPlot" -> "holoviews.plotting.plotly.plot.AdjointLayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.GridPlot" [URL="#holoviews.plotting.plotly.plot.GridPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plot a group of elements in a grid layout based on a GridSpace element"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.plot.GridPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericCompositePlot" -> "holoviews.plotting.plotly.plot.GridPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.LayoutPlot" [URL="#holoviews.plotting.plotly.plot.LayoutPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.plot.LayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericLayoutPlot" -> "holoviews.plotting.plotly.plot.LayoutPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.plot.AdjointLayoutPlot(layout, layout_type, subplots, **params)[source]

Bases: holoviews.plotting.plotly.plot.PlotlyPlot, holoviews.plotting.plot.GenericAdjointLayoutPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
initialize_plot(ranges=None)[source]

Plot all the views contained in the AdjointLayout Object using axes appropriate to the layout configuration. All the axes are supplied by LayoutPlot - the purpose of the call is to invoke subplots with correct options and styles and hide any empty axes as necessary.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.AdjointLayoutPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.plot.GridPlot(layout, ranges=None, layout_num=1, **params)[source]

Bases: holoviews.plotting.plotly.plot.PlotlyPlot, holoviews.plotting.plot.GenericCompositePlot

Plot a group of elements in a grid layout based on a GridSpace element object.

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

hspacing = param.Number(bounds=(0, None), default=15, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

vspacing = param.Number(bounds=(0, None), default=15, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

shared_axes = param.Boolean(bounds=(0, 1), default=True)

Whether axes ranges should be shared across the layout, if disabled switches axiswise normalization option on globally.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
initialize_plot(ranges=None)

Initialize the matplotlib figure.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.plot.LayoutPlot(layout, **params)[source]

Bases: holoviews.plotting.plotly.plot.PlotlyPlot, holoviews.plotting.plot.GenericLayoutPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

transpose = param.Boolean(bounds=(0, 1), default=False)

Whether to transpose the layout when plotting. Switches from row-based left-to-right and top-to-bottom scanline order to column-based top-to-bottom and left-to-right order.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

hspacing = param.Number(bounds=(0, None), default=120, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

vspacing = param.Number(bounds=(0, None), default=100, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

adjoint_spacing = param.Number(bounds=(0, None), default=20, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

shared_axes = param.Boolean(bounds=(0, 1), default=True)

Whether axes ranges should be shared across the layout, if disabled switches axiswise normalization option on globally.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
initialize_plot(ranges=None)

Initialize the matplotlib figure.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.LayoutPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.plot.PlotlyPlot(keys=None, dimensions=None, layout_dimensions=None, uniform=True, subplot=False, adjoined=None, layout_num=0, style=None, subplots=None, dynamic=False, **params)[source]

Bases: holoviews.plotting.plot.DimensionedPlot, holoviews.plotting.plot.CallbackPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
initialize_plot(ranges=None)[source]

Initialize the matplotlib figure.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.PlotlyPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


raster Module

digraph inheritance121cf1c06a { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.mixins.HeatMapMixin" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ColorbarPlot" [URL="#holoviews.plotting.plotly.element.ColorbarPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.element.ColorbarPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.raster.HeatMapPlot" [URL="#holoviews.plotting.plotly.raster.HeatMapPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.mixins.HeatMapMixin" -> "holoviews.plotting.plotly.raster.HeatMapPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.raster.RasterPlot" -> "holoviews.plotting.plotly.raster.HeatMapPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.raster.QuadMeshPlot" [URL="#holoviews.plotting.plotly.raster.QuadMeshPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.raster.RasterPlot" -> "holoviews.plotting.plotly.raster.QuadMeshPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.raster.RasterPlot" [URL="#holoviews.plotting.plotly.raster.RasterPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ColorbarPlot" -> "holoviews.plotting.plotly.raster.RasterPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.raster.HeatMapPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.mixins.HeatMapMixin, holoviews.plotting.plotly.raster.RasterPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.HeatMapPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.raster.QuadMeshPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.raster.RasterPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.QuadMeshPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.raster.RasterPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.element.ColorbarPlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

clim = param.NumericTuple(default=(nan, nan), length=2)

User-specified colorbar axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

colorbar = param.Boolean(bounds=(0, 1), default=False)

Whether to display a colorbar.

color_levels = param.ClassSelector(class_=(<class ‘int’>, <class ‘list’>))

Number of discrete colors to use when colormapping or a set of color intervals defining the range of values to map each color to.

colorbar_opts = param.Dict(class_=<class ‘dict’>, default={})

Allows setting including borderwidth, showexponent, nticks, outlinecolor, thickness, bgcolor, outlinewidth, bordercolor, ticklen, xpad, ypad, tickangle…

symmetric = param.Boolean(bounds=(0, 1), default=False)

Whether to make the colormap symmetric around zero.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.raster.RasterPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


renderer Module

digraph inheritance9eca5fcf49 { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.core.io.Exporter" [URL="holoviews.core.html#holoviews.core.io.Exporter",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="An Exporter is a parameterized function that accepts a HoloViews"]; "param.parameterized.ParameterizedFunction" -> "holoviews.core.io.Exporter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.renderer.PlotlyRenderer" [URL="#holoviews.plotting.plotly.renderer.PlotlyRenderer",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.renderer.Renderer" -> "holoviews.plotting.plotly.renderer.PlotlyRenderer" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.renderer.Renderer" [URL="holoviews.plotting.html#holoviews.plotting.renderer.Renderer",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="The job of a Renderer is to turn the plotting state held within"]; "holoviews.core.io.Exporter" -> "holoviews.plotting.renderer.Renderer" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; "param.parameterized.ParameterizedFunction" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; "param.parameterized.Parameterized" -> "param.parameterized.ParameterizedFunction" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
class holoviews.plotting.plotly.renderer.PlotlyRenderer(**params)[source]

Bases: holoviews.plotting.renderer.Renderer

key_fn = param.Callable()

Renderers do not support the saving of object key metadata

info_fn = param.Callable()

Renderers do not support the saving of object info metadata

backend = param.String(default=’plotly’)

The backend name.

dpi = param.Integer(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

The render resolution in dpi (dots per inch)

fig = param.ObjectSelector(default=’auto’, objects=[‘html’, ‘png’, ‘svg’, ‘auto’])

Output render format for static figures. If None, no figure rendering will occur.

fps = param.Number(default=20, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rendered fps (frames per second) for animated formats.

holomap = param.ObjectSelector(default=’auto’, objects=[‘scrubber’, ‘widgets’, ‘gif’, None, ‘auto’])

Output render multi-frame (typically animated) format. If None, no multi-frame rendering will occur.

mode = param.ObjectSelector(default=’default’, objects=[‘default’, ‘server’])

Whether to render the object in regular or server mode. In server mode a bokeh Document will be returned which can be served as a bokeh server app. By default renders all output is rendered to HTML.

size = param.Integer(default=100, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

The rendered size as a percentage size

widget_location = param.ObjectSelector(objects=[‘left’, ‘bottom’, ‘right’, ‘top’, ‘top_left’, ‘top_right’, ‘bottom_left’, ‘bottom_right’, ‘left_top’, ‘left_bottom’, ‘right_top’, ‘right_bottom’])

The position of the widgets relative to the plot.

widget_mode = param.ObjectSelector(default=’embed’, objects=[‘embed’, ‘live’])

The widget mode determining whether frames are embedded or generated ‘live’ when interacting with the widget.

css = param.Dict(class_=<class ‘dict’>, default={})

Dictionary of CSS attributes and values to apply to HTML output.

post_render_hooks = param.Dict(class_=<class ‘dict’>, default={‘svg’: [], ‘png’: []})

Optional dictionary of hooks that are applied to the rendered data (according to the output format) before it is returned. Each hook is passed the rendered data and the object that is being rendered. These hooks allow post-processing of rendered data before output is saved to file or displayed.

app = functools.partial(<function Renderer.app>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
comm_manager

alias of pyviz_comms.CommManager

components(obj, fmt=None, comm=True, **kwargs)

Returns data and metadata dictionaries containing HTML and JS components to include render in app, notebook, or standalone document.

debug(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

classmethod encode(entry)

Classmethod that applies conditional encoding based on mime-type. Given an entry as returned by __call__ return the data in the appropriate encoding.

export_widgets = functools.partial(<function Renderer.export_widgets>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
get_plot = functools.partial(<function Renderer.get_plot>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
get_plot_state = functools.partial(<function PlotlyRenderer.get_plot_state>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)[source]
get_size = functools.partial(<function Renderer.get_size>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
html(obj, fmt=None, css=None, resources='CDN', **kwargs)

Renders plot or data structure and wraps the output in HTML. The comm argument defines whether the HTML output includes code to initialize a Comm, if the plot supplies one.

classmethod html_assets(core=True, extras=True, backends=None, script=False)

Deprecated: No longer needed

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
instance = functools.partial(<function ParameterizedFunction.instance>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
classmethod load_nb(inline=True)[source]

Loads the plotly notebook resources.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
classmethod plot_options(obj, percent_size)[source]

Given an object and a percentage size (as supplied by the %output magic) return all the appropriate plot options that would be used to instantiate a plot class for that element.

Default plot sizes at the plotting class level should be taken into account.

classmethod plotting_class(obj)

Given an object or Element class, return the suitable plotting class needed to render it with the current renderer.

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

Same as Parameterized.pprint, except that X.classname(Y is replaced with X.classname.instance(Y

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

save = functools.partial(<function Renderer.save>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
script_repr(imports=[], prefix=' ')

Same as Parameterized.script_repr, except that X.classname(Y is replaced with X.classname.instance(Y

server_doc = functools.partial(<function Renderer.server_doc>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.renderer.PlotlyRenderer'>)
classmethod state()

Context manager to handle global state for a backend, allowing Plot classes to temporarily override that state.

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.

static_html(obj, fmt=None, template=None)

Generates a static HTML with the rendered object in the supplied format. Allows supplying a template formatting string with fields to interpolate ‘js’, ‘css’ and the main ‘html’.

classmethod validate(options)

Validate an options dictionary for the renderer.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring


selection Module

digraph inheritancebbff4351eb { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.plotly.selection.PlotlyOverlaySelectionDisplay" [URL="#holoviews.plotting.plotly.selection.PlotlyOverlaySelectionDisplay",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Overlay selection display subclass for use with plotly backend"]; "holoviews.selection.OverlaySelectionDisplay" -> "holoviews.plotting.plotly.selection.PlotlyOverlaySelectionDisplay" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.selection.OverlaySelectionDisplay" [URL="holoviews.selection.html#holoviews.selection.OverlaySelectionDisplay",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Selection display base class that represents selections by overlaying"]; "holoviews.selection.SelectionDisplay" -> "holoviews.selection.OverlaySelectionDisplay" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.selection.SelectionDisplay" [URL="holoviews.selection.html#holoviews.selection.SelectionDisplay",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class for selection display classes. Selection display classes are"]; }
class holoviews.plotting.plotly.selection.PlotlyOverlaySelectionDisplay(color_prop='color', is_cmap=False, supports_region=True)[source]

Bases: holoviews.selection.OverlaySelectionDisplay

Overlay selection display subclass for use with plotly backend


shapes Module

digraph inheritance39da524e6f { fontsize=18; rankdir=LR; size="12.0, 12.0"; "holoviews.plotting.mixins.GeomMixin" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.DimensionedPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.DimensionedPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="DimensionedPlot implements a number of useful methods"]; "holoviews.plotting.plot.Plot" -> "holoviews.plotting.plot.DimensionedPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" [URL="holoviews.plotting.html#holoviews.plotting.plot.GenericElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Plotting baseclass to render contents of an Element. Implements"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plot.GenericElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.Plot" [URL="holoviews.plotting.html#holoviews.plotting.plot.Plot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Base class of all Plot classes in HoloViews, designed to be"]; "param.parameterized.Parameterized" -> "holoviews.plotting.plot.Plot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.element.ElementPlot" [URL="#holoviews.plotting.plotly.element.ElementPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.plot.PlotlyPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.GenericElementPlot" -> "holoviews.plotting.plotly.element.ElementPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.plot.PlotlyPlot" [URL="#holoviews.plotting.plotly.plot.PlotlyPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plot.DimensionedPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plot.CallbackPlot" -> "holoviews.plotting.plotly.plot.PlotlyPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.BoxShapePlot" [URL="#holoviews.plotting.plotly.shapes.BoxShapePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.mixins.GeomMixin" -> "holoviews.plotting.plotly.shapes.BoxShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.ShapePlot" -> "holoviews.plotting.plotly.shapes.BoxShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.HVLinePlot" [URL="#holoviews.plotting.plotly.shapes.HVLinePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.shapes.ShapePlot" -> "holoviews.plotting.plotly.shapes.HVLinePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.HVSpanPlot" [URL="#holoviews.plotting.plotly.shapes.HVSpanPlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.shapes.ShapePlot" -> "holoviews.plotting.plotly.shapes.HVSpanPlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.PathShapePlot" [URL="#holoviews.plotting.plotly.shapes.PathShapePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.shapes.ShapePlot" -> "holoviews.plotting.plotly.shapes.PathShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.SegmentShapePlot" [URL="#holoviews.plotting.plotly.shapes.SegmentShapePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.mixins.GeomMixin" -> "holoviews.plotting.plotly.shapes.SegmentShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.ShapePlot" -> "holoviews.plotting.plotly.shapes.SegmentShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "holoviews.plotting.plotly.shapes.ShapePlot" [URL="#holoviews.plotting.plotly.shapes.ShapePlot",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top"]; "holoviews.plotting.plotly.element.ElementPlot" -> "holoviews.plotting.plotly.shapes.ShapePlot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "param.parameterized.Parameterized" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",tooltip="params(name=String)"]; }
class holoviews.plotting.plotly.shapes.BoxShapePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.mixins.GeomMixin, holoviews.plotting.plotly.shapes.ShapePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined')

Use first two key dimensions to set names, and all four to set the data range.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.BoxShapePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.shapes.HVLinePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.shapes.ShapePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=False)

Whether to include the annotation in axis range calculations.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVLinePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.shapes.HVSpanPlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.shapes.ShapePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=False)

Whether to include the annotation in axis range calculations.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.HVSpanPlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.shapes.PathShapePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.plotly.shapes.ShapePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

zlim = param.Tuple(default=(nan, nan), length=2)

User-specified z-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

xrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the xticks.

yrotation = param.Integer(bounds=(0, 360), inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Rotation angle of the yticks.

xticks = param.Parameter()

Ticks along x-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

yticks = param.Parameter()

Ticks along y-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

width = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

height = param.Integer(default=400, inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

aspect = param.Parameter(default=’cube’)

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.

invert_zaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot z-axis.

labelled = param.List(bounds=(0, None), default=[‘x’, ‘y’, ‘z’])

Whether to label the ‘x’ and ‘y’ axes.

logz = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

margins = param.NumericTuple(default=(50, 50, 50, 50), length=4)

Margins in pixel values specified as a tuple of the form (left, bottom, right, top).

responsive = param.Boolean(bounds=(0, 1), default=False)

Whether the plot should stretch to fill the available space.

zlabel = param.String()

An explicit override of the z-axis label, if set takes precedence over the dimension label.

zticks = param.Parameter()

Ticks along z-axis specified as an integer, explicit list of tick locations, list of tuples containing the locations.

cleanup()

Cleans up references to the plot on the attached Stream subscribers.

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(**kwargs)

Inspect .param.debug method for the full docstring

defaults(**kwargs)

Inspect .param.defaults method for the full docstring

force_new_dynamic_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
get_aspect(xspan, yspan)

Computes the aspect ratio of the plot

get_extents(element, ranges, range_type='combined', xdim=None, ydim=None, zdim=None)

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

The extents are computed by combining the data ranges, extents and dimension ranges. Each of these can be obtained individually by setting the range_type to one of:

  • ‘data’: Just the data ranges

  • ‘extents’: Element.extents

  • ‘soft’: Dimension.soft_range values

  • ‘hard’: Dimension.range values

To obtain the combined range, which includes range padding the default may be used:

  • ‘combined’: All the range types combined and padding applied

This allows Overlay plots to obtain each range and combine them appropriately for all the objects in the overlay.

get_padding(obj, extents)

Computes padding along the axes taking into account the plot aspect.

get_param_values = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
get_value_generator = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
get_zorder(overlay, key, el)

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

init_graph(datum, options, index=0)

Initialize the plotly components that will represent the element

datum: dict

An element of the data list returned by the get_data method

options: dict

Graph options that were returned by the graph_options method

index: int

Index of datum in the original list returned by the get_data method

dict

Dictionary of the plotly components that represent the element. Keys may include:

  • ‘traces’: List of trace dicts

  • ‘annotations’: List of annotations dicts

  • ‘images’: List of image dicts

  • ‘shapes’: List of shape dicts

initialize_plot(ranges=None)

Initializes a new plot object with the last available frame.

inspect_value = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)

Returns potential Link or Stream sources.

matches(spec)

Matches a specification against the current Plot.

message(**kwargs)

Inspect .param.message method for the full docstring

params = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
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.

classmethod print_param_defaults(*args, **kwargs)

Inspect .param.print_param_defaults method for the full docstring

print_param_values(**kwargs)

Inspect .param.print_param_values method for the full docstring

push()

Pushes plot updates to the frontend.

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.

classmethod set_default(*args, **kwargs)

Inspect .param.set_default method for the full docstring

set_dynamic_time_fn = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
set_param = functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.shapes.PathShapePlot'>)
set_root(root)

Sets the root model on all subplots.

property state

The plotting state that gets updated via the update method and used by the renderer to generate output.

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(key)

Update the internal state of the Plot to represent the given key tuple (where integers represent frames). Returns this state.

update_frame(key, ranges=None, element=None)

Updates an existing plot with data corresponding to the key.

verbose(**kwargs)

Inspect .param.verbose method for the full docstring

warning(**kwargs)

Inspect .param.warning method for the full docstring

class holoviews.plotting.plotly.shapes.SegmentShapePlot(element, plot=None, **params)[source]

Bases: holoviews.plotting.mixins.GeomMixin, holoviews.plotting.plotly.shapes.ShapePlot

fontsize = param.Parameter()

Specifies various font sizes of the displayed text. Finer control is available by supplying a dictionary where any unmentioned keys revert to the default sizes, e.g: {‘ticks’:20, ‘title’:15, ‘ylabel’:5, ‘xlabel’:5, ‘zlabel’:5, ‘legend’:8, ‘legend_title’:13} You can set the font size of ‘zlabel’, ‘ylabel’ and ‘xlabel’ together using the ‘labels’ key.

fontscale = param.Number(inclusive_bounds=(True, True), time_dependent=False, time_fn=Time(label=’Time’, name=’Time00001’, time_type=<class ‘int’>, timestep=1.0, unit=None, until=Infinity()))

Scales the size of all fonts.

show_title = param.Boolean(bounds=(0, 1), default=True)

Whether to display the plot title.

title = param.String(default=’{label} {group}n{dimensions}’)

The formatting string for the title of this plot, allows defining a label group separator and dimension labels.

title_format = param.String()

Alias for title.

normalize = param.Boolean(bounds=(0, 1), default=True)

Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.

projection = param.Parameter()

Allows supplying a custom projection to transform the axis coordinates during display. Example projections include ‘3d’ and ‘polar’ projections supported by some backends. Depending on the backend custom, projection objects may be supplied.

apply_ranges = param.Boolean(bounds=(0, 1), default=True)

Whether to compute the plot bounds from the data itself.

apply_extents = param.Boolean(bounds=(0, 1), default=True)

Whether to apply extent overrides on the Elements

bgcolor = param.ClassSelector(class_=(<class ‘str’>, <class ‘tuple’>))

If set bgcolor overrides the background color of the axis.

default_span = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=2.0)

Defines the span of an axis if the axis range is zero, i.e. if the lower and upper end of an axis are equal or no range is defined at all. For example if there is a single datapoint at 0 a default_span of 2.0 will result in axis ranges spanning from -1 to 1.

hooks = param.HookList(bounds=(0, None), default=[])

Optional list of hooks called when finalizing a plot. The hook is passed the plot object and the displayed element, and other plotting handles can be accessed via plot.handles.

invert_axes = param.ObjectSelector(default=False, objects=[])

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.

invert_xaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot x-axis.

invert_yaxis = param.Boolean(bounds=(0, 1), default=False)

Whether to invert the plot y-axis.

finalize_hooks = param.HookList(bounds=(0, None), default=[])

Deprecated; use hooks options instead.

logx = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the x-axis of the Chart.

logy = param.Boolean(bounds=(0, 1), default=False)

Whether to apply log scaling to the y-axis of the Chart.

padding = param.ClassSelector(class_=(<class ‘int’>, <class ‘float’>, <class ‘tuple’>), default=0.1)

Fraction by which to increase auto-ranged extents to make datapoints more visible around borders. To compute padding, the axis whose screen size is largest is chosen, and the range of that axis is increased by the specified fraction along each axis. Other axes are then padded ensuring that the amount of screen space devoted to padding is equal for all axes. If specified as a tuple, the int or float values in the tuple will be used for padding in each axis, in order (x,y or x,y,z). For example, for padding=0.2 on a 800x800-pixel plot, an x-axis with the range [0,10] will be padded by 20% to be [-1,11], while a y-axis with a range [0,1000] will be padded to be [-100,1100], which should make the padding be approximately the same number of pixels. But if the same plot is changed to have a height of only 200, the y-range will then be [-400,1400] so that the y-axis padding will still match that of the x-axis. It is also possible to declare non-equal padding value for the lower and upper bound of an axis by supplying nested tuples, e.g. padding=(0.1, (0, 0.1)) will pad the x-axis lower and upper bound as well as the y-axis upper bound by a fraction of 0.1 while the y-axis lower bound is not padded at all.

show_legend = param.Boolean(bounds=(0, 1), default=False)

Whether to show legend for the plot.

show_grid = param.Boolean(bounds=(0, 1), default=False)

Whether to show a Cartesian grid on the plot.

xaxis = param.ObjectSelector(default=’bottom’, objects=[‘top’, ‘bottom’, ‘bare’, ‘top-bare’, ‘bottom-bare’, None])

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’.

yaxis = param.ObjectSelector(default=’left’, objects=[‘left’, ‘right’, ‘bare’, ‘left-bare’, ‘right-bare’, None])

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’.

xlabel = param.String()

An explicit override of the x-axis label, if set takes precedence over the dimension label.

ylabel = param.String()

An explicit override of the y-axis label, if set takes precedence over the dimension label.

xlim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If specified, takes precedence over data and dimension ranges.

ylim = param.Tuple(default=(nan, nan), length=2)

User-specified x-axis range limits for the plot, as a tuple (low,high). If