Perform a property update operation on all xaxis objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all xaxis objects that satisfy the selection crit
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 23474 | return self |
| 23475 | |
| 23476 | def update_xaxes( |
| 23477 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 23478 | ) -> "Figure": |
| 23479 | """ |
| 23480 | Perform a property update operation on all xaxis objects |
| 23481 | that satisfy the specified selection criteria |
| 23482 | |
| 23483 | Parameters |
| 23484 | ---------- |
| 23485 | patch: dict |
| 23486 | Dictionary of property updates to be applied to all |
| 23487 | xaxis objects that satisfy the selection criteria. |
| 23488 | selector: dict, function, or None (default None) |
| 23489 | Dict to use as selection criteria. |
| 23490 | xaxis objects will be selected if they contain |
| 23491 | properties corresponding to all of the dictionary's keys, with |
| 23492 | values that exactly match the supplied values. If None |
| 23493 | (the default), all xaxis objects are selected. If a |
| 23494 | function, it must be a function accepting a single argument and |
| 23495 | returning a boolean. The function will be called on each |
| 23496 | xaxis and those for which the function returned True will |
| 23497 | be in the selection. |
| 23498 | overwrite: bool |
| 23499 | If True, overwrite existing properties. If False, apply updates |
| 23500 | to existing properties recursively, preserving existing |
| 23501 | properties that are not specified in the update operation. |
| 23502 | row, col: int or None (default None) |
| 23503 | Subplot row and column index of xaxis objects to select. |
| 23504 | To select xaxis objects by row and column, the Figure |
| 23505 | must have been created using plotly.subplots.make_subplots. |
| 23506 | If None (the default), all xaxis objects are selected. |
| 23507 | **kwargs |
| 23508 | Additional property updates to apply to each selected |
| 23509 | xaxis object. If a property is specified in |
| 23510 | both patch and in **kwargs then the one in **kwargs |
| 23511 | takes precedence. |
| 23512 | Returns |
| 23513 | ------- |
| 23514 | self |
| 23515 | Returns the Figure object that the method was called on |
| 23516 | """ |
| 23517 | for obj in self.select_xaxes(selector=selector, row=row, col=col): |
| 23518 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 23519 | |
| 23520 | return self |
| 23521 | |
| 23522 | def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None): |
| 23523 | """ |