genome_spy.FieldOrDatumDefWithConditionScaleDatumDefStringNull¶

class genome_spy.FieldOrDatumDefWithConditionScaleDatumDefStringNull(band=Undefined, condition=Undefined, datum=Undefined, description=Undefined, domainInert=Undefined, resolutionChannel=Undefined, scale=Undefined, title=Undefined, type=Undefined, **kwds)View on GitHub ¶

Bases: GenomeSpySchema

Generated wrapper for FieldOrDatumDefWithCondition<ScaleDatumDef,(string|null)>.

Methods

`band`(value)	Return a copy with `band` updated.
`condition`([value, description, empty, ...])	Return a copy with `condition` updated.
`copy`(*[, deep])	Return a copy with optional keyword updates.
`datum`([value, expr])	Return a copy with `datum` updated.
`description`(value)	Return a copy with `description` updated.
`domainInert`(value)	Return a copy with `domainInert` updated.
`resolutionChannel`(value)	Return a copy with `resolutionChannel` updated.
`resolve_references`()	Return this class schema with referenced properties merged in.
`scale`([value, align, assembly, base, bins, ...])	Return a copy with a `Scale` scale.
`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.
`type`(value)	Return a copy with `type` updated.
`validate`(instance)	Validate an instance against this wrapper's schema.

band(value)View on GitHub ¶: Return a copy with band updated.

condition(value=Undefined, /, *, description=Undefined, empty=Undefined, param=Undefined, project=Undefined, test=Undefined, title=Undefined)View on GitHub ¶

Return a copy with condition updated.

Parameters:

description (str) – Schema-defined description property.
empty (bool) – For selection parameters, the predicate of empty selections returns true by default. Override this behavior, by setting this property empty: false.
param (str) – Filter using a parameter name.
project (dict[str, Any]) – Bind selection components to inputs of this consuming mark. For example, { "x": "x2" } tests the selected x interval against x2 alone. Each selected component must be mapped when this is provided. Category components map to unconditional categorical channel inputs. Numeric color, fill, and stroke intervals map to unconditional quantitative color inputs; omitted mappings use the same channel in this view. This mapping does not change the stored selection component or values.
test (SelectionPredicateOperand | dict[str, Any] | SelectionUnionTest | NamedSelectionPredicateRef) – Schema-defined test property.
title (str | None) – Schema-defined title property.

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

Return a copy with datum updated.

Parameters:: expr (str) – The expression string.

description(value)View on GitHub ¶: Return a copy with description updated.

domainInert(value)View on GitHub ¶: Return a copy with domainInert updated.

resolutionChannel(value)View on GitHub ¶: Return a copy with resolutionChannel updated.

scale(value=Undefined, /, *, align=Undefined, assembly=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainTransition=Undefined, exponent=Undefined, gapPositions=Undefined, gapWidth=Undefined, interpolate=Undefined, name=Undefined, nice=Undefined, numberingOffset=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, range=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, viewport=Undefined, zero=Undefined, zoom=Undefined)View on GitHub ¶

Return a copy with a Scale scale.

Parameters:

align (float) – The alignment of the steps within the scale range. This value must lie in the range [0,1]. A value of 0.5 indicates that the steps should be centered within the range. A value of 0 or 1 may be used to shift the bands to one side, say to position them adjacent to an axis. __Default value:__ 0.5
assembly (str | UrlGenomeDefinition | dict[str, Any] | InlineGenomeDefinition) – Genome assembly definition for locus scales. This can be: - A string reference to a named assembly (built-in or root-configured). - An inline anonymous assembly that defines either contigs or url. If undefined, the default genome from the genome store is used.
base (float) – The logarithm base of the log scale (default 10).
bins (Sequence[float]) – An array of bin boundaries over the scale domain. If provided, axes and legends will use the bin boundaries to inform the choice of tick marks and text labels.
clamp (bool) – If true, values that exceed the data domain are clamped to either the minimum or maximum range value __Default value:__ derived from the Vega-Lite scale config’s clamp (true by default).
constant (float) – A constant determining the slope of the symlog function around zero. Only used for symlog scales. __Default value:__ 1
domain (ScalarDomain_T | Sequence[ChromosomalLocus | dict[str, Any]] | SelectionDomainRef | dict[str, Any] | ViewportDomainRef | ExprRef | Sequence[float | str | bool | ExprRef | dict[str, Any]]) – Customized domain values. For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Vega-Lite piecewise scales can be created by providing a domain with more than two entries. For ordinal and nominal fields, domain can be an array that lists valid input values. The domain can also be defined by an expression reference that evaluates to the domain array. Array elements may also be expression references. All parameter names referenced by a scale, including selection-domain parameters, resolve from the view that owns the scale resolution. For a shared scale, declare controlling parameters on that owning composed view or an ancestor.
domainMax (float) – Sets the maximum value in the scale domain, overriding the domain property. This property is only intended for use with scales having continuous domains.
domainMid (float) – Inserts a single mid-point value into a two-element domain. The mid-point value must lie between the domain minimum and maximum values. This property can be useful for setting a midpoint for Vega-Lite diverging color scales. The domainMid property is only intended for use with scales supporting continuous, piecewise domains.
domainMin (float) – Sets the minimum value in the scale domain, overriding the domain property. This property is only intended for use with scales having continuous domains.
domainTransition (bool) – Controls whether domain updates are applied immediately or with a smooth transition. Set this to false to apply domain updates immediately. The default is true, except for domains that include ExprRef``s, which default to ``false unless overridden. __Default value:__ true, except false for ExprRef-driven domains.
exponent (float) – The exponent of the pow scale.
gapPositions (Sequence[str | float | bool] | Literal['chromosomes'] | ExprRef | dict[str, Any] | None) – Boundaries before which to insert grouping gaps on positional band, point, index, or locus scales. For band/point scales, list domain category values; numeric categories are values, not ranks. Missing or first categories add no gap. Index/locus cuts use numeric coordinates: 10 separates bands 9 and 10. "chromosomes" inserts gaps between the assembly’s chromosomes. Positions are deduplicated in domain order. An expression may return an array or null. Constant null or an empty array completely disables grouping gaps. __Default value:__ null.
gapWidth (float | ExprRef | dict[str, Any] | None) – Grouping gap width in CSS pixels, independent of zoom and device pixel ratio. An expression may return a nonnegative number or null. Constant zero or null completely disables grouping gaps. With step-based sizing, gaps add to plot size while the base step stays fixed. Band/point gaps do not support round: true. Nested categorical offsets under a gapped band require an explicit offset range. On a step-sized axis, gap expressions must be independent of the resulting plot width or height. __Default value:__ 6 when gapPositions is supplied, otherwise 0.
interpolate (ScaleInterpolate_T | ScaleInterpolateParams | ScaleInterpolateParamsKwds) – The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in HCL space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long (‘-long’ variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation. __Default value:__ hcl
name (str) – The name of the scale. Names are optional but allow the scales to be referenced and found with the API.
nice (bool | float | dict[str, Any]) – Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0]. For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain. __Default value:__ true for unbinned quantitative fields; false otherwise.
numberingOffset (float) – The offset added to data values when formatting tick labels on index and locus scales. This property does not transform data values. __Default value:__ 0
padding (float) – For Vega-Lite continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties. For Vega-Lite band scales, shortcut for setting paddingInner and paddingOuter to the same value. For Vega-Lite point scales, alias for paddingOuter. __Default value:__ For continuous scales, derived from the Vega-Lite scale config’s continuousPadding. For band and point scales, see paddingInner and paddingOuter. By default, Vega-Lite sets padding such that width/height = number of unique values * step.
paddingInner (float) – The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1]. For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands). __Default value:__ derived from the Vega-Lite scale config’s bandPaddingInner.
paddingOuter (float) – The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1]. __Default value:__ derived from the Vega-Lite scale config’s bandPaddingOuter for band scales and pointPadding for point scales. By default, Vega-Lite sets outer padding such that width/height = number of unique values * step.
range (Sequence[float | str | ExprRef | dict[str, Any]] | str) – The range of the scale. One of: - A string indicating a pre-defined named scale range from Vega-Lite (e.g., example, "symbol", or "diverging"). - For Vega-Lite continuous scales, two-element array indicating minimum and maximum values, or an array with more than two entries for specifying a Vega-Lite piecewise scale. Array elements may also be expression references, which use the parameter scope of the view that owns the scale resolution. - For Vega-Lite discrete and Vega-Lite discretizing scales, an array of desired output values. Array elements may also be expression references, which use the parameter scope of the view that owns the scale resolution. __Notes:__ 1) For color scales you can also specify a color scheme instead of range. 2) Any directly specified range for x and y channels will be ignored. Range can be customized via the view’s corresponding Vega-Lite size (width and height).
reverse (bool) – If true, reverses the order of the scale range. __Default value:__ false.
round (bool) – If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. __Default value:__ false.
scheme (str | SchemeParams | SchemeParamsKwds) – A string indicating a color Vega-Lite scheme name (e.g., "category10" or "blues") or a Vega-Lite scheme parameter object. Discrete color schemes may be used with Vega-Lite discrete or Vega-Lite discretizing scales. Continuous color schemes are intended for use with color scales. For the full list of supported schemes, please refer to the Vega Scheme reference.
type (ScaleType_T) – The type of scale. GenomeSpy follows the Vega-Lite scale model; the links below refer to the Vega-Lite documentation: 1) Continuous Scales – mapping continuous domains to continuous output ranges ("linear", "pow", "sqrt", "symlog", "log", "time", "utc"). 2) Discrete Scales – mapping discrete domains to discrete ("ordinal") or continuous ("band" and "point") output ranges. 3) Discretizing Scales – mapping continuous domains to discrete output ranges "bin-ordinal", "quantile", "quantize" and "threshold". GenomeSpy also provides index and locus scales for sequence and genomic coordinates. __Default value:__ please see the Vega-Lite scale type table.
viewport (Sequence[float] | None) – Initial and reset scale viewport for positional band or point scales, expressed as a half-open rank interval. Fractional endpoints allow smooth navigation. Intervals narrower than one category expand around their midpoint to span one category. The categorical domain retains its membership and order. Categorical zoom uses boolean zoom and is bounded by the full domain. This scale viewport differs from a layout viewport, which scrolls already-laid-out content using viewportWidth or viewportHeight. __Default value:__ null, fitting all categories.
zero (bool) – If true, ensures that a zero baseline value is included in the scale domain. __Default value:__ true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise. __Note:__ Log scales do not support zero.
zoom (bool | ZoomParams | ZoomParamsKwds) – Enable interactive zooming and panning on a positional scale. Band and point scales accept a boolean and navigate their scale viewport while retaining the full categorical domain. Continuous scales also accept zoom extent options. __Default value:__ true for index and locus scales; false otherwise.

title(value)View on GitHub ¶: Return a copy with title updated.

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.