genome_spy.RulerConfig

class genome_spy.RulerConfig(clear=Undefined, disabled=Undefined, display=Undefined, encodings=Undefined, extent=Undefined, mark=Undefined, on=Undefined, snap=Undefined, source=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for RulerConfig.

Methods

clear(value)	Return a copy with clear updated.
copy(*[, deep])	Return a copy with optional keyword updates.
disabled([value, expr])	Return a copy with a ExprRef disabled.
display(value)	Return a copy with display updated.
encodings(value)	Return a copy with encodings updated.
extent(value)	Return a copy with extent updated.
mark([value, fill, fillOpacity, opacity, ...])	Return a copy with a RulerMarkConfig mark.
on([value, filter, type])	Return a copy with on updated.
resolve_references()	Return this class schema with referenced properties merged in.
snap(value)	Return a copy with snap updated.
source(value)	Return a copy with source 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.

clear(value)View on GitHub

Return a copy with clear updated.

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

Return a copy with a ExprRef disabled.

Parameters:

expr (str) – The expression string.

display(value)View on GitHub

Return a copy with display updated.

encodings(value)View on GitHub

Return a copy with encodings updated.

extent(value)View on GitHub

Return a copy with extent updated.

mark(value=Undefined, /, *, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shadowBlur=Undefined, shadowColor=Undefined, shadowOffsetX=Undefined, shadowOffsetY=Undefined, shadowOpacity=Undefined, stroke=Undefined, strokeDash=Undefined, strokeWidth=Undefined, zindex=Undefined)View on GitHub

Return a copy with a RulerMarkConfig mark.

Parameters:

• fill (str | ExprRef | dict[str, Any]) – Fill color for display: "band".

• fillOpacity (float | ExprRef | dict[str, Any]) – Fill opacity for display: "band".

• opacity (float | ExprRef | dict[str, Any]) – Overall opacity of the guide, including band fill, outline, and shadow. Setting opacity to zero hides the guide without stopping coordinate tracking or changing its clear behavior.

• shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value: 0

• shadowColor (str | ExprRef | dict[str, Any]) – The color of the drop shadow. Any valid CSS color string is allowed. Default value: "black"

• shadowOffsetX (float | ExprRef | dict[str, Any]) – The horizontal offset of the drop shadow in pixels. Positive values move the shadow to the right. Default value: 0

• shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value: 0

• shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between 0 (fully transparent) and 1 (fully opaque). Default value: 0 (disabled)

• stroke (str | ExprRef | dict[str, Any]) – Stroke color of ruler lines and band outlines.

• strokeDash (Sequence[float]) – Alternating stroke and gap lengths for dashed ruler lines. Does not affect band outlines.

• strokeWidth (float | ExprRef | dict[str, Any]) – Stroke width of ruler lines and band outlines, in pixels.

• zindex (float) – Z-order relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. The default value depends on the element type.

on(value=Undefined, /, *, filter=Undefined, type=Undefined)View on GitHub

Return a copy with on updated.

Parameters:

• filter (str) – Optional filter expression that must evaluate to true before the event updates the ruler.

• type (RulerEventType_T) – Event that updates a pointer-driven ruler.

snap(value)View on GitHub

Return a copy with snap updated.

source(value)View on GitHub

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