Perform a property update operation on all ternary objects that satisfy the specified selection criteria Parameters ---------- patch: dict Dictionary of property updates to be applied to all ternary objects that satisfy the selection
(
self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs
)
| 23362 | return self |
| 23363 | |
| 23364 | def update_ternaries( |
| 23365 | self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs |
| 23366 | ) -> "Figure": |
| 23367 | """ |
| 23368 | Perform a property update operation on all ternary objects |
| 23369 | that satisfy the specified selection criteria |
| 23370 | |
| 23371 | Parameters |
| 23372 | ---------- |
| 23373 | patch: dict |
| 23374 | Dictionary of property updates to be applied to all |
| 23375 | ternary objects that satisfy the selection criteria. |
| 23376 | selector: dict, function, or None (default None) |
| 23377 | Dict to use as selection criteria. |
| 23378 | ternary objects will be selected if they contain |
| 23379 | properties corresponding to all of the dictionary's keys, with |
| 23380 | values that exactly match the supplied values. If None |
| 23381 | (the default), all ternary objects are selected. If a |
| 23382 | function, it must be a function accepting a single argument and |
| 23383 | returning a boolean. The function will be called on each |
| 23384 | ternary and those for which the function returned True will |
| 23385 | be in the selection. |
| 23386 | overwrite: bool |
| 23387 | If True, overwrite existing properties. If False, apply updates |
| 23388 | to existing properties recursively, preserving existing |
| 23389 | properties that are not specified in the update operation. |
| 23390 | row, col: int or None (default None) |
| 23391 | Subplot row and column index of ternary objects to select. |
| 23392 | To select ternary objects by row and column, the Figure |
| 23393 | must have been created using plotly.subplots.make_subplots. |
| 23394 | If None (the default), all ternary objects are selected. |
| 23395 | **kwargs |
| 23396 | Additional property updates to apply to each selected |
| 23397 | ternary object. If a property is specified in |
| 23398 | both patch and in **kwargs then the one in **kwargs |
| 23399 | takes precedence. |
| 23400 | Returns |
| 23401 | ------- |
| 23402 | self |
| 23403 | Returns the Figure object that the method was called on |
| 23404 | """ |
| 23405 | for obj in self.select_ternaries(selector=selector, row=row, col=col): |
| 23406 | obj.update(patch, overwrite=overwrite, **kwargs) |
| 23407 | |
| 23408 | return self |
| 23409 | |
| 23410 | def select_xaxes(self, selector=None, row=None, col=None): |
| 23411 | """ |
no test coverage detected