genome_spy.LegendConfig

class genome_spy.LegendConfig(backgroundFill=Undefined, backgroundFillOpacity=Undefined, backgroundStroke=Undefined, backgroundStrokeOpacity=Undefined, backgroundStrokeWidth=Undefined, columnPadding=Undefined, columns=Undefined, direction=Undefined, disable=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, layout=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, selectionLabel=Undefined, spacing=Undefined, style=Undefined, symbolBaseFillColor=Undefined, symbolBaseStrokeColor=Undefined, symbolFillColor=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, tickCount=Undefined, title=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, values=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for LegendConfig.

Methods

backgroundFill([value, expr])	Return a copy with a ExprRef backgroundFill.
backgroundFillOpacity(value)	Return a copy with backgroundFillOpacity updated.
backgroundStroke([value, expr])	Return a copy with a ExprRef backgroundStroke.
backgroundStrokeOpacity(value)	Return a copy with backgroundStrokeOpacity updated.
backgroundStrokeWidth(value)	Return a copy with backgroundStrokeWidth updated.
columnPadding(value)	Return a copy with columnPadding updated.
columns(value)	Return a copy with columns updated.
copy(*[, deep])	Return a copy with optional keyword updates.
direction(value)	Return a copy with direction updated.
disable([value, expr])	Return a copy with a ExprRef disable.
gradientLength(value)	Return a copy with gradientLength updated.
gradientOpacity(value)	Return a copy with gradientOpacity updated.
gradientStrokeColor([value, expr])	Return a copy with a ExprRef gradientStrokeColor.
gradientStrokeWidth(value)	Return a copy with gradientStrokeWidth updated.
gradientThickness(value)	Return a copy with gradientThickness updated.
labelAlign(value)	Return a copy with labelAlign updated.
labelBaseline(value)	Return a copy with labelBaseline updated.
labelColor([value, expr])	Return a copy with a ExprRef labelColor.
labelFont(value)	Return a copy with labelFont updated.
labelFontSize(value)	Return a copy with labelFontSize updated.
labelFontStyle(value)	Return a copy with labelFontStyle updated.
labelFontWeight(value)	Return a copy with labelFontWeight updated.
labelLimit(value)	Return a copy with labelLimit updated.
labelOffset(value)	Return a copy with labelOffset updated.
layout([value, anchor, bottom, direction, ...])	Return a copy with a LegendLayout layout.
offset(value)	Return a copy with offset updated.
orient([value, expr])	Return a copy with orient updated.
padding(value)	Return a copy with padding updated.
resolve_references()	Return this class schema with referenced properties merged in.
rowPadding(value)	Return a copy with rowPadding updated.
selectionLabel(value)	Return a copy with selectionLabel updated.
spacing(value)	Return a copy with spacing updated.
style(value)	Return a copy with style updated.
symbolBaseFillColor([value, expr])	Return a copy with a ExprRef symbolBaseFillColor.
symbolBaseStrokeColor([value, expr])	Return a copy with a ExprRef symbolBaseStrokeColor.
symbolFillColor([value, expr])	Return a copy with a ExprRef symbolFillColor.
symbolOffset(value)	Return a copy with symbolOffset updated.
symbolOpacity([value, expr])	Return a copy with a ExprRef symbolOpacity.
symbolSize(value)	Return a copy with symbolSize updated.
symbolStrokeColor([value, expr])	Return a copy with a ExprRef symbolStrokeColor.
symbolStrokeWidth(value)	Return a copy with symbolStrokeWidth updated.
symbolType(value)	Return a copy with symbolType updated.
tickCount(value)	Return a copy with tickCount updated.
title(value)	Return a copy with title updated.
titleColor([value, expr])	Return a copy with a ExprRef titleColor.
titleFont(value)	Return a copy with titleFont updated.
titleFontSize(value)	Return a copy with titleFontSize updated.
titleFontStyle(value)	Return a copy with titleFontStyle updated.
titleFontWeight(value)	Return a copy with titleFontWeight updated.
titleLimit(value)	Return a copy with titleLimit updated.
titleOrient(value)	Return a copy with titleOrient updated.
titlePadding(value)	Return a copy with titlePadding 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.
values(value)	Return a copy with values updated.

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

Return a copy with a ExprRef backgroundFill.

Parameters:

expr (str) – The expression string.

backgroundFillOpacity(value)View on GitHub

Return a copy with backgroundFillOpacity updated.

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

Return a copy with a ExprRef backgroundStroke.

Parameters:

expr (str) – The expression string.

backgroundStrokeOpacity(value)View on GitHub

Return a copy with backgroundStrokeOpacity updated.

backgroundStrokeWidth(value)View on GitHub

Return a copy with backgroundStrokeWidth updated.

columnPadding(value)View on GitHub

Return a copy with columnPadding updated.

columns(value)View on GitHub

Return a copy with columns updated.

direction(value)View on GitHub

Return a copy with direction updated.

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

Return a copy with a ExprRef disable.

Parameters:

expr (str) – The expression string.

gradientLength(value)View on GitHub

Return a copy with gradientLength updated.

gradientOpacity(value)View on GitHub

Return a copy with gradientOpacity updated.

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

Return a copy with a ExprRef gradientStrokeColor.

Parameters:

expr (str) – The expression string.

gradientStrokeWidth(value)View on GitHub

Return a copy with gradientStrokeWidth updated.

gradientThickness(value)View on GitHub

Return a copy with gradientThickness updated.

labelAlign(value)View on GitHub

Return a copy with labelAlign updated.

labelBaseline(value)View on GitHub

Return a copy with labelBaseline updated.

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

Return a copy with a ExprRef labelColor.

Parameters:

expr (str) – The expression string.

labelFont(value)View on GitHub

Return a copy with labelFont updated.

labelFontSize(value)View on GitHub

Return a copy with labelFontSize updated.

labelFontStyle(value)View on GitHub

Return a copy with labelFontStyle updated.

labelFontWeight(value)View on GitHub

Return a copy with labelFontWeight updated.

labelLimit(value)View on GitHub

Return a copy with labelLimit updated.

labelOffset(value)View on GitHub

Return a copy with labelOffset updated.

layout(value=Undefined, /, *, anchor=Undefined, bottom=Undefined, direction=Undefined, left=Undefined, right=Undefined, top=Undefined, wrap=Undefined)View on GitHub

Return a copy with a LegendLayout layout.

Parameters:

• anchor (LegendRegionAnchor_T) – Position of the complete legend stack along the plot edge. This property applies to external orientations; corner legends remain corner-anchored. __Default value:__ "start"

• bottom (LegendRegionLayout | dict[str, Any]) – Schema-defined bottom property.

• direction (LegendDirection_T) – Direction in which complete legends are arranged within a legend region.

• left (LegendRegionLayout | dict[str, Any]) – Schema-defined left property.

• right (LegendRegionLayout | dict[str, Any]) – Schema-defined right property.

• top (LegendRegionLayout | dict[str, Any]) – Schema-defined top property.

• wrap (bool) – Whether complete legends wrap into additional rows or columns when they do not fit in the available region. Wrapping applies to external legend regions only. __Default value:__ true for external regions, false for inside corners

offset(value)View on GitHub

Return a copy with offset updated.

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

Return a copy with orient updated.

Parameters:

expr (str) – The expression string.

padding(value)View on GitHub

Return a copy with padding updated.

rowPadding(value)View on GitHub

Return a copy with rowPadding updated.

selectionLabel(value)View on GitHub

Return a copy with selectionLabel updated.

spacing(value)View on GitHub

Return a copy with spacing updated.

style(value)View on GitHub

Return a copy with style updated.

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

Return a copy with a ExprRef symbolBaseFillColor.

Parameters:

expr (str) – The expression string.

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

Return a copy with a ExprRef symbolBaseStrokeColor.

Parameters:

expr (str) – The expression string.

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

Return a copy with a ExprRef symbolFillColor.

Parameters:

expr (str) – The expression string.

symbolOffset(value)View on GitHub

Return a copy with symbolOffset updated.

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

Return a copy with a ExprRef symbolOpacity.

Parameters:

expr (str) – The expression string.

symbolSize(value)View on GitHub

Return a copy with symbolSize updated.

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

Return a copy with a ExprRef symbolStrokeColor.

Parameters:

expr (str) – The expression string.

symbolStrokeWidth(value)View on GitHub

Return a copy with symbolStrokeWidth updated.

symbolType(value)View on GitHub

Return a copy with symbolType updated.

tickCount(value)View on GitHub

Return a copy with tickCount updated.

title(value)View on GitHub

Return a copy with title updated.

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

Return a copy with a ExprRef titleColor.

Parameters:

expr (str) – The expression string.

titleFont(value)View on GitHub

Return a copy with titleFont updated.

titleFontSize(value)View on GitHub

Return a copy with titleFontSize updated.

titleFontStyle(value)View on GitHub

Return a copy with titleFontStyle updated.

titleFontWeight(value)View on GitHub

Return a copy with titleFontWeight updated.

titleLimit(value)View on GitHub

Return a copy with titleLimit updated.

titleOrient(value)View on GitHub

Return a copy with titleOrient updated.

titlePadding(value)View on GitHub

Return a copy with titlePadding updated.

values(value)View on GitHub

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