Perform a property update operation on all yaxis objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all yaxis objects that satisfy the selection crit
(
self,
patch=None,
selector=None,
overwrite=False,
row=None,
col=None,
secondary_y=None,
**kwargs,
)
| 23616 | return self |
| 23617 | |
| 23618 | def update_yaxes( |
| 23619 | self, |
| 23620 | patch=None, |
| 23621 | selector=None, |
| 23622 | overwrite=False, |
| 23623 | row=None, |
| 23624 | col=None, |
| 23625 | secondary_y=None, |
| 23626 | **kwargs, |
| 23627 | ) -> "Figure": |
| 23628 | """ |
| 23629 | Perform a property update operation on all yaxis objects |
| 23630 | that satisfy the specified selection criteria |
| 23631 | |
| 23632 | Parameters |
| 23633 | ---------- |
| 23634 | patch: dict |
| 23635 | Dictionary of property updates to be applied to all |
| 23636 | yaxis objects that satisfy the selection criteria. |
| 23637 | selector: dict, function, or None (default None) |
| 23638 | Dict to use as selection criteria. |
| 23639 | yaxis objects will be selected if they contain |
| 23640 | properties corresponding to all of the dictionary's keys, with |
| 23641 | values that exactly match the supplied values. If None |
| 23642 | (the default), all yaxis objects are selected. If a |
| 23643 | function, it must be a function accepting a single argument and |
| 23644 | returning a boolean. The function will be called on each |
| 23645 | yaxis and those for which the function returned True will |
| 23646 | be in the selection. |
| 23647 | overwrite: bool |
| 23648 | If True, overwrite existing properties. If False, apply updates |
| 23649 | to existing properties recursively, preserving existing |
| 23650 | properties that are not specified in the update operation. |
| 23651 | row, col: int or None (default None) |
| 23652 | Subplot row and column index of yaxis objects to select. |
| 23653 | To select yaxis objects by row and column, the Figure |
| 23654 | must have been created using plotly.subplots.make_subplots. |
| 23655 | If None (the default), all yaxis objects are selected. |
| 23656 | secondary_y: boolean or None (default None) |
| 23657 | * If True, only select yaxis objects associated with the secondary |
| 23658 | y-axis of the subplot. |
| 23659 | * If False, only select yaxis objects associated with the primary |
| 23660 | y-axis of the subplot. |
| 23661 | * If None (the default), do not filter yaxis objects based on |
| 23662 | a secondary y-axis condition. |
| 23663 | |
| 23664 | To select yaxis objects by secondary y-axis, the Figure must |
| 23665 | have been created using plotly.subplots.make_subplots. See |
| 23666 | the docstring for the specs argument to make_subplots for more |
| 23667 | info on creating subplots with secondary y-axes. |
| 23668 | **kwargs |
| 23669 | Additional property updates to apply to each selected |
| 23670 | yaxis object. If a property is specified in |
| 23671 | both patch and in **kwargs then the one in **kwargs |
| 23672 | takes precedence. |
| 23673 | Returns |
| 23674 | ------- |
| 23675 | self |