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 select
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 22470 | return self |
| 22471 | |
| 22472 | def update_coloraxes( |
| 22473 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 22474 | ) -> "FigureWidget": |
| 22475 | """ |
| 22476 | Perform a property update operation on all coloraxis objects |
| 22477 | that satisfy the specified selection criteria |
| 22478 | |
| 22479 | Parameters |
| 22480 | ---------- |
| 22481 | patch: dict |
| 22482 | Dictionary of property updates to be applied to all |
| 22483 | coloraxis objects that satisfy the selection criteria. |
| 22484 | selector: dict, function, or None (default None) |
| 22485 | Dict to use as selection criteria. |
| 22486 | coloraxis objects will be selected if they contain |
| 22487 | properties corresponding to all of the dictionary's keys, with |
| 22488 | values that exactly match the supplied values. If None |
| 22489 | (the default), all coloraxis objects are selected. If a |
| 22490 | function, it must be a function accepting a single argument and |
| 22491 | returning a boolean. The function will be called on each |
| 22492 | coloraxis and those for which the function returned True will |
| 22493 | be in the selection. |
| 22494 | overwrite: bool |
| 22495 | If True, overwrite existing properties. If False, apply updates |
| 22496 | to existing properties recursively, preserving existing |
| 22497 | properties that are not specified in the update operation. |
| 22498 | row, col: int or None (default None) |
| 22499 | Subplot row and column index of coloraxis objects to select. |
| 22500 | To select coloraxis objects by row and column, the Figure |
| 22501 | must have been created using plotly.subplots.make_subplots. |
| 22502 | If None (the default), all coloraxis objects are selected. |
| 22503 | **kwargs |
| 22504 | Additional property updates to apply to each selected |
| 22505 | coloraxis object. If a property is specified in |
| 22506 | both patch and in **kwargs then the one in **kwargs |
| 22507 | takes precedence. |
| 22508 | Returns |
| 22509 | ------- |
| 22510 | self |
| 22511 | Returns the FigureWidget object that the method was called on |
| 22512 | """ |
| 22513 | for obj in self.select_coloraxes(selector=selector, row=row, col=col): |
| 22514 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 22515 | |
| 22516 | return self |
| 22517 | |
| 22518 | def select_geos(self, selector=None, row=None, col=None): |
| 22519 | """ |
nothing calls this directly
no test coverage detected