altair.HeaderConfig#

class altair.HeaderConfig(format=Undefined, formatType=Undefined, labelAlign=Undefined, labelAnchor=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOrient=Undefined, labelPadding=Undefined, labels=Undefined, orient=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)#

HeaderConfig schema wrapper

Mapping(required=[])

Attributes

formatanyOf(string, Dict)

When used with the default "number" and "time" format type, the text formatting pattern for labels of guides (axes, legends, headers) and text marks.

If the format type is "number" (e.g., for quantitative fields), this is D3’s number format pattern.
If the format type is "time" (e.g., for temporal fields), this is D3’s time format pattern.

See the format documentation for more examples.

When used with a custom formatType, this value will be passed as format alongside datum.value to the registered function.

Default value: Derived from numberFormat config for number format and from timeFormat config for time format.

formatTypestring

The format type for labels. One of "number", "time", or a registered custom format type.

Default value:

"time" for temporal fields and ordinal and nominal fields with timeUnit.
"number" for quantitative fields as well as ordinal and nominal fields without timeUnit.

labelAlignanyOf(Align, ExprRef)

Horizontal text alignment of header labels. One of "left", "center", or "right".

labelAnchorTitleAnchor

The anchor position for placing the labels. One of "start", "middle", or "end". For example, with a label orientation of top these anchor positions map to a left-, center-, or right-aligned label.

labelAnglefloat

The rotation angle of the header labels.

Default value: 0 for column header, -90 for row header.

labelBaselineanyOf(TextBaseline, ExprRef)

The vertical text baseline for the header labels. 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 titleLineHeight rather than titleFontSize alone.

labelColoranyOf(Color, ExprRef)

The color of the header label, can be in hex color code or regular color name.

labelExprstring

Vega expression for customizing labels.

Note: The label text and value can be assessed via the label and value properties of the header’s backing datum object.

labelFontanyOf(string, ExprRef)

The font of the header label.

labelFontSizeanyOf(float, ExprRef)

The font size of the header label, in pixels.

labelFontStyleanyOf(FontStyle, ExprRef)

The font style of the header label.

labelFontWeightanyOf(FontWeight, ExprRef)

The font weight of the header label.

labelLimitanyOf(float, ExprRef)

The maximum length of the header label in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.

Default value: 0, indicating no limit

labelLineHeightanyOf(float, ExprRef)

Line height in pixels for multi-line header labels or title text with "line-top" or "line-bottom" baseline.

labelOrientOrient

The orientation of the header label. One of "top", "bottom", "left" or "right".

labelPaddinganyOf(float, ExprRef)

The padding, in pixel, between facet header’s label and the plot.

Default value: 10

labelsboolean

A boolean flag indicating if labels should be included as part of the header.

Default value: true.

orientOrient

Shortcut for setting both labelOrient and titleOrient.

titleNone

Set to null to disable title for the axis, legend, or header.

titleAlignanyOf(Align, ExprRef)

Horizontal text alignment (to the anchor) of header titles.

titleAnchorTitleAnchor

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.

titleAnglefloat

The rotation angle of the header title.

Default value: 0.

titleBaselineanyOf(TextBaseline, ExprRef)

The vertical text baseline for the header title. 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 titleLineHeight rather than titleFontSize alone.

Default value: "middle"

titleColoranyOf(Color, ExprRef)

Color of the header title, can be in hex color code or regular color name.

titleFontanyOf(string, ExprRef)

Font of the header title. (e.g., "Helvetica Neue" ).

titleFontSizeanyOf(float, ExprRef)

Font size of the header title.

titleFontStyleanyOf(FontStyle, ExprRef)

The font style of the header title.

titleFontWeightanyOf(FontWeight, ExprRef)

Font weight of the header title. This can be either a string (e.g "bold", "normal" ) or a number ( 100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700 ).

titleLimitanyOf(float, ExprRef)

The maximum length of the header title in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.

Default value: 0, indicating no limit

titleLineHeightanyOf(float, ExprRef)

Line height in pixels for multi-line header title text or title text with "line-top" or "line-bottom" baseline.

titleOrientOrient

The orientation of the header title. One of "top", "bottom", "left" or "right".

titlePaddinganyOf(float, ExprRef)

The padding, in pixel, between facet header’s title and the label.

Default value: 10

__init__(format=Undefined, formatType=Undefined, labelAlign=Undefined, labelAnchor=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOrient=Undefined, labelPadding=Undefined, labels=Undefined, orient=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)#

Methods

`__init__`([format, formatType, labelAlign, ...])
`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

altair.Header

altair.HexColor