Perform a property update operation on all scene objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all scene objects that satisfy the selection crit
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 23138 | return self |
| 23139 | |
| 23140 | def update_scenes( |
| 23141 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 23142 | ) -> "Figure": |
| 23143 | """ |
| 23144 | Perform a property update operation on all scene objects |
| 23145 | that satisfy the specified selection criteria |
| 23146 | |
| 23147 | Parameters |
| 23148 | ---------- |
| 23149 | patch: dict |
| 23150 | Dictionary of property updates to be applied to all |
| 23151 | scene objects that satisfy the selection criteria. |
| 23152 | selector: dict, function, or None (default None) |
| 23153 | Dict to use as selection criteria. |
| 23154 | scene objects will be selected if they contain |
| 23155 | properties corresponding to all of the dictionary's keys, with |
| 23156 | values that exactly match the supplied values. If None |
| 23157 | (the default), all scene objects are selected. If a |
| 23158 | function, it must be a function accepting a single argument and |
| 23159 | returning a boolean. The function will be called on each |
| 23160 | scene and those for which the function returned True will |
| 23161 | be in the selection. |
| 23162 | overwrite: bool |
| 23163 | If True, overwrite existing properties. If False, apply updates |
| 23164 | to existing properties recursively, preserving existing |
| 23165 | properties that are not specified in the update operation. |
| 23166 | row, col: int or None (default None) |
| 23167 | Subplot row and column index of scene objects to select. |
| 23168 | To select scene objects by row and column, the Figure |
| 23169 | must have been created using plotly.subplots.make_subplots. |
| 23170 | If None (the default), all scene objects are selected. |
| 23171 | **kwargs |
| 23172 | Additional property updates to apply to each selected |
| 23173 | scene object. If a property is specified in |
| 23174 | both patch and in **kwargs then the one in **kwargs |
| 23175 | takes precedence. |
| 23176 | Returns |
| 23177 | ------- |
| 23178 | self |
| 23179 | Returns the Figure object that the method was called on |
| 23180 | """ |
| 23181 | for obj in self.select_scenes(selector=selector, row=row, col=col): |
| 23182 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 23183 | |
| 23184 | return self |
| 23185 | |
| 23186 | def select_smiths(self, selector=None, row=None, col=None): |
| 23187 | """ |
no test coverage detected