genome_spy.SurroundSideSpec¶

class genome_spy.SurroundSideSpec(axes=Undefined, baseUrl=Undefined, config=Undefined, cursor=Undefined, data=Undefined, datasets=Undefined, description=Undefined, domainInert=Undefined, encoding=Undefined, legends=Undefined, name=Undefined, overhang=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, scales=Undefined, spacing=Undefined, templates=Undefined, title=Undefined, transform=Undefined, views=Undefined, visible=Undefined, zindex=Undefined, **kwds)View on GitHub ¶

Bases: GenomeSpySchema

Generated wrapper for SurroundSideSpec.

Methods

`axes`([value, x, y])	Return a copy with `axes` updated.
`baseUrl`(value)	Return a copy with `baseUrl` updated.
`config`([value, arrow, axis, axisBottom, ...])	Return a copy with a `GenomeSpyConfig` config.
`copy`(*[, deep])	Return a copy with optional keyword updates.
`cursor`([value, expr])	Return a copy with a `ExprRef` cursor.
`data`(value)	Return a copy with `data` updated.
`datasets`(value)	Return a copy with `datasets` updated.
`description`(value)	Return a copy with `description` updated.
`domainInert`(value)	Return a copy with `domainInert` updated.
`encoding`([value, angle, color, direction, ...])	Return a copy with a `Encoding` encoding.
`legends`([value, angle, color, dx, dy, fill, ...])	Return a copy with `legends` updated.
`name`(value)	Return a copy with `name` updated.
`overhang`([value, bottom, left, right, top])	Return a copy with a `OverhangConfig` overhang.
`padding`(value)	Return a copy with `padding` updated.
`params`(value)	Return a copy with `params` updated.
`resolve`([value, axis, legend, scale])	Return a copy with `resolve` updated.
`resolve_references`()	Return this class schema with referenced properties merged in.
`scales`([value, angle, color, direction, dx, ...])	Return a copy with `scales` updated.
`spacing`(value)	Return a copy with `spacing` updated.
`templates`(value)	Return a copy with `templates` updated.
`title`([value, align, anchor, angle, ...])	Return a copy with a `Title` title.
`to_dict`(*[, validate])	Serialize this schema wrapper to a JSON-compatible dictionary.
`to_json`(*[, validate])	Serialize this schema wrapper to formatted JSON.
`transform`(value)	Return a copy with `transform` updated.
`validate`(instance)	Validate an instance against this wrapper's schema.
`views`(value)	Return a copy with `views` updated.
`visible`(value)	Return a copy with `visible` updated.
`zindex`(value)	Return a copy with `zindex` updated.

axes(value=Undefined, /, *, x=Undefined, y=Undefined)View on GitHub ¶

Return a copy with axes updated.

Parameters:

x (dict[str, Any]) – Schema-defined x property.
y (dict[str, Any]) – Schema-defined y property.

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

config(value=Undefined, /, *, arrow=Undefined, axis=Undefined, axisBottom=Undefined, axisIndex=Undefined, axisLeft=Undefined, axisLocus=Undefined, axisNominal=Undefined, axisOrdinal=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTop=Undefined, axisX=Undefined, axisY=Undefined, header=Undefined, headerColumn=Undefined, headerRow=Undefined, legend=Undefined, legendTrack=Undefined, link=Undefined, mark=Undefined, point=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, style=Undefined, text=Undefined, tick=Undefined, title=Undefined, view=Undefined)View on GitHub ¶

Return a copy with a GenomeSpyConfig config.

Parameters:

arrow (ArrowConfig | dict[str, Any]) – Defaults for arrow marks.
axis (AxisConfig | AxisConfigKwds) – Defaults shared by all axes.
axisBottom (AxisConfig | AxisConfigKwds) – Defaults for bottom-oriented axes.
axisIndex (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy index scales.
axisLeft (AxisConfig | AxisConfigKwds) – Defaults for left-oriented axes.
axisLocus (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy locus scales.
axisNominal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize nominal data.
axisOrdinal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize ordinal data.
axisQuantitative (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize quantitative data.
axisRight (AxisConfig | AxisConfigKwds) – Defaults for right-oriented axes.
axisTop (AxisConfig | AxisConfigKwds) – Defaults for top-oriented axes.
axisX (AxisConfig | AxisConfigKwds) – Defaults for x axes.
axisY (AxisConfig | AxisConfigKwds) – Defaults for y axes.
header (FacetHeader | dict[str, Any]) – Defaults for facet category labels, using view-title property names.
headerColumn (FacetHeader | dict[str, Any]) – Defaults for column facet labels, overriding general header defaults.
headerRow (FacetHeader | dict[str, Any]) – Defaults for row facet labels, overriding general header defaults.
legend (LegendConfig | LegendConfigKwds) – Defaults shared by all legends. Set disable to true to suppress automatic legend creation by default.
legendTrack (LegendConfig | LegendConfigKwds) – Defaults for legends of track-like views that use index or locus scales on the x channel. __Default value:__ { "style": "track-bottom-legend" }
link (LinkConfig | LinkConfigKwds) – Defaults for link marks.
mark (MarkConfig | MarkConfigKwds) – Defaults shared by all mark types.
point (PointConfig | PointConfigKwds) – Defaults for point marks.
range (RangeConfig | RangeConfigKwds) – Named reusable ranges for channels such as shape, size, and color.
rect (RectConfig | RectConfigKwds) – Defaults for rect marks.
rule (RuleConfig | RuleConfigKwds) – Defaults for rule marks.
scale (ScaleConfig | ScaleConfigKwds) – Defaults for scale behavior and scale-type-specific buckets.
style (dict[str, Any]) – Named reusable style buckets that marks, axes, legends, titles, and views can reference through their style properties.
text (TextConfig | TextConfigKwds) – Defaults for text marks.
tick (TickConfig | dict[str, Any]) – Defaults for tick marks.
title (TitleConfig | TitleConfigKwds) – Defaults for view titles.
view (ViewConfig | ViewConfigKwds) – Defaults for view background styling, including fill, stroke, shadow, and z-order properties.

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

Return a copy with a ExprRef cursor.

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

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

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

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

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

encoding(value=Undefined, /, *, angle=Undefined, color=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, order=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub ¶

Return a copy with a Encoding encoding.

Parameters:

angle (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Rotation angle of point and text marks.
color (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Color of the marks – either fill or stroke color based on the filled property of mark definition. Note: 1) For fine-grained control over both fill and stroke colors of the marks, please use the fill and stroke channels. The fill or stroke encodings have higher precedence than color, thus may override the color encoding if conflicting encodings are specified. 2) See the GenomeSpy scale documentation for more information about customizing color schemes.
direction (DirectionDef | dict[str, Any]) – Direction of arrow marks. Encoded values are mapped with a discrete scale whose range values must be "forward", "reverse", or "both". The automatic range contains only "forward" and "reverse"; use an explicit value or range to select "both". This channel is supported by arrow marks only and does not create a legend.
dx (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy horizontal pixel offset for point marks.
dy (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy vertical pixel offset for point marks. Positive values move in the opposite direction from yOffset.
facetIndex (FieldDefWithoutScale | dict[str, Any]) – For internal use
fill (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Fill color of the marks. Note: The fill encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.
fillOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Fill opacity of the marks.
key (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more data fields that uniquely identify rows for stable point selections and bookmarking across sessions. Unlike uniqueId (an implicit surrogate key), key fields must be stable in the source data. Use a single field definition for simple keys, or an array of field definitions for composite keys. For composite keys, field order is significant.
opacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Opacity of the marks.
order (OrderDef | dict[str, Any]) – Orders instances within this logical mark. The supported form has one selection condition with a finite numeric value and a finite numeric fallback. Lower levels draw first; equal or constant levels are inert.
sample (FieldDefWithoutScale | dict[str, Any]) – Facet identifier for interactive filtering, sorting, and grouping in the App.
search (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more fields used by the App’s location/search input to match rows in this view. Use a single field definition for simple search, or an array for matching against multiple fields. A row matches when any configured search field matches the entered term.
semanticScore (dict[str, Any]) – Schema-defined semanticScore property.
shape (FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefTypeForShape | ValueDefWithConditionStringNullTypeForShape) – Shape of the mark. For point marks the supported values include: - plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left". - stroke-only "x" and "+" shapes, whose line thickness is controlled by strokeWidth - centered directional shape "triangle"
size (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Size of the mark. - For "point" – the symbol size, or pixel area of the mark. - For "text" – the text’s font size. - For "arrow" – the stem thickness in pixels.
stroke (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Stroke color of the marks. Note: The stroke encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.
strokeOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke opacity of the marks.
strokeWidth (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke width of the marks.
text (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString) – Text of the text mark.
tooltip (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString | Sequence[StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString] | None) – Fields, expressions, or values shown by the default tooltip handler. If omitted, the default tooltip handler shows the hovered datum’s properties. If null, the default tooltip handler shows no raw datum rows for this mark. Use an array to show multiple rows in a specific order.
uniqueId (FieldDefWithoutScale | dict[str, Any]) – For internal use
x (dict[str, Any] | None) – X coordinates of the marks. The value of this channel can be a number between zero and one.
x2 (Position2Def | dict[str, Any] | None) – X2 coordinates of the marks. The value of this channel can be a number between zero and one.
x2Offset (SecondaryOffsetDef | dict[str, Any] | None) – Horizontal displacement of x2, using the xOffset scale for data values.
xOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Horizontal offset from the encoded x position, in logical pixels.
y (PositionFieldDef | dict[str, Any] | ChromPosDef | PositionDatumDef | PositionExprDef | ValueDefNumber | None) – Y coordinates of the marks. The value of this channel can be a number between zero and one.
y2 (Position2Def | dict[str, Any] | None) – Y2 coordinates of the marks. The value of this channel can be a number between zero and one.
y2Offset (SecondaryOffsetDef | dict[str, Any] | None) – Vertical displacement of y2, using the yOffset scale for data values.
yOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Vertical offset from the encoded y position, in logical pixels.

legends(value=Undefined, /, *, angle=Undefined, color=Undefined, dx=Undefined, dy=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, x2Offset=Undefined, xOffset=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub ¶

Return a copy with legends updated.

Parameters:

angle (Legend | LegendKwds) – Schema-defined angle property.
color (Legend | LegendKwds) – Schema-defined color property.
dx (Legend | LegendKwds) – Schema-defined dx property.
dy (Legend | LegendKwds) – Schema-defined dy property.
fill (Legend | LegendKwds) – Schema-defined fill property.
fillOpacity (Legend | LegendKwds) – Schema-defined fillOpacity property.
opacity (Legend | LegendKwds) – Schema-defined opacity property.
shape (Legend | LegendKwds) – Schema-defined shape property.
size (Legend | LegendKwds) – Schema-defined size property.
stroke (Legend | LegendKwds) – Schema-defined stroke property.
strokeOpacity (Legend | LegendKwds) – Schema-defined strokeOpacity property.
strokeWidth (Legend | LegendKwds) – Schema-defined strokeWidth property.
x2Offset (Legend | LegendKwds) – Schema-defined x2Offset property.
xOffset (Legend | LegendKwds) – Schema-defined xOffset property.
y2Offset (Legend | LegendKwds) – Schema-defined y2Offset property.
yOffset (Legend | LegendKwds) – Schema-defined yOffset property.

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

overhang(value=Undefined, /, *, bottom=Undefined, left=Undefined, right=Undefined, top=Undefined)View on GitHub ¶

Return a copy with a OverhangConfig overhang.

Parameters:

bottom (bool) – Schema-defined bottom property.
left (bool) – Schema-defined left property.
right (bool) – Schema-defined right property.
top (bool) – Schema-defined top property.

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

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

resolve(value=Undefined, /, *, axis=Undefined, legend=Undefined, scale=Undefined)View on GitHub ¶

Return a copy with resolve updated.

Parameters:

axis (ResolutionMapResolutionBehavior | dict[str, Any]) – Schema-defined axis property.
legend (ResolutionMapLegendResolutionBehavior | dict[str, Any]) – Schema-defined legend property.
scale (ResolutionMapResolutionBehavior | dict[str, Any]) – Schema-defined scale property.

scales(value=Undefined, /, *, angle=Undefined, color=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub ¶

Return a copy with scales updated.

Parameters:

angle (Scale | ScaleKwds) – Schema-defined angle property.
color (Scale | ScaleKwds) – Schema-defined color property.
direction (Scale | ScaleKwds) – Schema-defined direction property.
dx (Scale | ScaleKwds) – Schema-defined dx property.
dy (Scale | ScaleKwds) – Schema-defined dy property.
fill (Scale | ScaleKwds) – Schema-defined fill property.
fillOpacity (Scale | ScaleKwds) – Schema-defined fillOpacity property.
opacity (Scale | ScaleKwds) – Schema-defined opacity property.
shape (Scale | ScaleKwds) – Schema-defined shape property.
size (Scale | ScaleKwds) – Schema-defined size property.
stroke (Scale | ScaleKwds) – Schema-defined stroke property.
strokeOpacity (Scale | ScaleKwds) – Schema-defined strokeOpacity property.
strokeWidth (Scale | ScaleKwds) – Schema-defined strokeWidth property.
x (Scale | ScaleKwds) – Schema-defined x property.
x2 (Scale | ScaleKwds) – Schema-defined x2 property.
x2Offset (Scale | ScaleKwds) – Schema-defined x2Offset property.
xOffset (Scale | ScaleKwds) – Schema-defined xOffset property.
y (Scale | ScaleKwds) – Schema-defined y property.
y2 (Scale | ScaleKwds) – Schema-defined y2 property.
y2Offset (Scale | ScaleKwds) – Schema-defined y2Offset property.
yOffset (Scale | ScaleKwds) – Schema-defined yOffset property.

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

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

title(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, subtitle=Undefined, subtitleColor=Undefined, subtitleFont=Undefined, subtitleFontSize=Undefined, subtitleFontStyle=Undefined, subtitleFontWeight=Undefined, subtitlePadding=Undefined, text=Undefined, zindex=Undefined)View on GitHub ¶

Return a copy with a Title title.

Parameters:

align (Align_T) – Horizontal text alignment for title text. One of "left", "center", or "right".
anchor (TitleAnchor_T) – The anchor position for placing the title and subtitle text. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.
angle (float | ExprRef | dict[str, Any]) – Angle in degrees of title and subtitle text.
baseline (Baseline_T) – Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", or "bottom".
color (str | ExprRef | dict[str, Any]) – Text color for title text.
dx (float) – Delta offset for title and subtitle text x-coordinate.
dy (float) – Delta offset for title and subtitle text y-coordinate.
font (str) – Font name for title text.
fontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for title text.
fontStyle (FontStyle_T) – Font style for title text.
fontWeight (FontWeight_T) – Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).
frame (TitleFrame_T) – The reference frame for the title anchor. "group" anchors the title along the plot area. "bounds" anchors the title along the full bounds, including axes, legends, and other reserved space. __Default value:__ "group"
offset (float) – The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.
orient (TitleOrient_T) – Default title orientation ("none", "top", "bottom", "left", or "right")
reserve (bool) – Whether the title reserves layout space outside the plot area. Reserved titles are placed outside axes, legends, and other guide space on the same side. Setting this to false lets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__ true
style (str | Sequence[str]) – A mark style property to apply to the title text mark. If not specified, a default style of "group-title" is applied.
subtitle (str | ExprRef | dict[str, Any]) – The subtitle text.
subtitleColor (str | ExprRef | dict[str, Any]) – Text color for subtitle text.
subtitleFont (str) – Font name for subtitle text.
subtitleFontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for subtitle text.
subtitleFontStyle (FontStyle_T) – Font style for subtitle text.
subtitleFontWeight (FontWeight_T) – Font weight for subtitle text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).
subtitlePadding (float) – Padding in pixels between title and subtitle text. __Default value:__ 3
text (str | ExprRef | dict[str, Any]) – The title text.
zindex (float) – Z-order of the title 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. __Default value:__ 1

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

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

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

zindex(value)View on GitHub ¶: Return a copy with zindex 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.