genome_spy.OrderDef

class genome_spy.OrderDef(condition=Undefined, value=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for OrderDef.

Methods

condition([value, empty, param, project, test])

Return a copy with a OrderCondition condition.

copy(*[, deep])

Return a copy with optional keyword updates.

resolve_references()

Return this class schema with referenced properties merged in.

to_dict(*[, validate])

Serialize this schema wrapper to a JSON-compatible dictionary.

to_json(*[, validate])

Serialize this schema wrapper to formatted JSON.

validate(instance)

Validate an instance against this wrapper's schema.

value(value)

Return a copy with value updated.

condition(value=Undefined, /, *, empty=Undefined, param=Undefined, project=Undefined, test=Undefined)View on GitHub

Return a copy with a OrderCondition condition.

Parameters:
  • empty (bool) – For selection parameters, the predicate of empty selections returns true by default. Override this behavior, by setting this property empty: false.

  • param (str) – Filter using a parameter name.

  • project (dict[str, Any]) – Bind selection components to inputs of this consuming mark. For example, { "x": "x2" } tests the selected x interval against x2 alone. Each selected component must be mapped when this is provided. Category components map to unconditional categorical channel inputs. Numeric color, fill, and stroke intervals map to unconditional quantitative color inputs; omitted mappings use the same channel in this view. This mapping does not change the stored selection component or values.

  • test (SelectionPredicateOperand | dict[str, Any] | SelectionUnionTest | NamedSelectionPredicateRef) – Schema-defined test property.

value(value)View on GitHub

Return a copy with value updated.

copy(*, deep=True, **kwds)View on GitHub

Return a copy with optional keyword updates.

classmethod resolve_references()View on GitHub

Return this class schema with referenced properties merged in.

to_dict(*, validate=True)View on GitHub

Serialize this schema wrapper to a JSON-compatible dictionary.

to_json(*, validate=True)View on GitHub

Serialize this schema wrapper to formatted JSON.

classmethod validate(instance)View on GitHub

Validate an instance against this wrapper’s schema.