differt.plotting.process_kwargs

Contents

differt.plotting.process_kwargs#

process_kwargs(kwargs, backend=None)[source]#

Process keyword arguments passed to some plotting utility.

Parameters:
  • kwargs (MutableMapping[str, Any]) –

    A mutable mapping of keyword arguments passed to corresponding plotting backend.

    Warning

    Depending on the backend, some keys will be removed from the mapping.

  • backend (LiteralString | None) – The name of the backend to be passed to get_backend.

Return type:

tuple[Literal['vispy', 'matplotlib', 'plotly'], SceneCanvas | Figure | Figure, dict[str, Any]]

Returns:

The name of the backend, the corresponding canvas or figure, and backend-specific keyword arguments.