From 2d9f248c04fce106cda742b91748c2746eb6c25c Mon Sep 17 00:00:00 2001 From: dangotbanned <125183946+dangotbanned@users.noreply.github.com> Date: Sun, 15 Sep 2024 18:09:31 +0100 Subject: [PATCH] docs: Add `IntoCondition`, `_Conditional` docs https://github.com/vega/altair/pull/3567#discussion_r1760103943 --- altair/vegalite/v5/api.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/altair/vegalite/v5/api.py b/altair/vegalite/v5/api.py index 80ba0bd6b..26415c5f8 100644 --- a/altair/vegalite/v5/api.py +++ b/altair/vegalite/v5/api.py @@ -661,11 +661,29 @@ class _ConditionClosed(TypedDict, closed=True, total=False): # type: ignore[cal class _Conditional(TypedDict, t.Generic[_C], total=False): + """ + A dictionary representation of a conditional encoding or property. + + Parameters + ---------- + condition + One or more (predicate, statement) pairs which each form a condition. + value + An optional default value, used when no predicates were met. + """ + condition: Required[_C] value: Any IntoCondition: TypeAlias = Union[ConditionLike, _Conditional[Any]] +""" +Anything that can be converted into a conditional encoding or property. + +Notes +----- +Represents all outputs from `when-then-otherwise` conditions, which are not ``SchemaBase`` types. +""" class _Value(TypedDict, closed=True, total=False): # type: ignore[call-arg]