altair.TopLevelMixin

class altair.TopLevelMixin

Mixin for top-level chart objects such as Chart, LayeredChart, etc.

__init__($self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

configure([area, autosize, axis, axisBand, …]) Config schema wrapper
configure_area([align, angle, aspect, …]) AreaConfig schema wrapper
configure_axis([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisBand([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisBottom([bandPosition, …]) AxisConfig schema wrapper
configure_axisDiscrete([bandPosition, …]) AxisConfig schema wrapper
configure_axisLeft([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisPoint([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisQuantitative([bandPosition, …]) AxisConfig schema wrapper
configure_axisRight([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisTemporal([bandPosition, …]) AxisConfig schema wrapper
configure_axisTop([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisX([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisXBand([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisXDiscrete([bandPosition, …]) AxisConfig schema wrapper
configure_axisXPoint([bandPosition, …]) AxisConfig schema wrapper
configure_axisXQuantitative([bandPosition, …]) AxisConfig schema wrapper
configure_axisXTemporal([bandPosition, …]) AxisConfig schema wrapper
configure_axisY([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisYBand([bandPosition, disable, …]) AxisConfig schema wrapper
configure_axisYDiscrete([bandPosition, …]) AxisConfig schema wrapper
configure_axisYPoint([bandPosition, …]) AxisConfig schema wrapper
configure_axisYQuantitative([bandPosition, …]) AxisConfig schema wrapper
configure_axisYTemporal([bandPosition, …]) AxisConfig schema wrapper
configure_bar([align, angle, aspect, …]) BarConfig schema wrapper
configure_boxplot([box, extent, median, …]) BoxPlotConfig schema wrapper
configure_circle([align, angle, aspect, …]) MarkConfig schema wrapper
configure_concat([columns, spacing]) CompositionConfig schema wrapper
configure_errorband([band, borders, extent, …]) ErrorBandConfig schema wrapper
configure_errorbar([extent, rule, ticks]) ErrorBarConfig schema wrapper
configure_facet([columns, spacing]) CompositionConfig schema wrapper
configure_geoshape([align, angle, aspect, …]) MarkConfig schema wrapper
configure_header([format, formatType, …]) HeaderConfig schema wrapper
configure_headerColumn([format, formatType, …]) HeaderConfig schema wrapper
configure_headerFacet([format, formatType, …]) HeaderConfig schema wrapper
configure_headerRow([format, formatType, …]) HeaderConfig schema wrapper
configure_image([align, angle, aspect, …]) RectConfig schema wrapper
configure_legend([clipHeight, …]) LegendConfig schema wrapper
configure_line([align, angle, aspect, …]) LineConfig schema wrapper
configure_mark([align, angle, aspect, …]) MarkConfig schema wrapper
configure_point([align, angle, aspect, …]) MarkConfig schema wrapper
configure_projection([center, clipAngle, …]) ProjectionConfig schema wrapper
configure_range([category, diverging, …]) RangeConfig schema wrapper
configure_rect([align, angle, aspect, …]) RectConfig schema wrapper
configure_rule([align, angle, aspect, …]) MarkConfig schema wrapper
configure_scale([bandPaddingInner, …]) ScaleConfig schema wrapper
configure_selection([interval, multi, single]) SelectionConfig schema wrapper
configure_square([align, angle, aspect, …]) MarkConfig schema wrapper
configure_text([align, angle, aspect, …]) MarkConfig schema wrapper
configure_tick([align, angle, aspect, …]) TickConfig schema wrapper
configure_title([align, anchor, angle, …]) TitleConfig schema wrapper
configure_trail([align, angle, aspect, …]) LineConfig schema wrapper
configure_view([clip, continuousHeight, …]) ViewConfig schema wrapper
display([renderer, theme, actions]) Display chart in Jupyter notebook or JupyterLab
project([type, center, clipAngle, …]) Add a geographic projection to the chart.
properties(**kwargs) Set top-level properties of the Chart.
repeat([repeat, row, column, columns]) Return a RepeatChart built from the chart
resolve_axis([x, y]) AxisResolveMap schema wrapper
resolve_legend([color, fill, fillOpacity, …]) LegendResolveMap schema wrapper
resolve_scale([color, fill, fillOpacity, …]) ScaleResolveMap schema wrapper
save(fp[, format, …]) Save a chart to file in a variety of formats
serve([ip, port, n_retries, files, …]) Open a browser window and display a rendering of the chart
show([embed_opt, open_browser]) Show the chart in an external browser window.
to_dict(*args, **kwargs) Convert the chart to a dictionary suitable for JSON export
to_html([base_url, output_div, …])
transform_aggregate([aggregate, groupby]) Add an AggregateTransform to the schema.
transform_bin([as_, field, bin]) Add a BinTransform to the schema.
transform_calculate([as_, calculate]) Add a CalculateTransform to the schema.
transform_density(density[, as_, bandwidth, …]) Add a DensityTransform to the spec.
transform_filter(filter, **kwargs) Add a FilterTransform to the schema.
transform_flatten(flatten[, as_]) Add a FlattenTransform to the schema.
transform_fold(fold[, as_]) Add a FoldTransform to the spec.
transform_impute(impute, key[, frame, …]) Add an ImputeTransform to the schema.
transform_joinaggregate([joinaggregate, groupby]) Add a JoinAggregateTransform to the schema.
transform_loess(on, loess[, as_, bandwidth, …]) Add a LoessTransform to the spec.
transform_lookup([lookup, from_, as_, default]) Add a DataLookupTransform or SelectionLookupTransform to the chart
transform_pivot(pivot, value[, groupby, …]) Add a pivot transform to the chart.
transform_quantile(quantile[, as_, groupby, …]) Add a quantile transform to the chart
transform_regression(on, regression[, as_, …]) Add a RegressionTransform to the chart.
transform_sample([sample]) Add a SampleTransform to the schema.
transform_stack(as_, stack, groupby[, …]) Add a StackTransform to the schema.
transform_timeunit([as_, field, timeUnit]) Add a TimeUnitTransform to the schema.
transform_window([window, frame, groupby, …]) Add a WindowTransform to the schema
configure(area=Undefined, autosize=Undefined, axis=Undefined, axisBand=Undefined, axisBottom=Undefined, axisDiscrete=Undefined, axisLeft=Undefined, axisPoint=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTemporal=Undefined, axisTop=Undefined, axisX=Undefined, axisXBand=Undefined, axisXDiscrete=Undefined, axisXPoint=Undefined, axisXQuantitative=Undefined, axisXTemporal=Undefined, axisY=Undefined, axisYBand=Undefined, axisYDiscrete=Undefined, axisYPoint=Undefined, axisYQuantitative=Undefined, axisYTemporal=Undefined, background=Undefined, bar=Undefined, boxplot=Undefined, circle=Undefined, concat=Undefined, countTitle=Undefined, errorband=Undefined, errorbar=Undefined, facet=Undefined, fieldTitle=Undefined, font=Undefined, geoshape=Undefined, header=Undefined, headerColumn=Undefined, headerFacet=Undefined, headerRow=Undefined, image=Undefined, legend=Undefined, line=Undefined, lineBreak=Undefined, mark=Undefined, numberFormat=Undefined, padding=Undefined, point=Undefined, projection=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, selection=Undefined, square=Undefined, style=Undefined, text=Undefined, tick=Undefined, timeFormat=Undefined, title=Undefined, trail=Undefined, view=Undefined, **kwds)

Config schema wrapper

Mapping(required=[])

Attributes:
area : AreaConfig

Area-Specific Config

autosize : anyOf(AutosizeType, AutoSizeParams)

How the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing.

Default value : pad

axis : AxisConfig

Axis configuration, which determines default properties for all x and y axes. For a full list of axis configuration options, please see the corresponding section of the axis documentation.

axisBand : AxisConfig

Config for axes with “band” scales.

axisBottom : AxisConfig

Config for x-axis along the bottom edge of the chart.

axisDiscrete : AxisConfig

Config for axes with “point” or “band” scales.

axisLeft : AxisConfig

Config for y-axis along the left edge of the chart.

axisPoint : AxisConfig

Config for axes with “point” scales.

axisQuantitative : AxisConfig

Config for quantitative axes.

axisRight : AxisConfig

Config for y-axis along the right edge of the chart.

axisTemporal : AxisConfig

Config for temporal axes.

axisTop : AxisConfig

Config for x-axis along the top edge of the chart.

axisX : AxisConfig

X-axis specific config.

axisXBand : AxisConfig

Config for x-axes with “band” scales.

axisXDiscrete : AxisConfig

Config for x-axes with “point” or “band” scales.

axisXPoint : AxisConfig

Config for x-axes with “point” scales.

axisXQuantitative : AxisConfig

Config for x-quantitative axes.

axisXTemporal : AxisConfig

Config for x-temporal axes.

axisY : AxisConfig

Y-axis specific config.

axisYBand : AxisConfig

Config for y-axes with “band” scales.

axisYDiscrete : AxisConfig

Config for y-axes with “point” or “band” scales.

axisYPoint : AxisConfig

Config for y-axes with “point” scales.

axisYQuantitative : AxisConfig

Config for y-quantitative axes.

axisYTemporal : AxisConfig

Config for y-temporal axes.

background : Color

CSS color property to use as the background of the entire view.

Default value: "white"

bar : BarConfig

Bar-Specific Config

boxplot : BoxPlotConfig

Box Config

circle : MarkConfig

Circle-Specific Config

concat : CompositionConfig

Default configuration for all concatenation and repeat view composition operators ( concat, hconcat, vconcat, and repeat )

countTitle : string

Default axis and legend title for count fields.

Default value: 'Count of Records.

errorband : ErrorBandConfig

ErrorBand Config

errorbar : ErrorBarConfig

ErrorBar Config

facet : CompositionConfig

Default configuration for the facet view composition operator

fieldTitle : enum(‘verbal’, ‘functional’, ‘plain’)

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., “Sum of field”, “Year-month of date”, “field (binned)”).
  • "function" - displays function using parentheses and capitalized texts (e.g., “SUM(field)”, “YEARMONTH(date)”, “BIN(field)”).
  • "plain" - displays only the field name without functions (e.g., “field”, “date”, “field”).
font : string

Default font for all text marks, titles, and labels.

geoshape : MarkConfig

Geoshape-Specific Config

header : HeaderConfig

Header configuration, which determines default properties for all headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerColumn : HeaderConfig

Header configuration, which determines default properties for column headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerFacet : HeaderConfig

Header configuration, which determines default properties for non-row/column facet headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerRow : HeaderConfig

Header configuration, which determines default properties for row headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

image : RectConfig

Image-specific Config

legend : LegendConfig

Legend configuration, which determines default properties for all legends. For a full list of legend configuration options, please see the corresponding section of in the legend documentation.

line : LineConfig

Line-Specific Config

lineBreak : string

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property provides a global default for text marks, which is overridden by mark or style config settings, and by the lineBreak mark encoding channel. If signal-valued, either string or regular expression (regexp) values are valid.

mark : MarkConfig

Mark Config

numberFormat : string

D3 Number format for guide labels and text marks. For example "s" for SI units. Use D3’s number format pattern.

padding : Padding

The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides. If an object, the value should have the format {"left": 5, "top": 5, "right": 5, "bottom": 5} to specify padding for each side of the visualization.

Default value : 5

point : MarkConfig

Point-Specific Config

projection : ProjectionConfig

Projection configuration, which determines default properties for all projections. For a full list of projection configuration options, please see the corresponding section of the projection documentation.

range : RangeConfig

An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the corresponding section of the scale documentation.

rect : RectConfig

Rect-Specific Config

rule : MarkConfig

Rule-Specific Config

scale : ScaleConfig

Scale configuration determines default properties for all scales. For a full list of scale configuration options, please see the corresponding section of the scale documentation.

selection : SelectionConfig

An object hash for defining default properties for each type of selections.

square : MarkConfig

Square-Specific Config

style : StyleConfigIndex

An object hash that defines key-value mappings to determine default properties for marks with a given style. The keys represent styles names; the values have to be valid mark configuration objects.

text : MarkConfig

Text-Specific Config

tick : TickConfig

Tick-Specific Config

timeFormat : string

Default time format for raw time values (without time units) in text marks, legend labels and header labels.

Default value: "%b %d, %Y" Note: Axes automatically determine the format for each label automatically so this config does not affect axes.

title : TitleConfig

Title configuration, which determines default properties for all titles. For a full list of title configuration options, please see the corresponding section of the title documentation.

trail : LineConfig

Trail-Specific Config

view : ViewConfig

Default properties for single view plots.

configure_area(align=Undefined, angle=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, line=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, point=Undefined, radius=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, timeUnitBand=Undefined, timeUnitBandPosition=Undefined, tooltip=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

AreaConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

aspect : boolean

Whether to keep aspect ratio of image marks.

baseline : TextBaseline

The vertical text baseline. 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.

blend : Blend

The color blend mode for drawing an item on its current background. Any valid CSS mix-blend-mode value can be used.

__Default value: "source-over"

color : anyOf(Color, Gradient)

Default color.

Default value: "#4682b4"

Note:

  • This property cannot be used in a style config.
  • The fill and stroke properties have higher precedence than color and will override color.
cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cornerRadiusBottomLeft : float

The radius in pixels of rounded rectangle bottom left corner.

Default value: 0

cornerRadiusBottomRight : float

The radius in pixels of rounded rectangle bottom right corner.

Default value: 0

cornerRadiusTopLeft : float

The radius in pixels of rounded rectangle top right corner.

Default value: 0

cornerRadiusTopRight : float

The radius in pixels of rounded rectangle top left corner.

Default value: 0

cursor : Cursor

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

dir : TextDirection

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

Default value: "ltr"

dx : float

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy : float

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

ellipsis : string

The ellipsis string for text truncated in response to the limit parameter.

Default value: "…"

fill : anyOf(Color, Gradient, None)

Default Fill Color. This property has higher precedence than config.color.

Default value: (None)

fillOpacity : float

The fill opacity (value between [0,1]).

Default value: 1

filled : boolean

Whether the mark’s color should be used as fill color instead of stroke color.

Default value: false for all point, line, and rule marks as well as geoshape marks for graticule data sources; otherwise, true.

Note: This property cannot be used in a style config.

font : string

The typeface to set the text in (e.g., "Helvetica Neue" ).

fontSize : float

The font size, in pixels.

Default value: 11

fontStyle : FontStyle

The font style (e.g., "italic" ).

fontWeight : FontWeight

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

height : float

Height of the marks.

href : string

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

interpolate : Interpolate

The line interpolation method to use for line and area marks. One of the following:

  • "linear" : piecewise linear segments, as in a polyline.
  • "linear-closed" : close the linear segments to form a polygon.
  • "step" : alternate between horizontal and vertical segments, as in a step function.
  • "step-before" : alternate between vertical and horizontal segments, as in a step function.
  • "step-after" : alternate between horizontal and vertical segments, as in a step function.
  • "basis" : a B-spline, with control point duplication on the ends.
  • "basis-open" : an open B-spline; may not intersect the start or end.
  • "basis-closed" : a closed B-spline, as in a loop.
  • "cardinal" : a Cardinal spline, with control point duplication on the ends.
  • "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
  • "cardinal-closed" : a closed Cardinal spline, as in a loop.
  • "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.
  • "monotone" : cubic interpolation that preserves monotonicity in y.
invalid : enum(‘filter’, None)

Defines how Vega-Lite should handle marks for invalid values ( null and NaN ).

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
limit : float

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

Default value: 0 – indicating no limit

line : anyOf(boolean, OverlayMarkDef)

A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines.

If this value is an empty object ( {} ) or true, lines with default properties will be used.

If this value is false, no lines would be automatically added to area marks.

Default value: false.

lineBreak : string

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property is ignored if the text is array-valued.

lineHeight : float

The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.

opacity : float

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

order : anyOf(None, boolean)

For line and trail marks, this order property can be set to null or false to make the lines use the original order in the data sources.

orient : Orientation

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical.

  • For bar, rule and tick, this determines whether the size of the bar and tick

should be applied to x or y dimension. * For area, this property determines the orient property of the Vega output. * For line and trail marks, this property determines the sort order of the points in

the line

if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

point : anyOf(boolean, OverlayMarkDef, enum(‘transparent’))

A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points.

If this property is "transparent", transparent points will be used (for enhancing tooltips and selections).

If this property is an empty object ( {} ) or true, filled points with default properties will be used.

If this property is false, no points would be automatically added to line or area marks.

Default value: false.

radius : float

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

shape : anyOf(SymbolShape, string)

Shape of the point marks. Supported values include:

  • plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".
  • the line symbol "stroke"
  • centered directional shapes "arrow", "wedge", or "triangle"
  • a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

Default value: "circle"

size : float

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.
  • For bar, this represents the band size of the bar, in pixels.
  • For text, this represents the font size, in pixels.

Default value:

  • 30 for point, circle, square marks; width/height’s step
  • 2 for bar marks with discrete dimensions;
  • 5 for bar marks with continuous dimensions;
  • 11 for text marks.
stroke : anyOf(Color, Gradient, None)

Default Stroke Color. This property has higher precedence than config.color.

Default value: (None)

strokeCap : string

The stroke cap for line ending style. One of "butt", "round", or "square".

Default value: "butt"

strokeDash : List(float)

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset : float

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeJoin : string

The stroke line join method. One of "miter", "round" or "bevel".

Default value: "miter"

strokeMiterLimit : float

The miter limit at which to bevel a line join.

strokeOffset : float

The offset in pixels at which to draw the group stroke and fill. If unspecified, the default behavior is to dynamically offset stroked groups such that 1 pixel stroke widths align with the pixel grid.

strokeOpacity : float

The stroke opacity (value between [0,1]).

Default value: 1

strokeWidth : float

The stroke width, in pixels.

tension : float

Depending on the interpolation type, sets the tension parameter (for line and area marks).

text : Text

Placeholder text if the text channel is not specified

theta : float

Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating “north”.

timeUnitBand : float

Default relative band size for a time unit. If set to 1, the bandwidth of the marks will be equal to the time unit band step. If set to 0.5, bandwidth of the marks will be half of the time unit band step.

timeUnitBandPosition : float

Default relative band position for a time unit. If set to 0, the marks will be positioned at the beginning of the time unit band step. If set to 0.5, the marks will be positioned in the middle of the time unit band step.

tooltip : anyOf(float, string, boolean, TooltipContent, None)

The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.

  • If tooltip is true or {"content": "encoding"}, then all fields from encoding will be used.
  • If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used.
  • If set to null or false, then no tooltip will be used.

See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.

Default value: null

width : float

Width of the marks.

x : anyOf(float, enum(‘width’))

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

x2 : anyOf(float, enum(‘width’))

X2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "width" for the width of the plot.

y : anyOf(float, enum(‘height’))

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

y2 : anyOf(float, enum(‘height’))

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

configure_axis(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisBand(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisBottom(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisDiscrete(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisLeft(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisPoint(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisQuantitative(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisRight(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisTemporal(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisTop(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisX(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisXBand(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisXDiscrete(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisXPoint(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisXQuantitative(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisXTemporal(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisY(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisYBand(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisYDiscrete(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisYPoint(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisYQuantitative(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_axisYTemporal(bandPosition=Undefined, disable=Undefined, domain=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainOpacity=Undefined, domainWidth=Undefined, grid=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelBound=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, style=Undefined, tickBand=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickExtra=Undefined, tickOffset=Undefined, tickOpacity=Undefined, tickRound=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=Undefined, translate=Undefined, **kwds)

AxisConfig schema wrapper

Mapping(required=[])

Attributes:
bandPosition : float

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Default value: 0.5

disable : boolean

Disable axis by default.

domain : boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor : anyOf(None, Color)

Color of axis domain line.

Default value: "gray".

domainDash : List(float)

An array of alternating [stroke, space] lengths for dashed domain lines.

domainDashOffset : float

The pixel offset at which to start drawing with the domain dash array.

domainOpacity : float

Opacity of the axis domain line.

domainWidth : float

Stroke width of axis domain line

Default value: 1

grid : boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
gridDash : anyOf(List(float), ConditionalAxisNumberArray)
gridDashOffset : anyOf(float, ConditionalAxisNumber)
gridOpacity : anyOf(float, ConditionalAxisNumber)
gridWidth : anyOf(float, ConditionalAxisNumber)
labelAlign : anyOf(Align, ConditionalAxisLabelAlign)
labelAngle : float

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

labelBaseline : anyOf(TextBaseline, ConditionalAxisLabelBaseline)
labelBound : anyOf(float, boolean)

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, 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 : anyOf(anyOf(None, Color), ConditionalAxisColor)
labelExpr : string

Vega expression for customizing labels.

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

labelFlush : anyOf(boolean, float)

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: true for axis of a continuous x-scale. Otherwise, false.

labelFlushOffset : float

Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of 2 will 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 : anyOf(string, ConditionalAxisString)
labelFontSize : anyOf(float, ConditionalAxisNumber)
labelFontStyle : anyOf(FontStyle, ConditionalAxisLabelFontStyle)
labelFontWeight : anyOf(FontWeight, ConditionalAxisLabelFontWeight)
labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelLineHeight : float

Line height in pixels for multi-line label text.

labelOffset : anyOf(float, ConditionalAxisNumber)
labelOpacity : anyOf(float, ConditionalAxisNumber)
labelOverlap : LabelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or "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: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding : anyOf(float, ConditionalAxisNumber)
labelSeparation : float

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 : boolean

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

Default value: true.

maxExtent : float

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 : float

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset : float

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 ( 0 by default)

orient : AxisOrient

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.

style : anyOf(string, List(string))

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 use config.axisX and config.style.foo (the specified style "foo" has higher precedence).

tickBand : enum(‘center’, ‘extent’)

For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.

tickColor : anyOf(anyOf(None, Color), ConditionalAxisColor)
tickCount : float

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.

Default value : Determine using a formula ceil(width/40) for x and ceil(height/40) for y.

tickDash : anyOf(List(float), ConditionalAxisNumberArray)
tickDashOffset : anyOf(float, ConditionalAxisNumber)
tickExtra : boolean

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 band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with "bandPosition": 1 and an axis "padding" value of 0.

tickOffset : float

Position offset in pixels to apply to ticks, labels, and gridlines.

tickOpacity : anyOf(float, ConditionalAxisNumber)
tickRound : boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Default value: true

tickSize : anyOf(float, ConditionalAxisNumber)
tickWidth : anyOf(float, ConditionalAxisNumber)
ticks : boolean

Boolean value that determines whether the axis should include ticks.

Default value: true

title : None

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

titleAlign : Align

Horizontal text alignment of axis titles.

titleAnchor : TitleAnchor

Text anchor position for placing axis titles.

titleAngle : float

Angle in degrees of axis titles.

titleBaseline : TextBaseline

Vertical text baseline for axis titles.

titleColor : anyOf(None, Color)

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

titleFont : string

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

titleFontSize : float

Font size of the title.

titleFontStyle : FontStyle

Font style of the title.

titleFontWeight : FontWeight

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

titleLimit : float

Maximum allowed pixel width of axis titles.

titleLineHeight : float

Line height in pixels for multi-line title text.

titleOpacity : float

Opacity of the axis title.

titlePadding : float

The padding, in pixels, between title and axis.

titleX : float

X-coordinate of the axis title relative to the axis group.

titleY : float

Y-coordinate of the axis title relative to the axis group.

translate : float

Translation offset in pixels applied to the axis group mark x and y. If specified, overrides the default behavior of a 0.5 offset to pixel-align stroked lines.

configure_bar(align=Undefined, angle=Undefined, aspect=Undefined, baseline=Undefined, binSpacing=Undefined, blend=Undefined, color=Undefined, continuousBandSize=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusEnd=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, dir=Undefined, discreteBandSize=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, radius=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, timeUnitBand=Undefined, timeUnitBandPosition=Undefined, tooltip=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

BarConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

aspect : boolean

Whether to keep aspect ratio of image marks.

baseline : TextBaseline

The vertical text baseline. 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.

binSpacing : float

Offset between bars for binned field. The ideal value for this is either 0 (preferred by statisticians) or 1 (Vega-Lite default, D3 example style).

Default value: 1

blend : Blend

The color blend mode for drawing an item on its current background. Any valid CSS mix-blend-mode value can be used.

__Default value: "source-over"

color : anyOf(Color, Gradient)

Default color.

Default value: "#4682b4"

Note:

  • This property cannot be used in a style config.
  • The fill and stroke properties have higher precedence than color and will override color.
continuousBandSize : float

The default size of the bars on continuous scales.

Default value: 5

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cornerRadiusBottomLeft : float

The radius in pixels of rounded rectangle bottom left corner.

Default value: 0

cornerRadiusBottomRight : float

The radius in pixels of rounded rectangle bottom right corner.

Default value: 0

cornerRadiusEnd : float
  • For vertical bars, top-left and top-right corner radius.
  • For horizontal bars, top-right and bottom-right corner radius.
cornerRadiusTopLeft : float

The radius in pixels of rounded rectangle top right corner.

Default value: 0

cornerRadiusTopRight : float

The radius in pixels of rounded rectangle top left corner.

Default value: 0

cursor : Cursor

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

dir : TextDirection

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

Default value: "ltr"

discreteBandSize : float

The default size of the bars with discrete dimensions. If unspecified, the default size is step-2, which provides 2 pixel offset between bars.

dx : float

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy : float

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

ellipsis : string

The ellipsis string for text truncated in response to the limit parameter.

Default value: "…"

fill : anyOf(Color, Gradient, None)

Default Fill Color. This property has higher precedence than config.color.

Default value: (None)

fillOpacity : float

The fill opacity (value between [0,1]).

Default value: 1

filled : boolean

Whether the mark’s color should be used as fill color instead of stroke color.

Default value: false for all point, line, and rule marks as well as geoshape marks for graticule data sources; otherwise, true.

Note: This property cannot be used in a style config.

font : string

The typeface to set the text in (e.g., "Helvetica Neue" ).

fontSize : float

The font size, in pixels.

Default value: 11

fontStyle : FontStyle

The font style (e.g., "italic" ).

fontWeight : FontWeight

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

height : float

Height of the marks.

href : string

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

interpolate : Interpolate

The line interpolation method to use for line and area marks. One of the following:

  • "linear" : piecewise linear segments, as in a polyline.
  • "linear-closed" : close the linear segments to form a polygon.
  • "step" : alternate between horizontal and vertical segments, as in a step function.
  • "step-before" : alternate between vertical and horizontal segments, as in a step function.
  • "step-after" : alternate between horizontal and vertical segments, as in a step function.
  • "basis" : a B-spline, with control point duplication on the ends.
  • "basis-open" : an open B-spline; may not intersect the start or end.
  • "basis-closed" : a closed B-spline, as in a loop.
  • "cardinal" : a Cardinal spline, with control point duplication on the ends.
  • "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
  • "cardinal-closed" : a closed Cardinal spline, as in a loop.
  • "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.
  • "monotone" : cubic interpolation that preserves monotonicity in y.
invalid : enum(‘filter’, None)

Defines how Vega-Lite should handle marks for invalid values ( null and NaN ).

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
limit : float

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

Default value: 0 – indicating no limit

lineBreak : string

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property is ignored if the text is array-valued.

lineHeight : float

The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.

opacity : float

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

order : anyOf(None, boolean)

For line and trail marks, this order property can be set to null or false to make the lines use the original order in the data sources.

orient : Orientation

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical.

  • For bar, rule and tick, this determines whether the size of the bar and tick

should be applied to x or y dimension. * For area, this property determines the orient property of the Vega output. * For line and trail marks, this property determines the sort order of the points in

the line

if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

radius : float

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

shape : anyOf(SymbolShape, string)

Shape of the point marks. Supported values include:

  • plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".
  • the line symbol "stroke"
  • centered directional shapes "arrow", "wedge", or "triangle"
  • a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

Default value: "circle"

size : float

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.
  • For bar, this represents the band size of the bar, in pixels.
  • For text, this represents the font size, in pixels.

Default value:

  • 30 for point, circle, square marks; width/height’s step
  • 2 for bar marks with discrete dimensions;
  • 5 for bar marks with continuous dimensions;
  • 11 for text marks.
stroke : anyOf(Color, Gradient, None)

Default Stroke Color. This property has higher precedence than config.color.

Default value: (None)

strokeCap : string

The stroke cap for line ending style. One of "butt", "round", or "square".

Default value: "butt"

strokeDash : List(float)

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset : float

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeJoin : string

The stroke line join method. One of "miter", "round" or "bevel".

Default value: "miter"

strokeMiterLimit : float

The miter limit at which to bevel a line join.

strokeOffset : float

The offset in pixels at which to draw the group stroke and fill. If unspecified, the default behavior is to dynamically offset stroked groups such that 1 pixel stroke widths align with the pixel grid.

strokeOpacity : float

The stroke opacity (value between [0,1]).

Default value: 1

strokeWidth : float

The stroke width, in pixels.

tension : float

Depending on the interpolation type, sets the tension parameter (for line and area marks).

text : Text

Placeholder text if the text channel is not specified

theta : float

Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating “north”.

timeUnitBand : float

Default relative band size for a time unit. If set to 1, the bandwidth of the marks will be equal to the time unit band step. If set to 0.5, bandwidth of the marks will be half of the time unit band step.

timeUnitBandPosition : float

Default relative band position for a time unit. If set to 0, the marks will be positioned at the beginning of the time unit band step. If set to 0.5, the marks will be positioned in the middle of the time unit band step.

tooltip : anyOf(float, string, boolean, TooltipContent, None)

The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.

  • If tooltip is true or {"content": "encoding"}, then all fields from encoding will be used.
  • If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used.
  • If set to null or false, then no tooltip will be used.

See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.

Default value: null

width : float

Width of the marks.

x : anyOf(float, enum(‘width’))

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

x2 : anyOf(float, enum(‘width’))

X2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "width" for the width of the plot.

y : anyOf(float, enum(‘height’))

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

y2 : anyOf(float, enum(‘height’))

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

configure_boxplot(box=Undefined, extent=Undefined, median=Undefined, outliers=Undefined, rule=Undefined, size=Undefined, ticks=Undefined, **kwds)

BoxPlotConfig schema wrapper

Mapping(required=[])

Attributes:
box : anyOf(boolean, MarkConfig)
extent : anyOf(enum(‘min-max’), float)

The extent of the whiskers. Available options include:

  • "min-max" : min and max are the lower and upper whiskers respectively.
  • A number representing multiple of the interquartile range. This number will be multiplied by the IQR to determine whisker boundary, which spans from the smallest data to the largest data within the range [Q1 - k * IQR, Q3 + k * IQR] where Q1 and Q3 are the first and third quartiles while IQR is the interquartile range ( Q3-Q1 ).

Default value: 1.5.

median : anyOf(boolean, MarkConfig)
outliers : anyOf(boolean, MarkConfig)
rule : anyOf(boolean, MarkConfig)
size : float

Size of the box and median tick of a box plot

ticks : anyOf(boolean, MarkConfig)
configure_circle(align=Undefined, angle=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, radius=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, timeUnitBand=Undefined, timeUnitBandPosition=Undefined, tooltip=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

aspect : boolean

Whether to keep aspect ratio of image marks.

baseline : TextBaseline

The vertical text baseline. 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.

blend : Blend

The color blend mode for drawing an item on its current background. Any valid CSS mix-blend-mode value can be used.

__Default value: "source-over"

color : anyOf(Color, Gradient)

Default color.

Default value: "#4682b4"

Note:

  • This property cannot be used in a style config.
  • The fill and stroke properties have higher precedence than color and will override color.
cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cornerRadiusBottomLeft : float

The radius in pixels of rounded rectangle bottom left corner.

Default value: 0

cornerRadiusBottomRight : float

The radius in pixels of rounded rectangle bottom right corner.

Default value: 0

cornerRadiusTopLeft : float

The radius in pixels of rounded rectangle top right corner.

Default value: 0

cornerRadiusTopRight : float

The radius in pixels of rounded rectangle top left corner.

Default value: 0

cursor : Cursor

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

dir : TextDirection

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

Default value: "ltr"

dx : float

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy : float

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

ellipsis : string

The ellipsis string for text truncated in response to the limit parameter.

Default value: "…"

fill : anyOf(Color, Gradient, None)

Default Fill Color. This property has higher precedence than config.color.

Default value: (None)

fillOpacity : float

The fill opacity (value between [0,1]).

Default value: 1

filled : boolean

Whether the mark’s color should be used as fill color instead of stroke color.

Default value: false for all point, line, and rule marks as well as geoshape marks for graticule data sources; otherwise, true.

Note: This property cannot be used in a style config.

font : string

The typeface to set the text in (e.g., "Helvetica Neue" ).

fontSize : float

The font size, in pixels.

Default value: 11

fontStyle : FontStyle

The font style (e.g., "italic" ).

fontWeight : FontWeight

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

height : float

Height of the marks.

href : string

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

interpolate : Interpolate

The line interpolation method to use for line and area marks. One of the following:

  • "linear" : piecewise linear segments, as in a polyline.
  • "linear-closed" : close the linear segments to form a polygon.
  • "step" : alternate between horizontal and vertical segments, as in a step function.
  • "step-before" : alternate between vertical and horizontal segments, as in a step function.
  • "step-after" : alternate between horizontal and vertical segments, as in a step function.
  • "basis" : a B-spline, with control point duplication on the ends.
  • "basis-open" : an open B-spline; may not intersect the start or end.
  • "basis-closed" : a closed B-spline, as in a loop.
  • "cardinal" : a Cardinal spline, with control point duplication on the ends.
  • "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
  • "cardinal-closed" : a closed Cardinal spline, as in a loop.
  • "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.
  • "monotone" : cubic interpolation that preserves monotonicity in y.
invalid : enum(‘filter’, None)

Defines how Vega-Lite should handle marks for invalid values ( null and NaN ).

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
limit : float

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

Default value: 0 – indicating no limit

lineBreak : string

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property is ignored if the text is array-valued.

lineHeight : float

The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.

opacity : float

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

order : anyOf(None, boolean)

For line and trail marks, this order property can be set to null or false to make the lines use the original order in the data sources.

orient : Orientation

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical.

  • For bar, rule and tick, this determines whether the size of the bar and tick

should be applied to x or y dimension. * For area, this property determines the orient property of the Vega output. * For line and trail marks, this property determines the sort order of the points in

the line

if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

radius : float

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

shape : anyOf(SymbolShape, string)

Shape of the point marks. Supported values include:

  • plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".
  • the line symbol "stroke"
  • centered directional shapes "arrow", "wedge", or "triangle"
  • a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

Default value: "circle"

size : float

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.
  • For bar, this represents the band size of the bar, in pixels.
  • For text, this represents the font size, in pixels.

Default value:

  • 30 for point, circle, square marks; width/height’s step
  • 2 for bar marks with discrete dimensions;
  • 5 for bar marks with continuous dimensions;
  • 11 for text marks.
stroke : anyOf(Color, Gradient, None)

Default Stroke Color. This property has higher precedence than config.color.

Default value: (None)

strokeCap : string

The stroke cap for line ending style. One of "butt", "round", or "square".

Default value: "butt"

strokeDash : List(float)

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset : float

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeJoin : string

The stroke line join method. One of "miter", "round" or "bevel".

Default value: "miter"

strokeMiterLimit : float

The miter limit at which to bevel a line join.

strokeOffset : float

The offset in pixels at which to draw the group stroke and fill. If unspecified, the default behavior is to dynamically offset stroked groups such that 1 pixel stroke widths align with the pixel grid.

strokeOpacity : float

The stroke opacity (value between [0,1]).

Default value: 1

strokeWidth : float

The stroke width, in pixels.

tension : float

Depending on the interpolation type, sets the tension parameter (for line and area marks).

text : Text

Placeholder text if the text channel is not specified

theta : float

Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating “north”.

timeUnitBand : float

Default relative band size for a time unit. If set to 1, the bandwidth of the marks will be equal to the time unit band step. If set to 0.5, bandwidth of the marks will be half of the time unit band step.

timeUnitBandPosition : float

Default relative band position for a time unit. If set to 0, the marks will be positioned at the beginning of the time unit band step. If set to 0.5, the marks will be positioned in the middle of the time unit band step.

tooltip : anyOf(float, string, boolean, TooltipContent, None)

The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.

  • If tooltip is true or {"content": "encoding"}, then all fields from encoding will be used.
  • If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used.
  • If set to null or false, then no tooltip will be used.

See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.

Default value: null

width : float

Width of the marks.

x : anyOf(float, enum(‘width’))

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

x2 : anyOf(float, enum(‘width’))

X2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "width" for the width of the plot.

y : anyOf(float, enum(‘height’))

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

y2 : anyOf(float, enum(‘height’))

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

configure_concat(columns=Undefined, spacing=Undefined, **kwds)

CompositionConfig schema wrapper

Mapping(required=[])

Attributes:
columns : float

The number of columns to include in the view composition layout.

Default value : undefined – An infinite number of columns (a single row) will be assumed. This is equivalent to hconcat (for concat ) and to using the column channel (for facet and repeat ).

Note :

  1. This property is only for:
  • the general (wrappable) concat operator (not hconcat / vconcat )
  • the facet and repeat operator with one field/repetition definition (without row/column nesting)

2) Setting the columns to 1 is equivalent to vconcat (for concat ) and to using the row channel (for facet and repeat ).

spacing : float

The default spacing in pixels between composed sub-views.

Default value : 20

configure_errorband(band=Undefined, borders=Undefined, extent=Undefined, interpolate=Undefined, tension=Undefined, **kwds)

ErrorBandConfig schema wrapper

Mapping(required=[])

Attributes:
band : anyOf(boolean, MarkConfig)
borders : anyOf(boolean, MarkConfig)
extent : ErrorBarExtent

The extent of the band. Available options include:

  • "ci" : Extend the band to the confidence interval of the mean.
  • "stderr" : The size of band are set to the value of standard error, extending from the mean.
  • "stdev" : The size of band are set to the value of standard deviation, extending from the mean.
  • "iqr" : Extend the band to the q1 and q3.

Default value: "stderr".

interpolate : Interpolate

The line interpolation method for the error band. One of the following:

  • "linear" : piecewise linear segments, as in a polyline.
  • "linear-closed" : close the linear segments to form a polygon.
  • "step" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes at the midpoint of each pair of adjacent x-values.
  • "step-before" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes before the x-value.
  • "step-after" : a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes after the x-value.
  • "basis" : a B-spline, with control point duplication on the ends.
  • "basis-open" : an open B-spline; may not intersect the start or end.
  • "basis-closed" : a closed B-spline, as in a loop.
  • "cardinal" : a Cardinal spline, with control point duplication on the ends.
  • "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
  • "cardinal-closed" : a closed Cardinal spline, as in a loop.
  • "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.
  • "monotone" : cubic interpolation that preserves monotonicity in y.
tension : float

The tension parameter for the interpolation type of the error band.

configure_errorbar(extent=Undefined, rule=Undefined, ticks=Undefined, **kwds)

ErrorBarConfig schema wrapper

Mapping(required=[])

Attributes:
extent : ErrorBarExtent

The extent of the rule. Available options include:

  • "ci" : Extend the rule to the confidence interval of the mean.
  • "stderr" : The size of rule are set to the value of standard error, extending from the mean.
  • "stdev" : The size of rule are set to the value of standard deviation, extending from the mean.
  • "iqr" : Extend the rule to the q1 and q3.

Default value: "stderr".

rule : anyOf(boolean, MarkConfig)
ticks : anyOf(boolean, MarkConfig)
configure_facet(columns=Undefined, spacing=Undefined, **kwds)

CompositionConfig schema wrapper

Mapping(required=[])

Attributes:
columns : float

The number of columns to include in the view composition layout.

Default value : undefined – An infinite number of columns (a single row) will be assumed. This is equivalent to hconcat (for concat ) and to using the column channel (for facet and repeat ).

Note :

  1. This property is only for:
  • the general (wrappable) concat operator (not hconcat / vconcat )
  • the facet and repeat operator with one field/repetition definition (without row/column nesting)

2) Setting the columns to 1 is equivalent to vconcat (for concat ) and to using the row channel (for facet and repeat ).

spacing : float

The default spacing in pixels between composed sub-views.

Default value : 20

configure_geoshape(align=Undefined, angle=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, radius=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, timeUnitBand=Undefined, timeUnitBandPosition=Undefined, tooltip=Undefined, width=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

aspect : boolean

Whether to keep aspect ratio of image marks.

baseline : TextBaseline

The vertical text baseline. 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.

blend : Blend

The color blend mode for drawing an item on its current background. Any valid CSS mix-blend-mode value can be used.

__Default value: "source-over"

color : anyOf(Color, Gradient)

Default color.

Default value: "#4682b4"

Note:

  • This property cannot be used in a style config.
  • The fill and stroke properties have higher precedence than color and will override color.
cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cornerRadiusBottomLeft : float

The radius in pixels of rounded rectangle bottom left corner.

Default value: 0

cornerRadiusBottomRight : float

The radius in pixels of rounded rectangle bottom right corner.

Default value: 0

cornerRadiusTopLeft : float

The radius in pixels of rounded rectangle top right corner.

Default value: 0

cornerRadiusTopRight : float

The radius in pixels of rounded rectangle top left corner.

Default value: 0

cursor : Cursor

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

dir : TextDirection

The direction of the text. One of "ltr" (left-to-right) or "rtl" (right-to-left). This property determines on which side is truncated in response to the limit parameter.

Default value: "ltr"

dx : float

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy : float

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

ellipsis : string

The ellipsis string for text truncated in response to the limit parameter.

Default value: "…"

fill : anyOf(Color, Gradient, None)

Default Fill Color. This property has higher precedence than config.color.

Default value: (None)

fillOpacity : float

The fill opacity (value between [0,1]).

Default value: 1

filled : boolean

Whether the mark’s color should be used as fill color instead of stroke color.

Default value: false for all point, line, and rule marks as well as geoshape marks for graticule data sources; otherwise, true.

Note: This property cannot be used in a style config.

font : string

The typeface to set the text in (e.g., "Helvetica Neue" ).

fontSize : float

The font size, in pixels.

Default value: 11

fontStyle : FontStyle

The font style (e.g., "italic" ).

fontWeight : FontWeight

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

height : float

Height of the marks.

href : string

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

interpolate : Interpolate

The line interpolation method to use for line and area marks. One of the following:

  • "linear" : piecewise linear segments, as in a polyline.
  • "linear-closed" : close the linear segments to form a polygon.
  • "step" : alternate between horizontal and vertical segments, as in a step function.
  • "step-before" : alternate between vertical and horizontal segments, as in a step function.
  • "step-after" : alternate between horizontal and vertical segments, as in a step function.
  • "basis" : a B-spline, with control point duplication on the ends.
  • "basis-open" : an open B-spline; may not intersect the start or end.
  • "basis-closed" : a closed B-spline, as in a loop.
  • "cardinal" : a Cardinal spline, with control point duplication on the ends.
  • "cardinal-open" : an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
  • "cardinal-closed" : a closed Cardinal spline, as in a loop.
  • "bundle" : equivalent to basis, except the tension parameter is used to straighten the spline.
  • "monotone" : cubic interpolation that preserves monotonicity in y.
invalid : enum(‘filter’, None)

Defines how Vega-Lite should handle marks for invalid values ( null and NaN ).

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
limit : float

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

Default value: 0 – indicating no limit

lineBreak : string

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property is ignored if the text is array-valued.

lineHeight : float

The line height in pixels (the spacing between subsequent lines of text) for multi-line text marks.

opacity : float

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

order : anyOf(None, boolean)

For line and trail marks, this order property can be set to null or false to make the lines use the original order in the data sources.

orient : Orientation

The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical.

  • For bar, rule and tick, this determines whether the size of the bar and tick

should be applied to x or y dimension. * For area, this property determines the orient property of the Vega output. * For line and trail marks, this property determines the sort order of the points in

the line

if config.sortLineBy is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.

radius : float

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

shape : anyOf(SymbolShape, string)

Shape of the point marks. Supported values include:

  • plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".
  • the line symbol "stroke"
  • centered directional shapes "arrow", "wedge", or "triangle"
  • a custom SVG path string (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)

Default value: "circle"

size : float

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.
  • For bar, this represents the band size of the bar, in pixels.
  • For text, this represents the font size, in pixels.

Default value:

  • 30 for point, circle, square marks; width/height’s step
  • 2 for bar marks with discrete dimensions;
  • 5 for bar marks with continuous dimensions;
  • 11 for text marks.
stroke : anyOf(Color, Gradient, None)

Default Stroke Color. This property has higher precedence than config.color.

Default value: (None)

strokeCap : string

The stroke cap for line ending style. One of "butt", "round", or "square".

Default value: "butt"

strokeDash : List(float)

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset : float

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeJoin : string

The stroke line join method. One of "miter", "round" or "bevel".

Default value: "miter"

strokeMiterLimit : float

The miter limit at which to bevel a line join.

strokeOffset : float

The offset in pixels at which to draw the group stroke and fill. If unspecified, the default behavior is to dynamically offset stroked groups such that 1 pixel stroke widths align with the pixel grid.

strokeOpacity : float

The stroke opacity (value between [0,1]).

Default value: 1

strokeWidth : float

The stroke width, in pixels.

tension : float

Depending on the interpolation type, sets the tension parameter (for line and area marks).

text : Text

Placeholder text if the text channel is not specified

theta : float

Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating “north”.

timeUnitBand : float

Default relative band size for a time unit. If set to 1, the bandwidth of the marks will be equal to the time unit band step. If set to 0.5, bandwidth of the marks will be half of the time unit band step.

timeUnitBandPosition : float

Default relative band position for a time unit. If set to 0, the marks will be positioned at the beginning of the time unit band step. If set to 0.5, the marks will be positioned in the middle of the time unit band step.

tooltip : anyOf(float, string, boolean, TooltipContent, None)

The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.

  • If tooltip is true or {"content": "encoding"}, then all fields from encoding will be used.
  • If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used.
  • If set to null or false, then no tooltip will be used.

See the tooltip documentation for a detailed discussion about tooltip in Vega-Lite.

Default value: null

width : float

Width of the marks.

x : anyOf(float, enum(‘width’))

X coordinates of the marks, or width of horizontal "bar" and "area" without specified x2 or width.

The value of this channel can be a number or a string "width" for the width of the plot.

x2 : anyOf(float, enum(‘width’))

X2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "width" for the width of the plot.

y : anyOf(float, enum(‘height’))

Y coordinates of the marks, or height of vertical "bar" and "area" without specified y2 or height.

The value of this channel can be a number or a string "height" for the height of the plot.

y2 : anyOf(float, enum(‘height’))

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

The value of this channel can be a number or a string "height" for the height of the plot.

configure_header(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:
format : anyOf(string, Mapping(required=[]))

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

See the format documentation for more examples.

When used with a custom “formatType” that takes datum.value and format parameter as input), this property represents the format parameter.

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

formatType : string

The format type for labels ( "number" or "time" or a registered custom format type ).

Default value:

  • "time" for temporal fields and ordinal and nomimal fields with timeUnit.
  • "number" for quantitative fields as well as ordinal and nomimal fields without timeUnit.
labelAlign : Align

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

labelAnchor : TitleAnchor

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.

labelAngle : float

The rotation angle of the header labels.

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

labelBaseline : TextBaseline

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.

labelColor : Color

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

labelExpr : string

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.

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

labelFontStyle : FontStyle

The font style of the header label.

labelFontWeight : FontWeight

The font weight of the header label.

labelLimit : float

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

labelLineHeight : float

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

labelOrient : Orient

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

labelPadding : float

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

Default value: 10

labels : boolean

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

Default value: true.

orient : Orient

Shortcut for setting both labelOrient and titleOrient.

title : None

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

titleAlign : Align

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

titleAnchor : TitleAnchor

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.

titleAngle : float

The rotation angle of the header title.

Default value: 0.

titleBaseline : TextBaseline

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"

titleColor : Color

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

titleFont : string

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

titleFontSize : float

Font size of the header title.

titleFontStyle : FontStyle

The font style of the header title.

titleFontWeight : FontWeight

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 ).

titleLimit : float

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

titleLineHeight : float

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

titleOrient : Orient

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

titlePadding : float

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

Default value: 10

configure_headerColumn(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:
format : anyOf(string, Mapping(required=[]))

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

See the format documentation for more examples.

When used with a custom “formatType” that takes datum.value and format parameter as input), this property represents the format parameter.

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

formatType : string

The format type for labels ( "number" or "time" or a registered custom format type ).

Default value:

  • "time" for temporal fields and ordinal and nomimal fields with timeUnit.
  • "number" for quantitative fields as well as ordinal and nomimal fields without timeUnit.
labelAlign : Align

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

labelAnchor : TitleAnchor

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.

labelAngle : float

The rotation angle of the header labels.

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

labelBaseline : TextBaseline

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.

labelColor : Color

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

labelExpr : string

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.

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

labelFontStyle : FontStyle

The font style of the header label.

labelFontWeight : FontWeight

The font weight of the header label.

labelLimit : float

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

labelLineHeight : float

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

labelOrient : Orient

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

labelPadding : float

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

Default value: 10

labels : boolean

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

Default value: true.

orient : Orient

Shortcut for setting both labelOrient and titleOrient.

title : None

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

titleAlign : Align

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

titleAnchor : TitleAnchor

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.

titleAngle : float

The rotation angle of the header title.

Default value: 0.

titleBaseline : TextBaseline

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"

titleColor : Color

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

titleFont : string

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

titleFontSize : float

Font size of the header title.

titleFontStyle : FontStyle

The font style of the header title.

titleFontWeight : FontWeight

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 ).

titleLimit : float

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

titleLineHeight : float

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

titleOrient : Orient

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

titlePadding : float

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

Default value: 10

configure_headerFacet(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:
format : anyOf(string, Mapping(required=[]))

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

See the format documentation for more examples.

When used with a custom “formatType” that takes datum.value and format parameter as input), this property represents the format parameter.

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

formatType : string

The format type for labels ( "number" or "time" or a registered custom format type ).

Default value:

  • "time" for temporal fields and ordinal and nomimal fields with timeUnit.
  • "number" for quantitative fields as well as ordinal and nomimal fields without timeUnit.
labelAlign : Align

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

labelAnchor : TitleAnchor

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.

labelAngle : float

The rotation angle of the header labels.

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

labelBaseline : TextBaseline

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.

labelColor : Color

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

labelExpr : string

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.

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

labelFontStyle : FontStyle

The font style of the header label.

labelFontWeight : FontWeight

The font weight of the header label.

labelLimit : float

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

labelLineHeight : float

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

labelOrient : Orient

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

labelPadding : float

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

Default value: 10

labels : boolean

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

Default value: true.

orient : Orient

Shortcut for setting both labelOrient and titleOrient.

title : None

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

titleAlign : Align

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

titleAnchor : TitleAnchor

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.

titleAngle : float

The rotation angle of the header title.

Default value: 0.

titleBaseline : TextBaseline

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"

titleColor : Color

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

titleFont : string

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

titleFontSize : float

Font size of the header title.

titleFontStyle : FontStyle

The font style of the header title.

titleFontWeight : FontWeight

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 ).

titleLimit : float

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

titleLineHeight : float

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

titleOrient : Orient

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

titlePadding : float

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

Default value: 10

configure_headerRow(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:
format : anyOf(string, Mapping(required=[]))

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

See the format documentation for more examples.

When used with a custom “formatType” that takes datum.value and format parameter as input), this property represents the format parameter.

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

formatType : string

The format type for labels ( "number" or "time" or a registered cus