Select yaxis subplot objects from a particular subplot cell and/or yaxis subplot objects that satisfy custom selection criteria. Parameters ---------- selector: dict, function, or None (default None) Dict to use as selection criteria.
(self, selector=None, row=None, col=None, secondary_y=None)
| 23524 | return self |
| 23525 | |
| 23526 | def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None): |
| 23527 | """ |
| 23528 | Select yaxis subplot objects from a particular subplot cell |
| 23529 | and/or yaxis subplot objects that satisfy custom selection |
| 23530 | criteria. |
| 23531 | |
| 23532 | Parameters |
| 23533 | ---------- |
| 23534 | selector: dict, function, or None (default None) |
| 23535 | Dict to use as selection criteria. |
| 23536 | yaxis objects will be selected if they contain |
| 23537 | properties corresponding to all of the dictionary's keys, with |
| 23538 | values that exactly match the supplied values. If None |
| 23539 | (the default), all yaxis objects are selected. If a |
| 23540 | function, it must be a function accepting a single argument and |
| 23541 | returning a boolean. The function will be called on each |
| 23542 | yaxis and those for which the function returned True will |
| 23543 | be in the selection. |
| 23544 | row, col: int or None (default None) |
| 23545 | Subplot row and column index of yaxis objects to select. |
| 23546 | To select yaxis objects by row and column, the Figure |
| 23547 | must have been created using plotly.subplots.make_subplots. |
| 23548 | If None (the default), all yaxis objects are selected. |
| 23549 | secondary_y: boolean or None (default None) |
| 23550 | * If True, only select yaxis objects associated with the secondary |
| 23551 | y-axis of the subplot. |
| 23552 | * If False, only select yaxis objects associated with the primary |
| 23553 | y-axis of the subplot. |
| 23554 | * If None (the default), do not filter yaxis objects based on |
| 23555 | a secondary y-axis condition. |
| 23556 | |
| 23557 | To select yaxis objects by secondary y-axis, the Figure must |
| 23558 | have been created using plotly.subplots.make_subplots. See |
| 23559 | the docstring for the specs argument to make_subplots for more |
| 23560 | info on creating subplots with secondary y-axes. |
| 23561 | Returns |
| 23562 | ------- |
| 23563 | generator |
| 23564 | Generator that iterates through all of the yaxis |
| 23565 | objects that satisfy all of the specified selection criteria |
| 23566 | """ |
| 23567 | |
| 23568 | return self._select_layout_subplots_by_prefix( |
| 23569 | "yaxis", selector, row, col, secondary_y=secondary_y |
| 23570 | ) |
| 23571 | |
| 23572 | def for_each_yaxis( |
| 23573 | self, fn, selector=None, row=None, col=None, secondary_y=None |
no test coverage detected