API reference¶

Every public object has its own page. Each class page opens with a summary table of its methods and attributes, followed by the full description of each one.

Most classes here are generated from the GenomeSpy JSON schema and keep their upstream names and property names, so types used in the grammar documents the same objects.

Chart and composition¶

Charts and composed views. Their methods return new objects, so a chart can be extended without mutating the original.

`Chart`	An immutable-style builder backed by generated `UnitSpec` state.
`ConcatChart`	A grid-concatenated GenomeSpy specification.
`FacetChart`	A plot repeated by category with shared scales and axes.
`HConcatChart`	A horizontally concatenated GenomeSpy specification.
`ImportedView`	A child-view import that can participate in chart composition.
`LayerChart`	A layered GenomeSpy specification.
`MultiscaleChart`	A semantic-zoom composition backed by generated schema state.
`SurroundChart`	A central plot with aligned marginal panels.
`TopLevelSpec`	Shared behavior for top-level GenomeSpy specifications.
`VConcatChart`	A vertically concatenated GenomeSpy specification.

Encoding channels¶

One class per encoding channel. Pass them to encode(), or use the field/type shorthand such as "score:Q" for simple cases.

`Angle`	Generated wrapper for the `angle` encoding channel.
`Color`	Generated wrapper for the `color` encoding channel.
`Direction`	Generated wrapper for the `direction` encoding channel.
`Dx`	Generated wrapper for the `dx` encoding channel.
`Dy`	Generated wrapper for the `dy` encoding channel.
`FacetIndex`	Generated wrapper for the `facetIndex` encoding channel.
`Fill`	Generated wrapper for the `fill` encoding channel.
`FillOpacity`	Generated wrapper for the `fillOpacity` encoding channel.
`Key`	Generated wrapper for the `key` encoding channel.
`Locus`	Create a GenomeSpy chromosomal locus channel definition.
`Opacity`	Generated wrapper for the `opacity` encoding channel.
`Order`	Generated wrapper for the `order` encoding channel.
`Sample`	Generated wrapper for the `sample` encoding channel.
`Search`	Generated wrapper for the `search` encoding channel.
`SemanticScore`	Generated wrapper for the `semanticScore` encoding channel.
`Shape`	Generated wrapper for the `shape` encoding channel.
`Size`	Generated wrapper for the `size` encoding channel.
`Stroke`	Generated wrapper for the `stroke` encoding channel.
`StrokeOpacity`	Generated wrapper for the `strokeOpacity` encoding channel.
`StrokeWidth`	Generated wrapper for the `strokeWidth` encoding channel.
`Text`	Generated wrapper for the `text` encoding channel.
`Tooltip`	Generated wrapper for the `tooltip` encoding channel.
`UniqueId`	Generated wrapper for the `uniqueId` encoding channel.
`X`	Generated wrapper for the `x` encoding channel.
`X2`	Generated wrapper for the `x2` encoding channel.
`X2Offset`	Generated wrapper for the `x2Offset` encoding channel.
`XOffset`	Generated wrapper for the `xOffset` encoding channel.
`Y`	Generated wrapper for the `y` encoding channel.
`Y2`	Generated wrapper for the `y2` encoding channel.
`Y2Offset`	Generated wrapper for the `y2Offset` encoding channel.
`YOffset`	Generated wrapper for the `yOffset` encoding channel.

API functions¶

Constructors and helpers for composition, encoding definitions, parameters, and schema objects.

`axes`	Create top-level shared axis configuration.
`binding`	Create a generic input binding.
`binding_checkbox`	Create a checkbox input binding.
`binding_radio`	Create a radio input binding.
`binding_range`	Create a range input binding.
`binding_select`	Create a select input binding.
`compare`	Create a sort/compare definition.
`concat`	Return a concat composition of the given charts.
`condition`	Create a parameter predicate for a conditional encoding value.
`config`	Create a top-level GenomeSpy config object.
`data_format`	Create a data-format wrapper.
`datum`	Build datum expressions or constant-datum channels.
`dynamic_opacity`	Create a zoom-dependent opacity definition.
`expr`	Build expression references, constants, and function calls.
`facet`	Return a facet composition of the given charts.
`hconcat`	Return a hconcat composition of the given charts.
`import_view`	Create an imported child view from a URL or template.
`layer`	Return a layer composition of the given charts.
`locus`	Create a GenomeSpy chromosomal locus channel definition.
`multiscale`	Return a multiscale composition of the given charts.
`param`	Create a reusable GenomeSpy parameter handle.
`parse`	Create a parse mapping for a data format.
`ruler`	Create a GenomeSpy `ruler` parameter.
`scales`	Create top-level shared scale configuration.
`selection_interval`	Create a GenomeSpy `selection_interval` parameter.
`selection_point`	Create a GenomeSpy `selection_point` parameter.
`step`	Create a step-sized dimension wrapper.
`surround`	Return a surround composition of the given charts.
`title`	Create a chart title object.
`to_arrow_ipc`	Serialize a DataFrame-like object as uncompressed Arrow IPC bytes.
`value`	Create a constant-value encoding channel.
`vconcat`	Return a vconcat composition of the given charts.
`view`	Create a view background configuration.
`view_config`	Create a top-level view config object.
`when`	Start an Altair-style selection condition.

Schema objects¶

Schema-backed configuration objects accepted by charts, channels, and helpers.

`AggregateOp`	Generated wrapper for `AggregateOp`.
`AggregateParams`	Generated wrapper for `AggregateParams`.
`Align`	Generated wrapper for `Align`.
`AlignmentMismatchesParams`	Generated wrapper for `AlignmentMismatchesParams`.
`ArrowConfig`	Generated wrapper for `ArrowConfig`.
`ArrowDirection`	Generated wrapper for `ArrowDirection`.
`ArrowProps`	Generated wrapper for `ArrowProps`.
`ArrowRelativeSize`	Generated wrapper for `ArrowRelativeSize`.
`ArrowSize`	Generated wrapper for `ArrowSize`.
`Axis`	Generated wrapper for `Axis`.
`AxisConfig`	Generated wrapper for `AxisConfig`.
`AxisGenomeData`	Generated wrapper for `AxisGenomeData`.
`AxisLabelLayoutParams`	Generated wrapper for `AxisLabelLayoutParams`.
`AxisOrient`	Generated wrapper for `AxisOrient`.
`AxisPlacement`	Generated wrapper for `AxisPlacement`.
`AxisTicksData`	Generated wrapper for `AxisTicksData`.
`BamData`	Generated wrapper for `BamData`.
`Baseline`	Generated wrapper for `Baseline`.
`BedDataFormat`	Generated wrapper for `BedDataFormat`.
`BedpeDataFormat`	Generated wrapper for `BedpeDataFormat`.
`BigBedData`	Generated wrapper for `BigBedData`.
`BigWigData`	Generated wrapper for `BigWigData`.
`BindCheckbox`	Generated wrapper for `BindCheckbox`.
`BindInput`	Generated wrapper for `BindInput`.
`BindRadioSelect`	Generated wrapper for `BindRadioSelect`.
`BindRange`	Generated wrapper for `BindRange`.
`Binding`	Generated wrapper for `Binding`.
`BranchParams`	Generated wrapper for `BranchParams`.
`BrushConfig`	Generated wrapper for `BrushConfig`.
`BuiltInThemeName`	Generated wrapper for `BuiltInThemeName`.
`CategorySelectionChannel`	Generated wrapper for `CategorySelectionChannel`.
`CategorySelectionParameterColor`	Generated wrapper for `CategorySelectionParameter<"color">`.
`CategorySelectionParameterFill`	Generated wrapper for `CategorySelectionParameter<"fill">`.
`CategorySelectionParameterShape`	Generated wrapper for `CategorySelectionParameter<"shape">`.
`CategorySelectionParameterStroke`	Generated wrapper for `CategorySelectionParameter<"stroke">`.
`CategorySelectionParameterX`	Generated wrapper for `CategorySelectionParameter<"x">`.
`CategorySelectionParameterY`	Generated wrapper for `CategorySelectionParameter<"y">`.
`ChannelWithScale`	Generated wrapper for `ChannelWithScale`.
`ChromPosDef`	Generated wrapper for `ChromPosDef`.
`ChromosomalLocus`	Generated wrapper for `ChromosomalLocus`.
`CollectParams`	Generated wrapper for `CollectParams`.
`ColorDef`	Generated wrapper for `ColorDef`.
`ColorSchemeConfig`	Generated wrapper for `ColorSchemeConfig`.
`CompareParams`	Generated wrapper for `CompareParams`.
`ComplexDomain`	Generated wrapper for `ComplexDomain`.
`ConcatSpec`	Generated wrapper for `ConcatSpec`.
`ConditionalMarkPropExprDefType`	Generated wrapper for `Conditional<MarkPropExprDef<Type>>`.
`ConditionalMarkPropExprDefTypeForShape`	Generated wrapper for `Conditional<MarkPropExprDef<TypeForShape>>`.
`ConditionalMarkPropFieldDefType`	Generated wrapper for `Conditional<MarkPropFieldDef<Type>>`.
`ConditionalMarkPropFieldDefTypeForShape`	Generated wrapper for `Conditional<MarkPropFieldDef<TypeForShape>>`.
`ConditionalParameterMarkPropExprDefType`	Generated wrapper for `ConditionalParameter<MarkPropExprDef<Type>>`.
`ConditionalParameterMarkPropExprDefTypeForShape`	Generated wrapper for `ConditionalParameter<MarkPropExprDef<TypeForShape>>`.
`ConditionalParameterMarkPropFieldDefType`	Generated wrapper for `ConditionalParameter<MarkPropFieldDef<Type>>`.
`ConditionalParameterMarkPropFieldDefTypeForShape`	Generated wrapper for `ConditionalParameter<MarkPropFieldDef<TypeForShape>>`.
`ConditionalParameterScaleDatumDef`	Generated wrapper for `ConditionalParameter<ScaleDatumDef>`.
`ConditionalParameterValueDefNumberExprRef`	Generated wrapper for `ConditionalParameter<ValueDef<(number\|ExprRef)>>`.
`ConditionalParameterValueDefStringNullExprRef`	Generated wrapper for `ConditionalParameter<ValueDef<(string\|null\|ExprRef)>>`.
`ConditionalScaleDatumDef`	Generated wrapper for `Conditional<ScaleDatumDef>`.
`ConditionalTestMarkPropExprDefType`	Generated wrapper for `ConditionalTest<MarkPropExprDef<Type>>`.
`ConditionalTestMarkPropExprDefTypeForShape`	Generated wrapper for `ConditionalTest<MarkPropExprDef<TypeForShape>>`.
`ConditionalTestMarkPropFieldDefType`	Generated wrapper for `ConditionalTest<MarkPropFieldDef<Type>>`.
`ConditionalTestMarkPropFieldDefTypeForShape`	Generated wrapper for `ConditionalTest<MarkPropFieldDef<TypeForShape>>`.
`ConditionalTestScaleDatumDef`	Generated wrapper for `ConditionalTest<ScaleDatumDef>`.
`ConditionalTestValueDefNumberExprRef`	Generated wrapper for `ConditionalTest<ValueDef<(number\|ExprRef)>>`.
`ConditionalTestValueDefStringNullExprRef`	Generated wrapper for `ConditionalTest<ValueDef<(string\|null\|ExprRef)>>`.
`ConditionalValueDefNumberExprRef`	Generated wrapper for `Conditional<ValueDef<(number\|ExprRef)>>`.
`ConditionalValueDefStringNullExprRef`	Generated wrapper for `Conditional<ValueDef<(string\|null\|ExprRef)>>`.
`Contig`	Generated wrapper for `Contig`.
`CoordinateLookupInput`	Generated wrapper for `CoordinateLookupInput`.
`CoordinateLookupParams`	Generated wrapper for `CoordinateLookupParams`.
`CoreRootSpec`	Generated wrapper for `CoreRootSpec`.
`CoverageParams`	Generated wrapper for `CoverageParams`.
`CrossData`	Generated wrapper for `CrossData`.
`CrossInput`	Generated wrapper for `CrossInput`.
`CrossParams`	Generated wrapper for `CrossParams`.
`CsvDataFormat`	Generated wrapper for `CsvDataFormat`.
`Data`	Generated wrapper for `Data`.
`DataFormat`	Generated wrapper for `DataFormat`.
`DataSource`	Generated wrapper for `DataSource`.
`DebouncedExprParameter`	Generated wrapper for `DebouncedExprParameter`.
`DendrogramParams`	Generated wrapper for `DendrogramParams`.
`DirectionDef`	Generated wrapper for `DirectionDef`.
`Displace1DParams`	Generated wrapper for `Displace1DParams`.
`Displace2DParams`	Generated wrapper for `Displace2DParams`.
`DomEventType`	Generated wrapper for `DomEventType`.
`DomainValue`	Generated wrapper for `DomainValue`.
`DomainValueArray`	Generated wrapper for `DomainValueArray`.
`DsvDataFormat`	Generated wrapper for `DsvDataFormat`.
`DynamicCallbackData`	Generated wrapper for `DynamicCallbackData`.
`DynamicOpacity`	Generated wrapper for `DynamicOpacity`.
`Encoding`	Generated wrapper for `Encoding`.
`EventConfig`	Generated wrapper for `EventConfig`.
`ExplicitlyOrderedDendrogramParams`	Generated wrapper for `ExplicitlyOrderedDendrogramParams`.
`ExprDef`	Generated wrapper for `ExprDef`.
`ExprFilterParams`	Generated wrapper for `ExprFilterParams`.
`ExprParameter`	Generated wrapper for `ExprParameter`.
`ExprRef`	Generated wrapper for `ExprRef`.
`Expression`	A composable GenomeSpy expression string.
`FacetFieldDef`	Generated wrapper for `FacetFieldDef`.
`FacetHeader`	Generated wrapper for `FacetHeader`.
`FacetMapping`	Generated wrapper for `FacetMapping`.
`FacetSpacing`	Generated wrapper for `FacetSpacing`.
`FacetSpec`	Generated wrapper for `FacetSpec`.
`FadedMultiscaleStops`	Generated wrapper for `FadedMultiscaleStops`.
`Field`	Generated wrapper for `Field`.
`FieldDefWithoutScale`	Generated wrapper for `FieldDefWithoutScale`.
`FieldName`	Generated wrapper for `FieldName`.
`FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapeStringNull`	Generated wrapper for `FieldOrDatumDefWithCondition<MarkPropFieldDef<TypeForShape>,(string\|null)>`.
`FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber`	Generated wrapper for `FieldOrDatumDefWithCondition<MarkPropFieldDef<Type>,number>`.
`FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull`	Generated wrapper for `FieldOrDatumDefWithCondition<MarkPropFieldDef<Type>,(string\|null)>`.
`FieldOrDatumDefWithConditionScaleDatumDefNumber`	Generated wrapper for `FieldOrDatumDefWithCondition<ScaleDatumDef,number>`.
`FieldOrDatumDefWithConditionScaleDatumDefStringNull`	Generated wrapper for `FieldOrDatumDefWithCondition<ScaleDatumDef,(string\|null)>`.
`FigWigData`	Generated wrapper for `FigWigData`.
`FilterParams`	Generated wrapper for `FilterParams`.
`FilterScoredLabelsParams`	Generated wrapper for `FilterScoredLabelsParams`.
`FlattenCigarParams`	Generated wrapper for `FlattenCigarParams`.
`FlattenCompressedExonsParams`	Generated wrapper for `FlattenCompressedExonsParams`.
`FlattenDelimitedParams`	Generated wrapper for `FlattenDelimitedParams`.
`FlattenParams`	Generated wrapper for `FlattenParams`.
`FlattenSequenceParams`	Generated wrapper for `FlattenSequenceParams`.
`FontStyle`	Generated wrapper for `FontStyle`.
`FontWeight`	Generated wrapper for `FontWeight`.
`FormulaParams`	Generated wrapper for `FormulaParams`.
`Generator`	Generated wrapper for `Generator`.
`GenomeAxis`	Generated wrapper for `GenomeAxis`.
`GenomeConfig`	Generated wrapper for `GenomeConfig`.
`GenomeConfigBase`	Generated wrapper for `GenomeConfigBase`.
`GenomeDefinition`	Generated wrapper for `GenomeDefinition`.
`GenomeSpyConfig`	Generated wrapper for `GenomeSpyConfig`.
`GenomeSpySchema`	Base class for generated GenomeSpy schema wrappers.
`Gff3Data`	Generated wrapper for `Gff3Data`.
`GradientIntervalSelectionParameterColor`	Generated wrapper for `GradientIntervalSelectionParameter<"color">`.
`GradientIntervalSelectionParameterFill`	Generated wrapper for `GradientIntervalSelectionParameter<"fill">`.
`GradientIntervalSelectionParameterStroke`	Generated wrapper for `GradientIntervalSelectionParameter<"stroke">`.
`HConcatSpec`	Generated wrapper for `HConcatSpec`.
`HandledTooltip`	Generated wrapper for `HandledTooltip`.
`IdentifierParams`	Generated wrapper for `IdentifierParams`.
`ImportSpec`	Generated wrapper for `ImportSpec`.
`IndexDendrogramParams`	Generated wrapper for `IndexDendrogramParams`.
`IndexUrlSourceRef`	Generated wrapper for `IndexUrlSourceRef`.
`IndexUrlTemplate`	Generated wrapper for `IndexUrlTemplate`.
`IndexedFastaData`	Generated wrapper for `IndexedFastaData`.
`InlineData`	Generated wrapper for `InlineData`.
`InlineDataset`	Generated wrapper for `InlineDataset`.
`InlineGenomeConfig`	Generated wrapper for `InlineGenomeConfig`.
`InlineGenomeDefinition`	Generated wrapper for `InlineGenomeDefinition`.
`InlineLocusAssembly`	Generated wrapper for `InlineLocusAssembly`.
`InteractionEventType`	Generated wrapper for `InteractionEventType`.
`IntervalSelectionParameter`	Generated wrapper for `IntervalSelectionParameter`.
`JsonDataFormat`	Generated wrapper for `JsonDataFormat`.
`KeyDef`	Generated wrapper for `KeyDef`.
`LayerSpec`	Generated wrapper for `LayerSpec`.
`LazyData`	Generated wrapper for `LazyData`.
`LazyDataParams`	Generated wrapper for `LazyDataParams`.
`Legend`	Generated wrapper for `Legend`.
`LegendConfig`	Generated wrapper for `LegendConfig`.
`LegendDirection`	Generated wrapper for `LegendDirection`.
`LegendLayout`	Generated wrapper for `LegendLayout`.
`LegendOrient`	Generated wrapper for `LegendOrient`.
`LegendRegionAnchor`	Generated wrapper for `LegendRegionAnchor`.
`LegendRegionLayout`	Generated wrapper for `LegendRegionLayout`.
`LegendResolutionBehavior`	Generated wrapper for `LegendResolutionBehavior`.
`LegendTitleOrient`	Generated wrapper for `LegendTitleOrient`.
`LerpTransition`	Generated wrapper for `LerpTransition`.
`LinearizeGenomicCoordinateParams`	Generated wrapper for `LinearizeGenomicCoordinateParams`.
`LinkConfig`	Generated wrapper for `LinkConfig`.
`LinkProps`	Generated wrapper for `LinkProps`.
`LookupParams`	Generated wrapper for `LookupParams`.
`LookupSelfInput`	Generated wrapper for `LookupSelfInput`.
`MarkConfig`	Generated wrapper for `MarkConfig`.
`MarkPropDefNumber`	Generated wrapper for `MarkPropDef<number>`.
`MarkPropDefStringNull`	Generated wrapper for `MarkPropDef<(string\|null)>`.
`MarkPropDefStringNullTypeForShape`	Generated wrapper for `MarkPropDef<(string\|null),TypeForShape>`.
`MarkPropExprDef`	Generated wrapper for `MarkPropExprDef`.
`MarkPropExprDefType`	Generated wrapper for `MarkPropExprDef<Type>`.
`MarkPropExprDefTypeForShape`	Generated wrapper for `MarkPropExprDef<TypeForShape>`.
`MarkProps`	Generated wrapper for `MarkProps`.
`MarkType`	Generated wrapper for `MarkType`.
`MeasureTextParams`	Generated wrapper for `MeasureTextParams`.
`MergeFacetsParams`	Generated wrapper for `MergeFacetsParams`.
`MultiUrlSourceRef`	Generated wrapper for `MultiUrlSourceRef`.
`MultiscaleSpec`	Generated wrapper for `MultiscaleSpec`.
`MultiscaleStops`	Generated wrapper for `MultiscaleStops`.
`MultiscaleStopsDef`	Generated wrapper for `MultiscaleStopsDef`.
`NamedData`	Generated wrapper for `NamedData`.
`NamedGenomeConfig`	Generated wrapper for `NamedGenomeConfig`.
`NamedSelectionPredicateRef`	Generated wrapper for `NamedSelectionPredicateRef`.
`NumericDomain`	Generated wrapper for `NumericDomain`.
`NumericMarkPropDef`	Generated wrapper for `NumericMarkPropDef`.
`NumericStopDef`	Generated wrapper for `NumericStopDef`.
`NumericValueDef`	Generated wrapper for `NumericValueDef`.
`OffsetChannel`	Generated wrapper for `OffsetChannel`.
`OffsetDef`	Generated wrapper for `OffsetDef`.
`OrderCondition`	Generated wrapper for `OrderCondition`.
`OrderDef`	Generated wrapper for `OrderDef`.
`OtherDataFormat`	Generated wrapper for `OtherDataFormat`.
`OverhangConfig`	Generated wrapper for `OverhangConfig`.
`PackLegendLabelsParams`	Generated wrapper for `PackLegendLabelsParams`.
`PaddingConfig`	Generated wrapper for `PaddingConfig`.
`Paddings`	Generated wrapper for `Paddings`.
`ParamTransition`	Generated wrapper for `ParamTransition`.
`Parameter`	Represent a declared GenomeSpy parameter in Python expressions.
`ParameterPredicate`	Generated wrapper for `ParameterPredicate`.
`Parse`	Generated wrapper for `Parse`.
`ParseValue`	Generated wrapper for `ParseValue`.
`PileupParams`	Generated wrapper for `PileupParams`.
`PlainExprParameter`	Generated wrapper for `PlainExprParameter`.
`PlainValueParameter`	Generated wrapper for `PlainValueParameter`.
`PointConfig`	Generated wrapper for `PointConfig`.
`PointProps`	Generated wrapper for `PointProps`.
`Position2Def`	Generated wrapper for `Position2Def`.
`PositionDatumDef`	Generated wrapper for `PositionDatumDef`.
`PositionDef`	Generated wrapper for `PositionDef`.
`PositionExprDef`	Generated wrapper for `PositionExprDef`.
`PositionFieldDef`	Generated wrapper for `PositionFieldDef`.
`PositionValueDef`	Generated wrapper for `PositionValueDef`.
`PositionalChannel`	Generated wrapper for `PositionalChannel`.
`PositionalIntervalSelectionParameter`	Generated wrapper for `PositionalIntervalSelectionParameter`.
`PrimaryPositionalChannel`	Generated wrapper for `PrimaryPositionalChannel`.
`ProjectParams`	Generated wrapper for `ProjectParams`.
`RangeConfig`	Generated wrapper for `RangeConfig`.
`RecordSelectionParameter`	Generated wrapper for `RecordSelectionParameter`.
`RectConfig`	Generated wrapper for `RectConfig`.
`RectProps`	Generated wrapper for `RectProps`.
`RegexExtractParams`	Generated wrapper for `RegexExtractParams`.
`RegexFoldParams`	Generated wrapper for `RegexFoldParams`.
`ResolutionBehavior`	Generated wrapper for `ResolutionBehavior`.
`ResolutionMapLegendResolutionBehavior`	Generated wrapper for `ResolutionMap<LegendResolutionBehavior>`.
`ResolutionMapResolutionBehavior`	Generated wrapper for `ResolutionMap<ResolutionBehavior>`.
`Root`	Generated wrapper for the root GenomeSpy specification.
`RuleConfig`	Generated wrapper for `RuleConfig`.
`RuleProps`	Generated wrapper for `RuleProps`.
`RulerChannelValue`	Generated wrapper for `RulerChannelValue`.
`RulerClear`	Generated wrapper for `RulerClear`.
`RulerConfig`	Generated wrapper for `RulerConfig`.
`RulerDisplay`	Generated wrapper for `RulerDisplay`.
`RulerEventConfig`	Generated wrapper for `RulerEventConfig`.
`RulerEventType`	Generated wrapper for `RulerEventType`.
`RulerExtent`	Generated wrapper for `RulerExtent`.
`RulerInitMapping`	Generated wrapper for `RulerInitMapping`.
`RulerMarkConfig`	Generated wrapper for `RulerMarkConfig`.
`RulerParameter`	Generated wrapper for `RulerParameter`.
`RulerSnap`	Generated wrapper for `RulerSnap`.
`RulerSource`	Generated wrapper for `RulerSource`.
`SampleParams`	Generated wrapper for `SampleParams`.
`Scalar`	Generated wrapper for `Scalar`.
`ScalarDomain`	Generated wrapper for `ScalarDomain`.
`Scale`	Generated wrapper for `Scale`.
`ScaleConfig`	Generated wrapper for `ScaleConfig`.
`ScaleGroupsData`	Generated wrapper for `ScaleGroupsData`.
`ScaleInterpolate`	Generated wrapper for `ScaleInterpolate`.
`ScaleInterpolateParams`	Generated wrapper for `ScaleInterpolateParams`.
`ScaleType`	Generated wrapper for `ScaleType`.
`SchemeParams`	Generated wrapper for `SchemeParams`.
`SearchDef`	Generated wrapper for `SearchDef`.
`SecondaryChromPosDef`	Generated wrapper for `SecondaryChromPosDef`.
`SecondaryOffsetChannel`	Generated wrapper for `SecondaryOffsetChannel`.
`SecondaryOffsetDef`	Generated wrapper for `SecondaryOffsetDef`.
`SecondaryPositionalChannel`	Generated wrapper for `SecondaryPositionalChannel`.
`SelectionDomainRef`	Generated wrapper for `SelectionDomainRef`.
`SelectionExtent`	Generated wrapper for `SelectionExtent`.
`SelectionFilterParams`	Generated wrapper for `SelectionFilterParams`.
`SelectionInitIntervalMapping`	Generated wrapper for `SelectionInitIntervalMapping`.
`SelectionParameter`	Generated wrapper for `SelectionParameter`.
`SelectionPredicateDefinition`	Generated wrapper for `SelectionPredicateDefinition`.
`SelectionPredicateOperand`	Generated wrapper for `SelectionPredicateOperand`.
`SelectionUnionTest`	Generated wrapper for `SelectionUnionTest`.
`SeparatorProps`	Generated wrapper for `SeparatorProps`.
`SequenceGenerator`	Generated wrapper for `SequenceGenerator`.
`SequenceParams`	Generated wrapper for `SequenceParams`.
`SetIntersectionParams`	Generated wrapper for `SetIntersectionParams`.
`ShapeDef`	Generated wrapper for `ShapeDef`.
`SiblingOrderedDendrogramParams`	Generated wrapper for `SiblingOrderedDendrogramParams`.
`SingleUrlSourceRef`	Generated wrapper for `SingleUrlSourceRef`.
`SizeDef`	Generated wrapper for `SizeDef`.
`SortOrder`	Generated wrapper for `SortOrder`.
`StackParams`	Generated wrapper for `StackParams`.
`Step`	Generated wrapper for `Step`.
`StringDatumDef`	Generated wrapper for `StringDatumDef`.
`StringFieldDef`	Generated wrapper for `StringFieldDef`.
`StrokeAlign`	Generated wrapper for `StrokeAlign`.
`StyleConfig`	Generated wrapper for `StyleConfig`.
`SurroundPlotSpec`	Generated wrapper for `SurroundPlotSpec`.
`SurroundSide`	Generated wrapper for `SurroundSide`.
`SurroundSideSpec`	Generated wrapper for `SurroundSideSpec`.
`SurroundSides`	Generated wrapper for `SurroundSides`.
`SurroundSpec`	Generated wrapper for `SurroundSpec`.
`TabixTsvData`	Generated wrapper for `TabixTsvData`.
`TemplateImport`	Generated wrapper for `TemplateImport`.
`TextConfig`	Generated wrapper for `TextConfig`.
`TextDef`	Generated wrapper for `TextDef`.
`TextProps`	Generated wrapper for `TextProps`.
`TickConfig`	Generated wrapper for `TickConfig`.
`TickProps`	Generated wrapper for `TickProps`.
`Title`	Generated wrapper for `Title`.
`TitleAnchor`	Generated wrapper for `TitleAnchor`.
`TitleConfig`	Generated wrapper for `TitleConfig`.
`TitleFrame`	Generated wrapper for `TitleFrame`.
`TitleOrient`	Generated wrapper for `TitleOrient`.
`TooltipDef`	Generated wrapper for `TooltipDef`.
`TransformOutput`	Generated wrapper for `TransformOutput`.
`TransformParams`	Generated wrapper for `TransformParams`.
`TransitionedExprParameter`	Generated wrapper for `TransitionedExprParameter`.
`TransitionedMultiscaleStops`	Generated wrapper for `TransitionedMultiscaleStops`.
`TransitionedValueParameter`	Generated wrapper for `TransitionedValueParameter`.
`TruncateTextParams`	Generated wrapper for `TruncateTextParams`.
`Type`	Generated wrapper for `Type`.
`TypeForShape`	Generated wrapper for `TypeForShape`.
`UnitSpec`	Generated wrapper for `UnitSpec`.
`UrlData`	Generated wrapper for `UrlData`.
`UrlGenomeConfig`	Generated wrapper for `UrlGenomeConfig`.
`UrlGenomeDefinition`	Generated wrapper for `UrlGenomeDefinition`.
`UrlImport`	Generated wrapper for `UrlImport`.
`UrlList`	Generated wrapper for `UrlList`.
`UrlSourceRef`	Generated wrapper for `UrlSourceRef`.
`UrlTemplate`	Generated wrapper for `UrlTemplate`.
`VConcatSpec`	Generated wrapper for `VConcatSpec`.
`ValueDefArrowDirection`	Generated wrapper for `ValueDef<ArrowDirection>`.
`ValueDefNumber`	Generated wrapper for `ValueDef<number>`.
`ValueDefString`	Generated wrapper for `ValueDef<string>`.
`ValueDefWithConditionNumberType`	Generated wrapper for `ValueDefWithCondition<number,Type>`.
`ValueDefWithConditionStringNullType`	Generated wrapper for `ValueDefWithCondition<(string\|null),Type>`.
`ValueDefWithConditionStringNullTypeForShape`	Generated wrapper for `ValueDefWithCondition<(string\|null),TypeForShape>`.
`ValueParameter`	Generated wrapper for `ValueParameter`.
`ValuesParams`	Generated wrapper for `ValuesParams`.
`VariableParameter`	Generated wrapper for `VariableParameter`.
`VcfData`	Generated wrapper for `VcfData`.
`VcfDataFormat`	Generated wrapper for `VcfDataFormat`.
`ViewBackground`	Generated wrapper for `ViewBackground`.
`ViewConfig`	Generated wrapper for `ViewConfig`.
`ViewOpacityDef`	Generated wrapper for `ViewOpacityDef`.
`ViewSpec`	Generated wrapper for `ViewSpec`.
`ViewportDomainRef`	Generated wrapper for `ViewportDomainRef`.
`ViewportSizeDef`	Generated wrapper for `ViewportSizeDef`.
`WigDataFormat`	Generated wrapper for `WigDataFormat`.
`WindowOnlyOp`	Generated wrapper for `WindowOnlyOp`.
`WindowOp`	Generated wrapper for `WindowOp`.
`WindowParams`	Generated wrapper for `WindowParams`.
`ZoomParams`	Generated wrapper for `ZoomParams`.

Data sources¶

gs.lazy is a ready-made LazyNamespace instance, so a lazy source is created with gs.lazy.bigwig(url) rather than by constructing the namespace.

LazyNamespace

Convenience builders for GenomeSpy lazy data sources.

Data preparation settings¶

gs.data_transformers controls automatic sharing of inline tables during serialization. It supports consolidate_datasets and temporary overrides with enable(). It does not provide a transformer plugin registry.

DataTransformerSettings

Control whether exported charts share repeated inline tables.

AnnData projection¶

Optional AnnData support uses the existing pandas table interface. See AnnData inputs for metadata and embedding examples.

`from_anndata`	Prepare observation metadata, selected genes, and embedding components.
`AnnDataProjectionError`	A requested AnnData field cannot be projected without ambiguity.

Example datasets¶

Packaged tables used by the gallery examples. See example datasets for their contents and sources.

`available_datasets`	Packaged dataset names.
`load_dataset`	Load a packaged example dataset by name.
`DatasetNotFoundError`	Dataset name lookup failed.

Notebook rendering¶

JupyterChart

A lightweight anywidget wrapper around GenomeSpy's embed API.