Perform a property update operation on all smith objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all smith objects that satisfy the selection crit
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 23254 | return self |
| 23255 | |
| 23256 | def update_smiths( |
| 23257 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 23258 | ) -> "FigureWidget": |
| 23259 | """ |
| 23260 | Perform a property update operation on all smith objects |
| 23261 | that satisfy the specified selection criteria |
| 23262 | |
| 23263 | Parameters |
| 23264 | ---------- |
| 23265 | patch: dict |
| 23266 | Dictionary of property updates to be applied to all |
| 23267 | smith objects that satisfy the selection criteria. |
| 23268 | selector: dict, function, or None (default None) |
| 23269 | Dict to use as selection criteria. |
| 23270 | smith objects will be selected if they contain |
| 23271 | properties corresponding to all of the dictionary's keys, with |
| 23272 | values that exactly match the supplied values. If None |
| 23273 | (the default), all smith objects are selected. If a |
| 23274 | function, it must be a function accepting a single argument and |
| 23275 | returning a boolean. The function will be called on each |
| 23276 | smith and those for which the function returned True will |
| 23277 | be in the selection. |
| 23278 | overwrite: bool |
| 23279 | If True, overwrite existing properties. If False, apply updates |
| 23280 | to existing properties recursively, preserving existing |
| 23281 | properties that are not specified in the update operation. |
| 23282 | row, col: int or None (default None) |
| 23283 | Subplot row and column index of smith objects to select. |
| 23284 | To select smith objects by row and column, the Figure |
| 23285 | must have been created using plotly.subplots.make_subplots. |
| 23286 | If None (the default), all smith objects are selected. |
| 23287 | **kwargs |
| 23288 | Additional property updates to apply to each selected |
| 23289 | smith object. If a property is specified in |
| 23290 | both patch and in **kwargs then the one in **kwargs |
| 23291 | takes precedence. |
| 23292 | Returns |
| 23293 | ------- |
| 23294 | self |
| 23295 | Returns the FigureWidget object that the method was called on |
| 23296 | """ |
| 23297 | for obj in self.select_smiths(selector=selector, row=row, col=col): |
| 23298 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 23299 | |
| 23300 | return self |
| 23301 | |
| 23302 | def select_ternaries(self, selector=None, row=None, col=None): |
| 23303 | """ |
nothing calls this directly
no test coverage detected