holoviews.plotly Package ¶
plotly
Package
¶
chart
Module
¶
chart3d
Module
¶
element
Module
¶
plot
Module
¶
-
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.
-
param Parameter
fontsize
( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, watchers={} ) - 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.
-
param Boolean
show_title
( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, watchers={} ) - Whether to display the plot title.
-
param String
title
( allow_None=False, basestring=<class ‘str’>, constant=False, default={label} {group} {dimensions}, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, regex=None, watchers={} ) - The formatting string for the title of this plot, allows defining a label group separator and dimension labels.
-
param String
title_format
( allow_None=True, basestring=<class ‘str’>, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, regex=None, watchers={} ) - Alias for title.
-
param Boolean
normalize
( allow_None=False, bounds=(0, 1), constant=False, default=True, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, watchers={} ) - Whether to compute ranges across all Elements at this level of plotting. Allows selecting normalization at different levels for nested data containers.
-
param Parameter
projection
( allow_None=True, constant=False, default=None, instantiate=False, pickle_default_value=True, precedence=None, readonly=False, watchers={} ) - 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.
param Integer
width
( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001>, watchers={} )param Integer
height
( allow_None=False, bounds=None, constant=False, default=400, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001>, watchers={} )param Number
hspacing
( allow_None=False, bounds=(0, 1), constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001>, watchers={} )param Number
vspacing
( allow_None=False, bounds=(0, 1), constant=False, default=0.05, inclusive_bounds=(True, True), instantiate=False, pickle_default_value=True, precedence=None, readonly=False, softbounds=None, time_dependent=False, time_fn=<Time Time00001>, watchers={} )-
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
( *args , **kwargs ) ¶ -
Inspect .param.debug method for the full docstring
-
defaults
( *args , **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'>) ¶
-
init_comm
( ) ¶ -
Initializes comm and attaches streams.
-
inspect_value
= functools.partial(<function Parameters.deprecate.<locals>.inner>, <class 'holoviews.plotting.plotly.plot.GridPlot'>) ¶
-
matches
( spec ) ¶ -
Matches a specification against the current Plot.
-
message
( *args , **kwargs ) ¶ -
Inspect .param.message method for the full docstring
-
params
( *args , **kwargs ) ¶ -
Inspect .param.params method for the full docstring
-
pprint
( imports=None , prefix=' ' , unknown_value='<?>' , qualify=False , separator='' ) ¶ -
(Experimental) Pretty printed representation that may be evaluated with eval. See pprint() function for more details.
-
print_param_defaults
( *args , **kwargs ) ¶ -
Inspect .param.print_param_defaults method for the full docstring
-
print_param_values
( *args , **kwargs ) ¶ -
Inspect .param.print_param_values method for the full docstring
-
push
( ) ¶ -
Pushes updated plot data via the Comm.
-
refresh
( **kwargs ) ¶ -
Refreshes the plot by rerendering it and then pushing the updated data if the plot has an associated Comm.
-
script_repr
( imports=[] , prefix=' ' ) ¶ -
Variant of __repr__ designed for generating a runnable script.
-
set_default
( *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'>) ¶
-
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.
-
verbose
( *args , **kwargs ) ¶ -
Inspect .param.verbose method for the full docstring
-
warning
( *args , **kwargs ) ¶ -
Inspect .param.warning method for the full docstring
-
param Parameter
raster
Module
¶
renderer
Module
¶
tabular
Module
¶
util
Module
¶
-
holoviews.plotting.plotly.util.
figure_grid
( figures_grid , row_heights=None , column_widths=None , row_spacing=0.15 , column_spacing=0.15 , share_xaxis=False , share_yaxis=False ) [source] ¶ -
Construct a figure from a 2D grid of sub-figures
- figures_grid: list of list of (dict or None)
- 2D list of plotly figure dicts that will be combined in a grid to produce the resulting figure. None values maybe used to leave empty grid cells
- row_heights: list of float (default None)
- List of the relative heights of each row in the grid (these values will be normalized by the function)
- column_widths: list of float (default None)
- List of the relative widths of each column in the grid (these values will be normalized by the function)
- row_spacing: float (default 0.15)
- Vertical spacing between rows in the gird in normalized coordinates
- column_spacing: float (default 0.15)
- Horizontal spacing between columns in the grid in normalized coordinates
- share_xaxis: bool (default False)
- Share x-axis between sub-figures in the same column. This will only work if each sub-figure has a single x-axis
- share_yaxis: bool (default False)
- Share y-axis between sub-figures in the same row. This will only work if each subfigure has a single y-axis
- dict
- A plotly figure dict
-
holoviews.plotting.plotly.util.
get_colorscale
( cmap , levels=None , cmin=None , cmax=None ) [source] ¶ -
Converts a cmap spec to a plotly colorscale
- Args:
- cmap: A recognized colormap by name or list of colors levels: A list or integer declaring the color-levels cmin: The lower bound of the color range cmax: The upper bound of the color range
- Returns:
- A valid plotly colorscale
-
holoviews.plotting.plotly.util.
merge_figure
( fig , subfig ) [source] ¶ -
Merge a sub-figure into a parent figure
Note: This function mutates the input fig dict, but it does not mutate the subfig dict
- fig: dict
- The plotly figure dict into which the sub figure will be merged
- subfig: dict
- The plotly figure dict that will be copied and then merged into fig