Perform a property update operation on all map objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all map objects that satisfy the selection criteria
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 22802 | return self |
| 22803 | |
| 22804 | def update_maps( |
| 22805 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 22806 | ) -> "Figure": |
| 22807 | """ |
| 22808 | Perform a property update operation on all map objects |
| 22809 | that satisfy the specified selection criteria |
| 22810 | |
| 22811 | Parameters |
| 22812 | ---------- |
| 22813 | patch: dict |
| 22814 | Dictionary of property updates to be applied to all |
| 22815 | map objects that satisfy the selection criteria. |
| 22816 | selector: dict, function, or None (default None) |
| 22817 | Dict to use as selection criteria. |
| 22818 | map objects will be selected if they contain |
| 22819 | properties corresponding to all of the dictionary's keys, with |
| 22820 | values that exactly match the supplied values. If None |
| 22821 | (the default), all map objects are selected. If a |
| 22822 | function, it must be a function accepting a single argument and |
| 22823 | returning a boolean. The function will be called on each |
| 22824 | map and those for which the function returned True will |
| 22825 | be in the selection. |
| 22826 | overwrite: bool |
| 22827 | If True, overwrite existing properties. If False, apply updates |
| 22828 | to existing properties recursively, preserving existing |
| 22829 | properties that are not specified in the update operation. |
| 22830 | row, col: int or None (default None) |
| 22831 | Subplot row and column index of map objects to select. |
| 22832 | To select map objects by row and column, the Figure |
| 22833 | must have been created using plotly.subplots.make_subplots. |
| 22834 | If None (the default), all map objects are selected. |
| 22835 | **kwargs |
| 22836 | Additional property updates to apply to each selected |
| 22837 | map object. If a property is specified in |
| 22838 | both patch and in **kwargs then the one in **kwargs |
| 22839 | takes precedence. |
| 22840 | Returns |
| 22841 | ------- |
| 22842 | self |
| 22843 | Returns the Figure object that the method was called on |
| 22844 | """ |
| 22845 | for obj in self.select_maps(selector=selector, row=row, col=col): |
| 22846 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 22847 | |
| 22848 | return self |
| 22849 | |
| 22850 | def select_mapboxes(self, selector=None, row=None, col=None): |
| 22851 | """ |
no test coverage detected