altair.TitleParams

class altair.TitleParams(text=Undefined, align=Undefined, anchor=Undefined, angle=Undefined, aria=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, limit=Undefined, lineHeight=Undefined, offset=Undefined, orient=Undefined, style=Undefined, subtitle=Undefined, subtitleColor=Undefined, subtitleFont=Undefined, subtitleFontSize=Undefined, subtitleFontStyle=Undefined, subtitleFontWeight=Undefined, subtitleLineHeight=Undefined, subtitlePadding=Undefined, zindex=Undefined, **kwds)

TitleParams schema wrapper

Mapping(required=[text])

Attributes
textanyOf(Text, ExprRef)

The title text.

alignAlign

Horizontal text alignment for title text. One of "left", "center", or "right".

anchorTitleAnchor

The anchor position for placing the title. 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.

Default value: "middle" for single and layered views. "start" for other composite views.

Note: For now, anchor is only customizable only for single and layered views. For other composite views, anchor is always "start".

angleanyOf(float, ExprRef)
ariaanyOf(boolean, ExprRef)
baselineTextBaseline

Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the lineHeight rather than fontSize alone.

coloranyOf(anyOf(None, Color), ExprRef)
dxanyOf(float, ExprRef)
dyanyOf(float, ExprRef)
fontanyOf(string, ExprRef)
fontSizeanyOf(float, ExprRef)
fontStyleanyOf(FontStyle, ExprRef)
fontWeightanyOf(FontWeight, ExprRef)
frameanyOf(anyOf(TitleFrame, string), ExprRef)
limitanyOf(float, ExprRef)
lineHeightanyOf(float, ExprRef)
offsetanyOf(float, ExprRef)
orientanyOf(TitleOrient, ExprRef)
styleanyOf(string, List(string))

A mark style property to apply to the title text mark.

Default value: "group-title".

subtitleText

The subtitle Text.

subtitleColoranyOf(anyOf(None, Color), ExprRef)
subtitleFontanyOf(string, ExprRef)
subtitleFontSizeanyOf(float, ExprRef)
subtitleFontStyleanyOf(FontStyle, ExprRef)
subtitleFontWeightanyOf(FontWeight, ExprRef)
subtitleLineHeightanyOf(float, ExprRef)
subtitlePaddinganyOf(float, ExprRef)
zindexfloat

The integer z-index indicating the layering of the title group relative to other axis, mark and legend groups.

Default value: 0.

__init__(text=Undefined, align=Undefined, anchor=Undefined, angle=Undefined, aria=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, limit=Undefined, lineHeight=Undefined, offset=Undefined, orient=Undefined, style=Undefined, subtitle=Undefined, subtitleColor=Undefined, subtitleFont=Undefined, subtitleFontSize=Undefined, subtitleFontStyle=Undefined, subtitleFontWeight=Undefined, subtitleLineHeight=Undefined, subtitlePadding=Undefined, zindex=Undefined, **kwds)

Methods

__init__([text, align, anchor, angle, aria, ...])

copy([deep, ignore])

Return a copy of the object

from_dict(dct[, validate, _wrapper_classes])

Construct class from a dictionary representation

from_json(json_string[, validate])

Instantiate the object from a valid JSON string

resolve_references([schema])

Resolve references in the context of this object's schema or root schema.

to_dict([validate, ignore, context])

Return a dictionary representation of the object

to_json([validate, ignore, context, indent, ...])

Emit the JSON representation for this object as a string.

validate(instance[, schema])

Validate the instance against the class schema in the context of the rootschema.

validate_property(name, value[, schema])

Validate a property against property schema in the context of the rootschema