genome_spy.ConditionalValueDefStringNullExprRef

class genome_spy.ConditionalValueDefStringNullExprRef(description=Undefined, empty=Undefined, param=Undefined, project=Undefined, test=Undefined, title=Undefined, value=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for Conditional<ValueDef<(string|null|ExprRef)>>.

Methods

copy(*[, deep])	Return a copy with optional keyword updates.
description(value)	Return a copy with description updated.
empty(value)	Return a copy with empty updated.
param(value)	Return a copy with param updated.
project([value, color, fill, shape, stroke, ...])	Return a copy with project updated.
resolve_references()	Return this class schema with referenced properties merged in.
test([value, and_, empty, not_, or_, param, ...])	Return a copy with test updated.
title(value)	Return a copy with title updated.
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, expr])	Return a copy with a ExprRef value.

description(value)View on GitHub

Return a copy with description updated.

empty(value)View on GitHub

Return a copy with empty updated.

param(value)View on GitHub

Return a copy with param updated.

project(value=Undefined, /, *, color=Undefined, fill=Undefined, shape=Undefined, stroke=Undefined, x=Undefined, y=Undefined)View on GitHub

Return a copy with project updated.

Parameters:

• color (CategorySelectionChannel_T) – Schema-defined color property.

• fill (CategorySelectionChannel_T) – Schema-defined fill property.

• shape (CategorySelectionChannel_T) – Schema-defined shape property.

• stroke (CategorySelectionChannel_T) – Schema-defined stroke property.

• x (Literal['x', 'x2'] | CategorySelectionChannel_T) – Schema-defined x property.

• y (Literal['y', 'y2'] | CategorySelectionChannel_T) – Schema-defined y property.

test(value=Undefined, /, *, and_=Undefined, empty=Undefined, not_=Undefined, or_=Undefined, param=Undefined, project=Undefined, ref=Undefined)View on GitHub

Return a copy with test updated.

Parameters:

• and_ (Sequence[SelectionPredicateOperand | dict[str, Any]]) – Schema-defined and property.

• empty (bool) – Schema-defined empty property.

• not_ (SelectionPredicateOperand | dict[str, Any]) – Schema-defined not property.

• or_ (Sequence[SelectionPredicateOperand | dict[str, Any]]) – Schema-defined or property.

• param (str | dict[str, Any]) – Schema-defined param property.

• 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.

• ref (str) – Schema-defined ref property.

title(value)View on GitHub

Return a copy with title updated.

value(value=Undefined, /, *, expr=Undefined)View on GitHub

Return a copy with a ExprRef value.

Parameters:

expr (str) – The expression string.

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.