genome_spy.title

genome_spy.title(text, /, *, 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, zindex=Undefined)View on GitHub

Create a chart title object.

Parameters:

  • text (str | ExprRef | dict[str, Any]) – The title text.

  • 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

  • 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