PlotlyWidget.update_coloraxes¶
-
PlotlyWidget.update_coloraxes(patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs)¶ Perform a property update operation on all coloraxis objects that satisfy the specified selection criteria
- Parameters
patch (dict) – Dictionary of property updates to be applied to all coloraxis objects that satisfy the selection criteria.
selector (dict, function, or None (default None)) – Dict to use as selection criteria. coloraxis objects will be selected if they contain properties corresponding to all of the dictionary’s keys, with values that exactly match the supplied values. If None (the default), all coloraxis objects are selected. If a function, it must be a function accepting a single argument and returning a boolean. The function will be called on each coloraxis and those for which the function returned True will be in the selection.
overwrite (bool) – If True, overwrite existing properties. If False, apply updates to existing properties recursively, preserving existing properties that are not specified in the update operation.
row (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
col (int or None (default None)) – Subplot row and column index of coloraxis objects to select. To select coloraxis objects by row and column, the Figure must have been created using plotly.subplots.make_subplots. If None (the default), all coloraxis objects are selected.
**kwargs – Additional property updates to apply to each selected coloraxis object. If a property is specified in both patch and in **kwargs then the one in **kwargs takes precedence.
- Returns
Returns the Figure object that the method was called on
- Return type
self