Perform a property update operation on all geo objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all geo objects that satisfy the selection criteria
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 22578 | return self |
| 22579 | |
| 22580 | def update_geos( |
| 22581 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 22582 | ) -> "Figure": |
| 22583 | """ |
| 22584 | Perform a property update operation on all geo objects |
| 22585 | that satisfy the specified selection criteria |
| 22586 | |
| 22587 | Parameters |
| 22588 | ---------- |
| 22589 | patch: dict |
| 22590 | Dictionary of property updates to be applied to all |
| 22591 | geo objects that satisfy the selection criteria. |
| 22592 | selector: dict, function, or None (default None) |
| 22593 | Dict to use as selection criteria. |
| 22594 | geo objects will be selected if they contain |
| 22595 | properties corresponding to all of the dictionary's keys, with |
| 22596 | values that exactly match the supplied values. If None |
| 22597 | (the default), all geo objects are selected. If a |
| 22598 | function, it must be a function accepting a single argument and |
| 22599 | returning a boolean. The function will be called on each |
| 22600 | geo and those for which the function returned True will |
| 22601 | be in the selection. |
| 22602 | overwrite: bool |
| 22603 | If True, overwrite existing properties. If False, apply updates |
| 22604 | to existing properties recursively, preserving existing |
| 22605 | properties that are not specified in the update operation. |
| 22606 | row, col: int or None (default None) |
| 22607 | Subplot row and column index of geo objects to select. |
| 22608 | To select geo objects by row and column, the Figure |
| 22609 | must have been created using plotly.subplots.make_subplots. |
| 22610 | If None (the default), all geo objects are selected. |
| 22611 | **kwargs |
| 22612 | Additional property updates to apply to each selected |
| 22613 | geo object. If a property is specified in |
| 22614 | both patch and in **kwargs then the one in **kwargs |
| 22615 | takes precedence. |
| 22616 | Returns |
| 22617 | ------- |
| 22618 | self |
| 22619 | Returns the Figure object that the method was called on |
| 22620 | """ |
| 22621 | for obj in self.select_geos(selector=selector, row=row, col=col): |
| 22622 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 22623 | |
| 22624 | return self |
| 22625 | |
| 22626 | def select_legends(self, selector=None, row=None, col=None): |
| 22627 | """ |
no test coverage detected