genome_spy.SelectionParameter

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

Bases: GenomeSpySchema

Generated wrapper for SelectionParameter.

Methods

bind(value)	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.
select([value, clear, encodings, on, ...])	Return a copy with select 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)	Return a copy with value updated.

bind(value)View on GitHub

Return a copy with bind updated.

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.

select(value=Undefined, /, *, clear=Undefined, encodings=Undefined, on=Undefined, toggle=Undefined, type=Undefined)View on GitHub

Return a copy with select updated.

Parameters:

• clear (DomEventType_T | EventConfig | EventConfigKwds | str | bool) – A string or object that defines the events that should clear the selection. Set to false to disable these events. Legend-bound point selections also reset on unmodified background clicks, independently of this property. __Default value:__ "dblclick"; no clear event for legend-bound point selections.

• encodings (Sequence[Literal['shape']]) – Schema-defined encodings property.

• on (DomEventType_T | EventConfig | EventConfigKwds | str) – A string or object that defines the events to which the selection should listen. __Default value:__ - point selections: "click" - interval selections: - "mousedown[event.shiftKey]" when any brushed channel is zoomable - "mousedown" otherwise

• toggle (bool) – Controls whether input events with Shift pressed add or remove selected values. - true – values can be added or removed while holding Shift. - false – only a single value can be selected at a time. __Default value:__ true when on uses "click", false otherwise.

• type (Literal['point']) – The selection type. - "point" – to select multiple discrete data values; the first value is selected on click and additional values toggled on shift-click. - "interval" – to select a continuous range of data values on drag.

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.