genome_spy.ValueParameter

class genome_spy.ValueParameter(bind=Undefined, description=Undefined, name=Undefined, persist=Undefined, push=Undefined, transition=Undefined, value=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for ValueParameter.

Methods

bind([value, autocomplete, debounce, ...])

Return a copy with bind updated.

copy(*[, deep])

Return a copy with optional keyword updates.

description(value)

Return a copy with description updated.

name(value)

Return a copy with name updated.

persist(value)

Return a copy with persist updated.

push(value)

Return a copy with push updated.

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.

transition([value, epsilon, halfLife, type])

Return a copy with transition updated.

validate(instance)

Validate an instance against this wrapper's schema.

value(value)

Return a copy with value updated.
bind(value=Undefined, /, *, autocomplete=Undefined, debounce=Undefined, description=Undefined, input=Undefined, labels=Undefined, max=Undefined, min=Undefined, name=Undefined, options=Undefined, placeholder=Undefined, step=Undefined)View on GitHub

Return a copy with bind updated.

Parameters:

  • autocomplete (str) – A hint for form autofill. See the HTML autocomplete attribute for additional information.

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

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

  • input (Literal['checkbox'] | Literal['radio', 'select'] | Literal['range'] | Literal['text', 'number', 'color']) – Schema-defined input property.

  • labels (Sequence[str]) – An array of label strings to represent the options values. If unspecified, the options value will be coerced to a string and used as the label.

  • max (float) – Sets the maximum slider value. Defaults to the larger of the signal value and 100.

  • min (float) – Sets the minimum slider value. Defaults to the smaller of the signal value and 0.

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

  • options (Sequence[Any]) – An array of options to select from.

  • placeholder (str) – Text that appears in the form control when it has no value set.

  • step (float) – Sets the minimum slider increment. If undefined, the step size will be automatically determined based on the min and max values.

description(value)View on GitHub

Return a copy with description updated.

name(value)View on GitHub

Return a copy with name updated.

persist(value)View on GitHub

Return a copy with persist updated.

push(value)View on GitHub

Return a copy with push updated.

transition(value=Undefined, /, *, epsilon=Undefined, halfLife=Undefined, type=Undefined)View on GitHub

Return a copy with transition updated.

Parameters:

  • epsilon (float) – Distance from the target at which the current value snaps to the target. __Default value:__ 0.01

  • halfLife (float) – Time in milliseconds for the remaining distance to the target to halve. __Default value:__ 80

  • type (Literal['lerp']) – The transition algorithm.

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.