genome_spy.LegendLayout¶

class genome_spy.LegendLayout(anchor=Undefined, bottom=Undefined, direction=Undefined, left=Undefined, right=Undefined, top=Undefined, wrap=Undefined, **kwds)View on GitHub ¶

Bases: GenomeSpySchema

Generated wrapper for LegendLayout.

Methods

`anchor`(value)	Return a copy with `anchor` updated.
`bottom`([value, anchor, direction, wrap])	Return a copy with a `LegendRegionLayout` bottom.
`copy`(*[, deep])	Return a copy with optional keyword updates.
`direction`(value)	Return a copy with `direction` updated.
`left`([value, anchor, direction, wrap])	Return a copy with a `LegendRegionLayout` left.
`resolve_references`()	Return this class schema with referenced properties merged in.
`right`([value, anchor, direction, wrap])	Return a copy with a `LegendRegionLayout` right.
`to_dict`(*[, validate])	Serialize this schema wrapper to a JSON-compatible dictionary.
`to_json`(*[, validate])	Serialize this schema wrapper to formatted JSON.
`top`([value, anchor, direction, wrap])	Return a copy with a `LegendRegionLayout` top.
`validate`(instance)	Validate an instance against this wrapper's schema.
`wrap`(value)	Return a copy with `wrap` updated.

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

bottom(value=Undefined, /, *, anchor=Undefined, direction=Undefined, wrap=Undefined)View on GitHub ¶

Return a copy with a LegendRegionLayout bottom.

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"
direction (LegendDirection_T) – Direction in which complete legends are arranged within a legend region.
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

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

left(value=Undefined, /, *, anchor=Undefined, direction=Undefined, wrap=Undefined)View on GitHub ¶

Return a copy with a LegendRegionLayout left.

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"
direction (LegendDirection_T) – Direction in which complete legends are arranged within a legend region.
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

right(value=Undefined, /, *, anchor=Undefined, direction=Undefined, wrap=Undefined)View on GitHub ¶

Return a copy with a LegendRegionLayout right.

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"
direction (LegendDirection_T) – Direction in which complete legends are arranged within a legend region.
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

top(value=Undefined, /, *, anchor=Undefined, direction=Undefined, wrap=Undefined)View on GitHub ¶

Return a copy with a LegendRegionLayout top.

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"
direction (LegendDirection_T) – Direction in which complete legends are arranged within a legend region.
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

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