genome_spy.StackParams

class genome_spy.StackParams(as_=Undefined, baseField=Undefined, cardinality=Undefined, description=Undefined, field=Undefined, groupby=Undefined, offset=Undefined, sort=Undefined, type=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for StackParams.

Methods

as_(value)	Return a copy with as updated.
baseField(value)	Return a copy with baseField updated.
cardinality(value)	Return a copy with cardinality updated.
copy(*[, deep])	Return a copy with optional keyword updates.
description(value)	Return a copy with description updated.
field(value)	Return a copy with field updated.
groupby(value)	Return a copy with groupby updated.
offset(value)	Return a copy with offset updated.
resolve_references()	Return this class schema with referenced properties merged in.
sort([value, field, order])	Return a copy with a CompareParams sort.
to_dict(*[, validate])	Serialize this schema wrapper to a JSON-compatible dictionary.
to_json(*[, validate])	Serialize this schema wrapper to formatted JSON.
type(value)	Return a copy with type updated.
validate(instance)	Validate an instance against this wrapper's schema.

as_(value)View on GitHub

Return a copy with as updated.

baseField(value)View on GitHub

Return a copy with baseField updated.

cardinality(value)View on GitHub

Return a copy with cardinality updated.

description(value)View on GitHub

Return a copy with description updated.

field(value)View on GitHub

Return a copy with field updated.

groupby(value)View on GitHub

Return a copy with groupby updated.

offset(value)View on GitHub

Return a copy with offset updated.

sort(value=Undefined, /, *, field=Undefined, order=Undefined)View on GitHub

Return a copy with a CompareParams sort.

Parameters:

• field (Sequence[Field_T] | Field_T) – The field(s) to sort by

• order (Sequence[SortOrder_T] | SortOrder_T) – The order(s) to use: "ascending" (default), "descending".

type(value)View on GitHub

Return a copy with type 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.