MCPcopy Index your code
hub / github.com/plotly/plotly.py / update_mapboxes

Method update_mapboxes

plotly/graph_objs/_figurewidget.py:22920–22964  ·  view source on GitHub ↗

Perform a property update operation on all mapbox objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all mapbox objects that satisfy the selection cr

(
        self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
    )

Source from the content-addressed store, hash-verified

22918 return self
22919
22920 def update_mapboxes(
22921 self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
22922 ) -> "FigureWidget":
22923 """
22924 Perform a property update operation on all mapbox objects
22925 that satisfy the specified selection criteria
22926
22927 Parameters
22928 ----------
22929 patch: dict
22930 Dictionary of property updates to be applied to all
22931 mapbox objects that satisfy the selection criteria.
22932 selector: dict, function, or None (default None)
22933 Dict to use as selection criteria.
22934 mapbox objects will be selected if they contain
22935 properties corresponding to all of the dictionary's keys, with
22936 values that exactly match the supplied values. If None
22937 (the default), all mapbox objects are selected. If a
22938 function, it must be a function accepting a single argument and
22939 returning a boolean. The function will be called on each
22940 mapbox and those for which the function returned True will
22941 be in the selection.
22942 overwrite: bool
22943 If True, overwrite existing properties. If False, apply updates
22944 to existing properties recursively, preserving existing
22945 properties that are not specified in the update operation.
22946 row, col: int or None (default None)
22947 Subplot row and column index of mapbox objects to select.
22948 To select mapbox objects by row and column, the Figure
22949 must have been created using plotly.subplots.make_subplots.
22950 If None (the default), all mapbox objects are selected.
22951 **kwargs
22952 Additional property updates to apply to each selected
22953 mapbox object. If a property is specified in
22954 both patch and in **kwargs then the one in **kwargs
22955 takes precedence.
22956 Returns
22957 -------
22958 self
22959 Returns the FigureWidget object that the method was called on
22960 """
22961 for obj in self.select_mapboxes(selector=selector, row=row, col=col):
22962 obj.update(patch, overwrite=overwrite, **kwargs)
22963
22964 return self
22965
22966 def select_polars(self, selector=None, row=None, col=None):
22967 """

Callers

nothing calls this directly

Calls 2

select_mapboxesMethod · 0.95
updateMethod · 0.45

Tested by

no test coverage detected