key_range_manual ¶

key_range_manual(
    start: KeyBound | Sequence[KeyBound],
    end: KeyBound | Sequence[KeyBound],
    name: str | Sequence[str] | None = None,
) -> RangeKey

Give the groups of guide_axis_nested() by their first and last break (legendry).

Parameters:

start (str, float or sequence of them) –

First category (discrete axes) or value (continuous axes) of each group.
end (str, float or sequence of them) –

Last category or value of each group, aligned with start.
name (str or sequence of str, default: None ) –

Each group's name ("\n" breaks lines). Without names only brackets are drawn.

Returns:

RangeKey –

The key for guide_axis_nested(key=...).

Raises:

SpecError –

If start, end and name differ in length.
UnsupportedValueError –

If a bound is not a category or a finite number.

Examples:

>>> from ggrust import *
>>> key = key_range_manual(start=["apple", "date"], end=["cherry", "fig"],
...                        name=["Early", "Late"])
>>> len(key.as_spec())
2