genome_spy.ValueDefWithConditionStringNullTypeForShape

class genome_spy.ValueDefWithConditionStringNullTypeForShape(condition=Undefined, description=Undefined, title=Undefined, value=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for ValueDefWithCondition<(string|null),TypeForShape>.

Methods

condition([value, band, datum, description, ...])	Return a copy with condition updated.
copy(*[, deep])	Return a copy with optional keyword updates.
description(value)	Return a copy with description updated.
resolve_references()	Return this class schema with referenced properties merged in.
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.

condition(value=Undefined, /, *, band=Undefined, datum=Undefined, description=Undefined, domainInert=Undefined, empty=Undefined, expr=Undefined, field=Undefined, format=Undefined, legend=Undefined, param=Undefined, project=Undefined, resolutionChannel=Undefined, scale=Undefined, test=Undefined, title=Undefined, type=Undefined)View on GitHub

Return a copy with condition updated.

Parameters:

• band (float) – Schema-defined band property.

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

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

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

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

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

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

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

• legend (Legend | LegendKwds | None) – Schema-defined legend property.

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

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

• resolutionChannel (ChannelWithScale_T) – Schema-defined resolutionChannel property.

• scale (Scale | ScaleKwds | None) – Schema-defined scale property.

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

• title (str | None) – Schema-defined title property.

• type (TypeForShape_T | Type_T) – Schema-defined type property.

description(value)View on GitHub

Return a copy with description updated.

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.