altair.theme.AxisConfigKwds#
- class altair.theme.AxisConfigKwds#
altair.AxisConfigTypedDictwrapper.- Parameters:
- aria
A boolean flag indicating if ARIA attributes should be included (SVG output only). If
false, the “aria-hidden” attribute will be set on the output SVG group, removing the axis from the ARIA accessibility tree.Default value:
true- bandPosition
An interpolation fraction indicating where, for
bandscales, axis ticks should be positioned. A value of0places ticks at the left edge of their bands. A value of0.5places ticks in the middle of their bands.Default value:
0.5- description
A text description of this axis for ARIA accessibility (SVG output only). If the
ariaproperty is true, for SVG output the “aria-label” attribute will be set to this description. If the description is unspecified it will be automatically generated.- disable
Disable axis by default.
- domain
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.
Default value:
true- domainCap
The stroke cap for the domain line’s ending style. One of
"butt","round"or"square".Default value:
"butt"- domainColor
Color of axis domain line.
Default value:
"gray".- domainDash
An array of alternating [stroke, space] lengths for dashed domain lines.
- domainDashOffset
The pixel offset at which to start drawing with the domain dash array.
- domainOpacity
Opacity of the axis domain line.
- domainWidth
Stroke width of axis domain line
Default value:
1- format
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
formatalongsidedatum.valueto the registered function.Default value: Derived from numberFormat config for number format and from timeFormat config for time format.
- formatType
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 withtimeUnit."number"for quantitative fields as well as ordinal and nominal fields withouttimeUnit.
- grid
A boolean flag indicating if grid lines should be included as part of the axis
Default value:
truefor continuous scales that are not binned; otherwise,false.- gridCap
The stroke cap for grid lines’ ending style. One of
"butt","round"or"square".Default value:
"butt"- gridColor
Color of gridlines.
Default value:
"lightGray".- gridDash
An array of alternating [stroke, space] lengths for dashed grid lines.
- gridDashOffset
The pixel offset at which to start drawing with the grid dash array.
- gridOpacity
The stroke opacity of grid (value between [0,1])
Default value:
1- gridWidth
The grid width, in pixels.
Default value:
1- labelAlign
Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.
- labelAngle
The rotation angle of the axis labels.
Default value:
-90for nominal and ordinal fields;0otherwise.- labelBaseline
Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. 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.- labelBound
Indicates if labels should be hidden if they exceed the axis range. If
false(the default) no bounds overlap analysis is performed. Iftrue, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.Default value:
false.- labelColor
The color of the tick label, can be in hex color code or regular color name.
- labelExpr
Vega expression for customizing labels.
Note: The label text and value can be assessed via the
labelandvalueproperties of the axis’s backingdatumobject.- labelFlush
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.
Default value:
truefor axis of a continuous x-scale. Otherwise,false.- labelFlushOffset
Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of
2will push flush-adjusted labels 2 pixels outward from the center of the axis. Offsets can help the labels better visually group with corresponding axis ticks.Default value:
0.- labelFont
The font of the tick label.
- labelFontSize
The font size of the label, in pixels.
- labelFontStyle
Font style of the title.
- labelFontWeight
Font weight of axis tick labels.
- labelLimit
Maximum allowed pixel width of axis tick labels.
Default value:
180- labelLineHeight
Line height in pixels for multi-line label text or label text with
"line-top"or"line-bottom"baseline.- labelOffset
Position offset in pixels to apply to labels, in addition to tickOffset.
Default value:
0- labelOpacity
The opacity of the labels.
- labelOverlap
The strategy to use for resolving overlap of axis labels. If
false(the default), no overlap reduction is attempted. If set totrueor"parity", a strategy of removing every other label is used (this works well for standard linear axes). If set to"greedy", a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).Default value:
truefor non-nominal fields with non-log scales;"greedy"for log scales; otherwisefalse.- labelPadding
The padding in pixels between labels and ticks.
Default value:
2- labelSeparation
The minimum separation that must be between label bounding boxes for them to be considered non-overlapping (default
0). This property is ignored if labelOverlap resolution is not enabled.- labels
A boolean flag indicating if labels should be included as part of the axis.
Default value:
true.- maxExtent
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.
Default value:
undefined.- minExtent
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.
Default value:
30for y-axis;undefinedfor x-axis.- offset
The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.
Default value: derived from the axis config’s
offset(0by default)- orient
The orientation of the axis. One of
"top","bottom","left"or"right". The orientation can be used to further specialize the axis type (e.g., a y-axis oriented towards the right edge of the chart).Default value:
"bottom"for x-axes and"left"for y-axes.- position
The anchor position of the axis in pixels. For x-axes with top or bottom orientation, this sets the axis group x coordinate. For y-axes with left or right orientation, this sets the axis group y coordinate.
Default value:
0- style
A string or array of strings indicating the name of custom styles to apply to the axis. A style is a named collection of axis property defined within the style configuration. If style is an array, later styles will override earlier styles.
Default value: (none) Note: Any specified style will augment the default style. For example, an x-axis mark with
"style": "foo"will useconfig.axisXandconfig.style.foo(the specified style"foo"has higher precedence).- tickBand
For band scales, indicates if ticks and grid lines should be placed at the
"center"of a band (default) or at the band ``”extent”``s to indicate intervals- tickCap
The stroke cap for the tick lines’ ending style. One of
"butt","round"or"square".Default value:
"butt"- tickColor
The color of the axis’s tick.
Default value:
"gray"- tickCount
A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range.
For scales of type
"time"or"utc", the tick count can instead be a time interval specifier. Legal string values are"millisecond","second","minute","hour","day","week","month", and"year". Alternatively, an object-valued interval specifier of the form{"interval": "month", "step": 3}includes a desired number of interval steps. Here, ticks are generated for each quarter (Jan, Apr, Jul, Oct) boundary.Default value: Determine using a formula
ceil(width/40)for x andceil(height/40)for y.- tickDash
An array of alternating [stroke, space] lengths for dashed tick mark lines.
- tickDashOffset
The pixel offset at which to start drawing with the tick mark dash array.
- tickExtra
Boolean flag indicating if an extra axis tick should be added for the initial position of the axis. This flag is useful for styling axes for
bandscales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with"bandPosition": 1and an axis"padding"value of0.- tickMinStep
The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.- tickOffset
Position offset in pixels to apply to ticks, labels, and gridlines.
- tickOpacity
Opacity of the ticks.
- tickRound
Boolean flag indicating if pixel position values should be rounded to the nearest integer.
Default value:
true- tickSize
The size in pixels of axis ticks.
Default value:
5- tickWidth
The width, in pixels, of ticks.
Default value:
1- ticks
Boolean value that determines whether the axis should include ticks.
Default value:
true- title
A title for the field. If
null, the title will be removed.Default value: derived from the field’s name and transformation function (
aggregate,binandtimeUnit). If the field has an aggregate function, the function is displayed as part of the title (e.g.,"Sum of Profit"). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g.,"Profit (binned)","Transaction Date (year-month)"). Otherwise, the title is simply the field name.Notes:
1) You can customize the default field title format by providing the fieldTitle property in the config or fieldTitle function via the compile function’s options.
2) If both field definition’s
titleand axis, header, or legendtitleare defined, axis/header/legend title will be used.- titleAlign
Horizontal text alignment of axis titles.
- titleAnchor
Text anchor position for placing axis titles.
- titleAngle
Angle in degrees of axis titles.
- titleBaseline
Vertical text baseline for axis titles. 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.- titleColor
Color of the title, can be in hex color code or regular color name.
- titleFont
Font of the title. (e.g.,
"Helvetica Neue").- titleFontSize
Font size of the title.
- titleFontStyle
Font style of the title.
- titleFontWeight
Font weight of the title. This can be either a string (e.g
"bold","normal") or a number (100,200,300, …,900where"normal"=400and"bold"=700).- titleLimit
Maximum allowed pixel width of axis titles.
- titleLineHeight
Line height in pixels for multi-line title text or title text with
"line-top"or"line-bottom"baseline.- titleOpacity
Opacity of the axis title.
- titlePadding
The padding, in pixels, between title and axis.
- titleX
X-coordinate of the axis title relative to the axis group.
- titleY
Y-coordinate of the axis title relative to the axis group.
- translate
Coordinate space translation offset for axis layout. By default, axes are translated by a 0.5 pixel offset for both the x and y coordinates in order to align stroked lines with the pixel grid. However, for vector graphics output these pixel-specific adjustments may be undesirable, in which case translate can be changed (for example, to zero).
Default value:
0.5- values
Explicitly set the visible axis tick values.
- zindex
A non-negative integer indicating the z-index of the axis. If zindex is 0, axes should be drawn behind all chart elements. To put them in front, set
zindexto1or more.Default value:
0(behind the marks).
- __init__(*args, **kwargs)#
Methods
__init__(*args, **kwargs)clear()copy()fromkeys(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
get(key[, default])Return the value for key if key is in the dictionary, else default.
items()keys()pop(key[, default])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()Attributes
ariabandPositiondescriptiondisabledomaindomainCapdomainColordomainDashdomainDashOffsetdomainOpacitydomainWidthformatformatTypegridgridCapgridColorgridDashgridDashOffsetgridOpacitygridWidthlabelAlignlabelAnglelabelBaselinelabelBoundlabelColorlabelExprlabelFlushlabelFlushOffsetlabelFontlabelFontSizelabelFontStylelabelFontWeightlabelLimitlabelLineHeightlabelOffsetlabelOpacitylabelOverlaplabelPaddinglabelSeparationlabelsmaxExtentminExtentoffsetorientpositionstyletickBandtickCaptickColortickCounttickDashtickDashOffsettickExtratickMinSteptickOffsettickOpacitytickRoundtickSizetickWidthtickstitletitleAligntitleAnchortitleAngletitleBaselinetitleColortitleFonttitleFontSizetitleFontStyletitleFontWeighttitleLimittitleLineHeighttitleOpacitytitlePaddingtitleXtitleYtranslatezindex