Perform a property update operation on all polar objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all polar objects that satisfy the selection crit
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 23030 | return self |
| 23031 | |
| 23032 | def update_polars( |
| 23033 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 23034 | ) -> "FigureWidget": |
| 23035 | """ |
| 23036 | Perform a property update operation on all polar objects |
| 23037 | that satisfy the specified selection criteria |
| 23038 | |
| 23039 | Parameters |
| 23040 | ---------- |
| 23041 | patch: dict |
| 23042 | Dictionary of property updates to be applied to all |
| 23043 | polar objects that satisfy the selection criteria. |
| 23044 | selector: dict, function, or None (default None) |
| 23045 | Dict to use as selection criteria. |
| 23046 | polar objects will be selected if they contain |
| 23047 | properties corresponding to all of the dictionary's keys, with |
| 23048 | values that exactly match the supplied values. If None |
| 23049 | (the default), all polar objects are selected. If a |
| 23050 | function, it must be a function accepting a single argument and |
| 23051 | returning a boolean. The function will be called on each |
| 23052 | polar and those for which the function returned True will |
| 23053 | be in the selection. |
| 23054 | overwrite: bool |
| 23055 | If True, overwrite existing properties. If False, apply updates |
| 23056 | to existing properties recursively, preserving existing |
| 23057 | properties that are not specified in the update operation. |
| 23058 | row, col: int or None (default None) |
| 23059 | Subplot row and column index of polar objects to select. |
| 23060 | To select polar objects by row and column, the Figure |
| 23061 | must have been created using plotly.subplots.make_subplots. |
| 23062 | If None (the default), all polar objects are selected. |
| 23063 | **kwargs |
| 23064 | Additional property updates to apply to each selected |
| 23065 | polar object. If a property is specified in |
| 23066 | both patch and in **kwargs then the one in **kwargs |
| 23067 | takes precedence. |
| 23068 | Returns |
| 23069 | ------- |
| 23070 | self |
| 23071 | Returns the FigureWidget object that the method was called on |
| 23072 | """ |
| 23073 | for obj in self.select_polars(selector=selector, row=row, col=col): |
| 23074 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 23075 | |
| 23076 | return self |
| 23077 | |
| 23078 | def select_scenes(self, selector=None, row=None, col=None): |
| 23079 | """ |
nothing calls this directly
no test coverage detected