altair.HConcatChart

class altair.HConcatChart(data=Undefined, hconcat=(), **kwargs)

A chart with horizontally-concatenated facets Mapping(required=[hconcat])

Attributes:
hconcat : List(Spec)

A list of views to be concatenated and put into a row.

autosize : anyOf(AutosizeType, AutoSizeParams)

Sets 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. "fit" is only supported for single and layered views that don’t use rangeStep.

Default value : pad

background : string

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

Default value: none (transparent)

bounds : enum(‘full’, ‘flush’)

The bounds calculation method to use for determining the extent of a sub-plot. One of full (the default) or flush.

  • If set to full, the entire calculated bounds (including axes, title, and legend) will be used.
  • If set to flush, only the specified width and height values for the sub-view will be used. The flush setting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.

Default value: "full"

center : boolean

Boolean flag indicating if subviews should be centered relative to their respective rows or columns.

Default value: false

config : Config

Vega-Lite configuration object. This property can only be defined at the top-level of a specification.

data : Data

An object describing the data source

datasets : Datasets

A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a data property.

description : string

Description of this mark for commenting purpose.

name : string

Name of the visualization for later reference.

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

resolve : Resolve

Scale, axis, and legend resolutions for view composition specifications.

spacing : float

The spacing in pixels between sub-views of the concat operator.

Default value : 10

title : anyOf(string, TitleParams)

Title for the plot.

transform : List(Transform)

An array of data transformations such as filter and new field calculation.

usermeta : Mapping(required=[])

Optional metadata that will be passed to Vega. This object is completely ignored by Vega and Vega-Lite and can be used for custom metadata.

$schema : string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use https://vega.github.io/schema/vega-lite/v3.json. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

__init__(data=Undefined, hconcat=(), **kwargs)

Methods

__init__([data, hconcat])
add_selection(*selections) Add one or more selections to the chart.
configure([area, autosize, axis, axisBand, …]) Config schema wrapper
configure_area([align, angle, baseline, …]) AreaConfig schema wrapper
configure_axis([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisBand([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisBottom([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisLeft([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisRight([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisTop([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisX([bandPosition, domain, …]) AxisConfig schema wrapper
configure_axisY([bandPosition, domain, …]) AxisConfig schema wrapper
configure_bar([align, angle, baseline, …]) BarConfig schema wrapper
configure_boxplot([box, extent, median, …]) BoxPlotConfig schema wrapper
configure_circle([align, angle, baseline, …]) 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, baseline, …]) 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_legend([clipHeight, …]) LegendConfig schema wrapper
configure_line([align, angle, baseline, …]) LineConfig schema wrapper
configure_mark([align, angle, baseline, …]) MarkConfig schema wrapper
configure_point([align, angle, baseline, …]) MarkConfig schema wrapper
configure_projection([center, clipAngle, …]) ProjectionConfig schema wrapper
configure_range([category, diverging, …]) RangeConfig schema wrapper
configure_rect([align, angle, baseline, …]) MarkConfig schema wrapper
configure_repeat([columns, spacing]) CompositionConfig schema wrapper
configure_rule([align, angle, baseline, …]) MarkConfig schema wrapper
configure_scale([bandPaddingInner, …]) ScaleConfig schema wrapper
configure_selection([interval, multi, single]) SelectionConfig schema wrapper
configure_square([align, angle, baseline, …]) MarkConfig schema wrapper
configure_text([align, angle, baseline, …]) TextConfig schema wrapper
configure_tick([align, angle, bandSize, …]) TickConfig schema wrapper
configure_title([align, anchor, angle, …]) TitleConfig schema wrapper
configure_trail([align, angle, baseline, …]) LineConfig schema wrapper
configure_view([clip, cornerRadius, fill, …]) ViewConfig schema wrapper
copy([deep, ignore]) Return a copy of the object
display([renderer, theme, actions]) Display chart in Jupyter notebook or JupyterLab
from_dict(dct[, validate, _wrapper_classes]) Construct class from a dictionary representation
from_json(json_string[, validate]) Instantiate the object from a valid JSON string
project([type, center, clipAngle, …]) Add a geographic projection to the chartself.
properties(**kwargs) Set top-level properties of the Chart.
repeat([row, column]) Return a RepeatChart built from the chart
resolve_axis([x, y]) AxisResolveMap schema wrapper
resolve_legend([color, fill, fillOpacity, …]) LegendResolveMap schema wrapper
resolve_references([schema]) Resolve references in the context of this object’s schema or root schema.
resolve_scale([color, fill, fillOpacity, …]) ScaleResolveMap schema wrapper
save(fp[, format, …]) Save a chart to file in a variety of formats
savechart(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
to_dict(*args, **kwargs) Convert the chart to a dictionary suitable for JSON export
to_html([base_url, output_div, …])
to_json([validate, ignore, context, indent, …]) Emit the JSON representation for this object as a string.
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_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 schema.
transform_impute(impute, key[, frame, …]) Add an ImputeTransform to the schema.
transform_joinaggregate([joinaggregate, groupby]) Add a JoinAggregateTransform to the schema.
transform_lookup([as_, from_, lookup, default]) Add a LookupTransform to the schema
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
validate(instance[, schema]) Validate the instance against the class schema in the context of the rootschema.
validate_property(name, value[, schema]) Validate a property against property schema in the context of the
add_selection(*selections)

Add one or more selections to the chart.

configure(area=Undefined, autosize=Undefined, axis=Undefined, axisBand=Undefined, axisBottom=Undefined, axisLeft=Undefined, axisRight=Undefined, axisTop=Undefined, axisX=Undefined, axisY=Undefined, background=Undefined, bar=Undefined, boxplot=Undefined, circle=Undefined, concat=Undefined, countTitle=Undefined, errorband=Undefined, errorbar=Undefined, facet=Undefined, fieldTitle=Undefined, geoshape=Undefined, header=Undefined, headerColumn=Undefined, headerFacet=Undefined, headerRow=Undefined, invalidValues=Undefined, legend=Undefined, line=Undefined, mark=Undefined, numberFormat=Undefined, padding=Undefined, point=Undefined, projection=Undefined, range=Undefined, rect=Undefined, repeat=Undefined, rule=Undefined, scale=Undefined, selection=Undefined, square=Undefined, stack=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)

Sets 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. "fit" is only supported for single and layered views that don’t use rangeStep.

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

Specific axis config for axes with “band” scales.

axisBottom : AxisConfig

Specific axis config for x-axis along the bottom edge of the chart.

axisLeft : AxisConfig

Specific axis config for y-axis along the left edge of the chart.

axisRight : AxisConfig

Specific axis config for y-axis along the right edge of the chart.

axisTop : AxisConfig

Specific axis config for x-axis along the top edge of the chart.

axisX : AxisConfig

X-axis specific config.

axisY : AxisConfig

Y-axis specific config.

background : string

CSS color property to use as the background of the whole Vega-Lite view

Default value: none (transparent)

bar : BarConfig

Bar-Specific Config

boxplot : BoxPlotConfig

Box Config

circle : MarkConfig

Circle-Specific Config

concat : CompositionConfig

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

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”).
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.

invalidValues : enum(‘filter’, None)

Defines how Vega-Lite should handle 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.
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

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

Rect-Specific Config

repeat : CompositionConfig

Default configuration for the repeat view composition operator

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

stack : StackOffset

Default stack offset for stackable mark.

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

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 format each label automatically so this config would 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, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=Undefined, line=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

AreaConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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.

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_axis(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisBand(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisBottom(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisLeft(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisRight(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisTop(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisX(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_axisY(bandPosition=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, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, orient=Undefined, shortTimeLabels=Undefined, tickColor=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, titleOpacity=Undefined, titlePadding=Undefined, titleX=Undefined, titleY=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

domain : boolean

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

Default value: true

domainColor : 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 : Color

Color of gridlines.

Default value: "lightGray".

gridDash : List(float)

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

gridDashOffset : float

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

gridOpacity : float

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

Default value: 1

gridWidth : float

The grid width, in pixels.

Default value: 1

labelAlign : Align

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

labelAngle : float

The rotation angle of the axis labels.

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

labelBaseline : TextBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be "top", "middle", "bottom", or "alphabetic".

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

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

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

The font of the tick label.

labelFontSize : float

The font size of the label, in pixels.

labelFontStyle : FontStyle

Font style of the title.

labelFontWeight : FontWeight

Font weight of axis tick labels.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 180

labelOpacity : float

The opacity of the labels.

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

The padding, in pixels, between axis and text labels.

Default value: 2

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.

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.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor : Color

The color of the axis’s tick.

Default value: "gray"

tickDash : List(float)

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

tickDashOffset : float

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

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

Opacity of the ticks.

tickRound : boolean

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

Default value: true

tickSize : float

The size in pixels of axis ticks.

Default value: 5

tickWidth : float

The width, in pixels, of ticks.

Default value: 1

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

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.

configure_bar(align=Undefined, angle=Undefined, baseline=Undefined, binSpacing=Undefined, color=Undefined, continuousBandSize=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

BarConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

binSpacing : float

Offset between bars for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

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

cursor : Cursor

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

dir : Dir

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 bandSize-1, which provides 1 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 : Color

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

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, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

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, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_header(format=Undefined, formatType=Undefined, labelAlign=Undefined, labelAnchor=Undefined, labelAngle=Undefined, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelLimit=Undefined, labelOrient=Undefined, labelPadding=Undefined, shortTimeLabels=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

HeaderConfig schema wrapper

Mapping(required=[])

Attributes:
format : string

The text formatting pattern for labels of guides (axes, legends, headers) and text marks.

See the format documentation for more examples.

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

formatType : enum(‘number’, ‘time’)

The format type for labels ( "number" or "time" ).

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.

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.

labelColor : string

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

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

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

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

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

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

Vertical text baseline for the header title. One of "top", "bottom", "middle".

Default value: "middle"

titleColor : string

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.

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

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, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelLimit=Undefined, labelOrient=Undefined, labelPadding=Undefined, shortTimeLabels=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

HeaderConfig schema wrapper

Mapping(required=[])

Attributes:
format : string

The text formatting pattern for labels of guides (axes, legends, headers) and text marks.

See the format documentation for more examples.

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

formatType : enum(‘number’, ‘time’)

The format type for labels ( "number" or "time" ).

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.

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.

labelColor : string

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

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

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

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

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

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

Vertical text baseline for the header title. One of "top", "bottom", "middle".

Default value: "middle"

titleColor : string

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.

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

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, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelLimit=Undefined, labelOrient=Undefined, labelPadding=Undefined, shortTimeLabels=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

HeaderConfig schema wrapper

Mapping(required=[])

Attributes:
format : string

The text formatting pattern for labels of guides (axes, legends, headers) and text marks.

See the format documentation for more examples.

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

formatType : enum(‘number’, ‘time’)

The format type for labels ( "number" or "time" ).

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.

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.

labelColor : string

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

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

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

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

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

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

Vertical text baseline for the header title. One of "top", "bottom", "middle".

Default value: "middle"

titleColor : string

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.

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

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, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelLimit=Undefined, labelOrient=Undefined, labelPadding=Undefined, shortTimeLabels=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

HeaderConfig schema wrapper

Mapping(required=[])

Attributes:
format : string

The text formatting pattern for labels of guides (axes, legends, headers) and text marks.

See the format documentation for more examples.

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

formatType : enum(‘number’, ‘time’)

The format type for labels ( "number" or "time" ).

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.

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.

labelColor : string

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

labelFont : string

The font of the header label.

labelFontSize : float

The font size of the header label, in pixels.

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

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

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

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

Vertical text baseline for the header title. One of "top", "bottom", "middle".

Default value: "middle"

titleColor : string

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.

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

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_legend(clipHeight=Undefined, columnPadding=Undefined, columns=Undefined, cornerRadius=Undefined, fillColor=Undefined, gradientDirection=Undefined, gradientHorizontalMaxLength=Undefined, gradientHorizontalMinLength=Undefined, gradientLabelLimit=Undefined, gradientLabelOffset=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, gradientVerticalMaxLength=Undefined, gradientVerticalMinLength=Undefined, gridAlign=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, layout=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, shortTimeLabels=Undefined, strokeColor=Undefined, strokeDash=Undefined, strokeWidth=Undefined, symbolBaseFillColor=Undefined, symbolBaseStrokeColor=Undefined, symbolDash=Undefined, symbolDashOffset=Undefined, symbolDirection=Undefined, symbolFillColor=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOpacity=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

LegendConfig schema wrapper

Mapping(required=[])

Attributes:
clipHeight : float

The height in pixels to clip symbol legend entries and limit their size.

columnPadding : float

The horizontal padding in pixels between symbol legend entries.

Default value: 10.

columns : float

The number of columns in which to arrange symbol legend entries. A value of 0 or lower indicates a single row with one column per entry.

cornerRadius : float

Corner radius for the full legend.

fillColor : Color

Background fill color for the full legend.

gradientDirection : Orientation

The default direction ( "horizontal" or "vertical" ) for gradient legends.

Default value: "vertical".

gradientHorizontalMaxLength : float

Max legend length for a horizontal gradient when config.legend.gradientLength is undefined.

Default value: 200

gradientHorizontalMinLength : float

Min legend length for a horizontal gradient when config.legend.gradientLength is undefined.

Default value: 100

gradientLabelLimit : float

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset : float

Vertical offset in pixels for color ramp gradient labels.

Default value: 2.

gradientLength : float

The length in pixels of the primary axis of a color gradient. This value corresponds to the height of a vertical gradient or the width of a horizontal gradient.

Default value: 200.

gradientOpacity : float

Opacity of the color gradient.

gradientStrokeColor : Color

The color of the gradient stroke, can be in hex color code or regular color name.

Default value: "lightGray".

gradientStrokeWidth : float

The width of the gradient stroke, in pixels.

Default value: 0.

gradientThickness : float

The thickness in pixels of the color gradient. This value corresponds to the width of a vertical gradient or the height of a horizontal gradient.

Default value: 16.

gradientVerticalMaxLength : float

Max legend length for a vertical gradient when config.legend.gradientLength is undefined.

Default value: 200

gradientVerticalMinLength : float

Min legend length for a vertical gradient when config.legend.gradientLength is undefined.

Default value: 100

gridAlign : LayoutAlign

The alignment to apply to symbol legends rows and columns. The supported string values are "all", "each" (the default), and none. For more information, see the grid layout documentation.

Default value: "each".

labelAlign : Align

The alignment of the legend label, can be left, center, or right.

labelBaseline : TextBaseline

The position of the baseline of legend label, can be "top", "middle", "bottom", or "alphabetic".

Default value: "middle".

labelColor : Color

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

labelFont : string

The font of the legend label.

labelFontSize : float

The font size of legend label.

Default value: 10.

labelFontStyle : FontStyle

The font style of legend label.

labelFontWeight : FontWeight

The font weight of legend label.

labelLimit : float

Maximum allowed pixel width of axis tick labels.

Default value: 160.

labelOffset : float

The offset of the legend label.

labelOpacity : float

Opacity of labels.

labelOverlap : LabelOverlap

The strategy to use for resolving overlap of labels in gradient legends. If false, no overlap reduction is attempted. If set to true or "parity", a strategy of removing every other label is used. If set to "greedy", a linear scan of the labels is performed, removing any label that overlaps with the last visible label (this often works better for log-scaled axes).

Default value: "greedy" for log scales otherwise true`. *

labelPadding : float

Padding in pixels between the legend and legend labels.

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.

layout : LegendLayout

Legend orient group layout parameters.

offset : float

The offset in pixels by which to displace the legend from the data rectangle and axes.

Default value: 18.

orient : LegendOrient

The orientation of the legend, which determines how the legend is positioned within the scene. One of “left”, “right”, “top-left”, “top-right”, “bottom-left”, “bottom-right”, “none”.

Default value: "right"

padding : float

The padding between the border and content of the legend group.

Default value: 0.

rowPadding : float

The vertical padding in pixels between symbol legend entries.

Default value: 2.

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor : Color

Border stroke color for the full legend.

strokeDash : List(float)

Border stroke dash pattern for the full legend.

strokeWidth : float

Border stroke width for the full legend.

symbolBaseFillColor : Color

Default fill color for legend symbols. Only applied if there is no "fill" scale color encoding for the legend.

Default value: "transparent".

symbolBaseStrokeColor : Color

Default stroke color for legend symbols. Only applied if there is no "fill" scale color encoding for the legend.

Default value: "gray".

symbolDash : List(float)

An array of alternating [stroke, space] lengths for dashed symbol strokes.

symbolDashOffset : float

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

symbolDirection : Orientation

The default direction ( "horizontal" or "vertical" ) for symbol legends.

Default value: "vertical".

symbolFillColor : Color

The color of the legend symbol,

symbolOffset : float

Horizontal pixel offset for legend symbols.

Default value: 0.

symbolOpacity : float

Opacity of the legend symbols.

symbolSize : float

The size of the legend symbol, in pixels.

Default value: 100.

symbolStrokeColor : Color

Stroke color for legend symbols.

symbolStrokeWidth : float

The width of the symbol’s stroke.

Default value: 1.5.

symbolType : SymbolShape

Default shape type (such as “circle”) for legend symbols. Can be one of `"circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left".

  • In addition to a set of built-in shapes, custom shapes can be defined using SVG path strings.
  • Default value: "circle".
title : None

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

titleAlign : Align

Horizontal text alignment for legend titles.

Default value: "left".

titleAnchor : TitleAnchor

Text anchor position for placing legend titles.

titleBaseline : TextBaseline

Vertical text baseline for legend titles.

Default value: "top".

titleColor : Color

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

titleFont : string

The font of the legend title.

titleFontSize : float

The font size of the legend title.

titleFontStyle : FontStyle

The font style of the legend title.

titleFontWeight : FontWeight

The font weight of the legend 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.

Default value: 180.

titleOpacity : float

Opacity of the legend title.

titleOrient : Orient

Orientation of the legend title.

titlePadding : float

The padding, in pixels, between title and legend.

Default value: 5.

configure_line(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

LineConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_mark(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_point(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_projection(center=Undefined, clipAngle=Undefined, clipExtent=Undefined, coefficient=Undefined, distance=Undefined, fraction=Undefined, lobes=Undefined, parallel=Undefined, precision=Undefined, radius=Undefined, ratio=Undefined, reflectX=Undefined, reflectY=Undefined, rotate=Undefined, scale=Undefined, spacing=Undefined, tilt=Undefined, translate=Undefined, type=Undefined, **kwds)

ProjectionConfig schema wrapper

Mapping(required=[])

Attributes:
center : List(float)

Sets the projection’s center to the specified center, a two-element array of longitude and latitude in degrees.

Default value: [0, 0]

clipAngle : float

Sets the projection’s clipping circle radius to the specified angle in degrees. If null, switches to antimeridian cutting rather than small-circle clipping.

clipExtent : List(List(float))

Sets the projection’s viewport clip extent to the specified bounds in pixels. The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left-side of the viewport, y0 is the top, x1 is the right and y1 is the bottom. If null, no viewport clipping is performed.

coefficient : float
distance : float
fraction : float
lobes : float
parallel : float
precision : string

Sets the threshold for the projection’s adaptive resampling to the specified value in pixels. This value corresponds to the Douglas–Peucker distance. If precision is not specified, returns the projection’s current resampling precision which defaults to √0.5 0.70710….

radius : float
ratio : float
reflectX : boolean
reflectY : boolean
rotate : List(float)

Sets the projection’s three-axis rotation to the specified angles, which must be a two- or three-element array of numbers [ lambda, phi, gamma ] specifying the rotation angles in degrees about each spherical axis. (These correspond to yaw, pitch and roll.)

Default value: [0, 0, 0]

scale : float

Sets the projection’s scale (zoom) value, overriding automatic fitting.

spacing : float
tilt : float
translate : List(float)

Sets the projection’s translation (pan) value, overriding automatic fitting.

type : ProjectionType

The cartographic projection to use. This value is case-insensitive, for example "albers" and "Albers" indicate the same projection type. You can find all valid projection types in the documentation.

Default value: mercator

configure_range(category=Undefined, diverging=Undefined, heatmap=Undefined, ordinal=Undefined, ramp=Undefined, symbol=Undefined, **kwds)

RangeConfig schema wrapper

Mapping(required=[])

Attributes:
category : anyOf(List(string), SchemeConfig)

Default range for nominal (categorical) fields.

diverging : anyOf(List(string), SchemeConfig)

Default range for diverging quantitative fields.

heatmap : anyOf(List(string), SchemeConfig)

Default range for quantitative heatmaps.

ordinal : anyOf(List(string), SchemeConfig)

Default range for ordinal fields.

ramp : anyOf(List(string), SchemeConfig)

Default range for quantitative and temporal fields.

symbol : List(string)

Default range palette for the shape channel.

configure_rect(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_repeat(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_rule(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_scale(bandPaddingInner=Undefined, bandPaddingOuter=Undefined, barBandPaddingInner=Undefined, barBandPaddingOuter=Undefined, clamp=Undefined, continuousPadding=Undefined, maxBandSize=Undefined, maxFontSize=Undefined, maxOpacity=Undefined, maxSize=Undefined, maxStrokeWidth=Undefined, minBandSize=Undefined, minFontSize=Undefined, minOpacity=Undefined, minSize=Undefined, minStrokeWidth=Undefined, pointPadding=Undefined, quantileCount=Undefined, quantizeCount=Undefined, rangeStep=Undefined, rectBandPaddingInner=Undefined, rectBandPaddingOuter=Undefined, round=Undefined, textXRangeStep=Undefined, useUnaggregatedDomain=Undefined, **kwds)

ScaleConfig schema wrapper

Mapping(required=[])

Attributes:
bandPaddingInner : float

Default inner padding for x and y band-ordinal scales.

Default value:

  • barBandPaddingInner for bar marks ( 0.1 by default)
  • rectBandPaddingInner for rect and other marks ( 0 by default)
bandPaddingOuter : float

Default outer padding for x and y band-ordinal scales.

If not specified, by default, band scale’s paddingOuter is paddingInner/2.

barBandPaddingInner : float

Default inner padding for x and y band-ordinal scales of "bar" marks.

Default value: 0.1

barBandPaddingOuter : float

Default outer padding for x and y band-ordinal scales of "bar" marks. If not specified, by default, band scale’s paddingOuter is paddingInner/2.

clamp : boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding : float

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

maxBandSize : float

The default max value for mapping quantitative fields to bar’s size/bandSize.

If undefined (default), we will use the scale’s rangeStep - 1.

maxFontSize : float

The default max value for mapping quantitative fields to text’s size/fontSize.

Default value: 40

maxOpacity : float

Default max opacity for mapping a field to opacity.

Default value: 0.8

maxSize : float

Default max value for point size scale.

maxStrokeWidth : float

Default max strokeWidth for the scale of strokeWidth for rule and line marks and of size for trail marks.

Default value: 4

minBandSize : float

The default min value for mapping quantitative fields to bar and tick’s size/bandSize scale with zero=false.

Default value: 2

minFontSize : float

The default min value for mapping quantitative fields to tick’s size/fontSize scale with zero=false

Default value: 8

minOpacity : float

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

minSize : float

Default minimum value for point size scale with zero=false.

Default value: 9

minStrokeWidth : float

Default minimum strokeWidth for the scale of strokeWidth for rule and line marks and of size for trail marks with zero=false.

Default value: 1

pointPadding : float

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

quantileCount : float

Default range cardinality for quantile scale.

Default value: 4

quantizeCount : float

Default range cardinality for quantize scale.

Default value: 4

rangeStep : anyOf(float, None)

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 20

rectBandPaddingInner : float

Default inner padding for x and y band-ordinal scales of "rect" marks.

Default value: 0

rectBandPaddingOuter : float

Default outer padding for x and y band-ordinal scales of "rect" marks. If not specified, by default, band scale’s paddingOuter is paddingInner/2.

round : boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep : float

Default range step for x band and point scales of text marks.

Default value: 90

useUnaggregatedDomain : boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ( "mean", "average", "median", "q1", "q3", "min", "max" ). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum" ), this property is ignored.

Default value: false

configure_selection(interval=Undefined, multi=Undefined, single=Undefined, **kwds)

SelectionConfig schema wrapper

Mapping(required=[])

Attributes:
interval : IntervalSelectionConfig

The default definition for an interval selection. All properties and transformations for an interval selection definition (except type ) may be specified here.

For instance, setting interval to {"translate": false} disables the ability to move interval selections by default.

multi : MultiSelectionConfig

The default definition for a multi selection. All properties and transformations for a multi selection definition (except type ) may be specified here.

For instance, setting multi to {"toggle": "event.altKey"} adds additional values to multi selections when clicking with the alt-key pressed by default.

single : SingleSelectionConfig

The default definition for a single selection. All properties and transformations for a single selection definition (except type ) may be specified here.

For instance, setting single to {"on": "dblclick"} populates single selections on double-click by default.

configure_square(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

MarkConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_text(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, radius=Undefined, shape=Undefined, shortTimeLabels=Undefined, size=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

TextConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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

shortTimeLabels : boolean

Whether month names and weekday names should be abbreviated.

size : float

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_tick(align=Undefined, angle=Undefined, bandSize=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, thickness=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

TickConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

bandSize : float

The width of the ticks.

Default value: 3/4 of rangeStep.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

thickness : float

Thickness of the tick mark.

Default value: 1

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_title(align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, limit=Undefined, offset=Undefined, orient=Undefined, **kwds)

TitleConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align
anchor : 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.

angle : float

Angle in degrees of title text.

baseline : TextBaseline

Vertical text baseline for title text. One of "top", "middle", "bottom", or "alphabetic".

color : Color

Text color for title text.

dx : float

Delta offset for title text x-coordinate.

dy : float

Delta offset for title text y-coordinate.

font : string

Font name for title text.

fontSize : float

Font size in pixels for title text.

Default value: 10.

fontStyle : FontStyle

Font style for title text.

fontWeight : FontWeight

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

frame : TitleFrame

The reference frame for the anchor position, one of "bounds" (to anchor relative to the full bounding box) or "group" (to anchor relative to the group width or height).

limit : float

The maximum allowed length in pixels of legend labels.

offset : float

The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.

orient : TitleOrient

Default title orientation ( "top", "bottom", "left", or "right" )

configure_trail(align=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, cornerRadius=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, href=Undefined, interpolate=Undefined, limit=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, strokeOpacity=Undefined, strokeWidth=Undefined, tension=Undefined, text=Undefined, theta=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, y=Undefined, y2=Undefined, **kwds)

LineConfig schema wrapper

Mapping(required=[])

Attributes:
align : Align

The horizontal alignment of the text. One of "left", "right", "center".

angle : float

The rotation angle of the text, in degrees.

baseline : TextBaseline

The vertical alignment of the text. One of "top", "middle", "bottom".

Default value: "middle"

color : string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: "#4682b4"

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

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

cursor : Cursor

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

dir : Dir

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

Default Fill Color. This 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 point, line and rule ; 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.

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 ).

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.
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

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 : 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. For example: in the case of circles, the radius is determined in part by the square root of the size 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; rangeStep - 1 for bar marks with discrete dimensions; 5 for bar marks with continuous dimensions; 11 for text marks.

stroke : Color

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

Default value: (None)

strokeCap : StrokeCap

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

Default value: "square"

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

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.

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

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”.

tooltip : anyOf(string, 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 {"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, then no tooltip will be used.
x : float

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

x2 : float

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

y : float

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

y2 : float

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

configure_view(clip=Undefined, cornerRadius=Undefined, fill=Undefined, fillOpacity=Undefined, height=Undefined, opacity=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, width=Undefined, **kwds)

ViewConfig schema wrapper

Mapping(required=[])

Attributes:
clip : boolean

Whether the view should be clipped.

cornerRadius : float

The radius in pixels of rounded rectangle corners.

Default value: 0

fill : anyOf(string, None)

The fill color.

Default value: undefined

fillOpacity : float

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

Default value: 1

height : float

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

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.

stroke : anyOf(string, None)

The stroke color.

Default value: "#ddd"

strokeCap : StrokeCap

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

Default value: "square"

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

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.

strokeOpacity : float

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

Default value: 1

strokeWidth : float

The stroke width, in pixels.

width : float

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

copy(deep=True, ignore=())

Return a copy of the object

Parameters:
deep : boolean, optional

if True (default) then return a deep copy of all dict, list, and SchemaBase objects within the object structure

ignore : list, optional

A list of keys for which the contents should not be copied, but only stored by reference.

display(renderer=Undefined, theme=Undefined, actions=Undefined, **kwargs)

Display chart in Jupyter notebook or JupyterLab

Parameters are passed as options to vega-embed within supported frontends. See https://github.com/vega/vega-embed#options for details.

Parameters:
renderer : string (‘canvas’ or ‘svg’)

The renderer to use

theme : string

The Vega theme name to use; see https://github.com/vega/vega-themes

actions : bool or dict

Specify whether action links (“Open In Vega Editor”, etc.) are included in the view.

**kwargs :

Additional parameters are also passed to vega-embed as options.

from_dict(dct, validate=True, _wrapper_classes=None)

Construct class from a dictionary representation

Parameters:
dct : dictionary

The dict from which to construct the class

validate : boolean

If True (default), then validate the input against the schema.

_wrapper_classes : list (optional)

The set of SchemaBase classes to use when constructing wrappers of the dict inputs. If not specified, the result of cls._default_wrapper_classes will be used.

Returns:
obj : Schema object

The wrapped schema

Raises:
jsonschema.ValidationError :

if validate=True and dct does not conform to the schema

from_json(json_string, validate=True, **kwargs)

Instantiate the object from a valid JSON string

Parameters:
json_string : string

The string containing a valid JSON chart specification.

validate : boolean

If True (default), then validate the input against the schema.

**kwargs :

Additional keyword arguments are passed to json.loads

Returns:
chart : Chart object

The altair Chart object built from the specification.

project(type='mercator', center=Undefined, clipAngle=Undefined, clipExtent=Undefined, coefficient=Undefined, distance=Undefined, fraction=Undefined, lobes=Undefined, parallel=Undefined, precision=Undefined, radius=Undefined, ratio=Undefined, rotate=Undefined, spacing=Undefined, tilt=Undefined, **kwds)

Add a geographic projection to the chartself.

This is generally used either with mark_geoshape or with the latitude/longitude encodings.

Available projection types are [‘albers’, ‘albersUsa’, ‘azimuthalEqualArea’, ‘azimuthalEquidistant’, ‘conicConformal’, ‘conicEqualArea’, ‘conicEquidistant’, ‘equirectangular’, ‘gnomonic’, ‘mercator’, ‘orthographic’, ‘stereographic’, ‘transverseMercator’]

Attributes:
type : ProjectionType

The cartographic projection to use. This value is case-insensitive, for example “albers” and “Albers” indicate the same projection type. You can find all valid projection types [in the documentation](https://vega.github.io/vega-lite/docs/projection.html#projection-types).

Default value: mercator

center : List(float)

Sets the projection’s center to the specified center, a two-element array of longitude and latitude in degrees.

Default value: [0, 0]

clipAngle : float

Sets the projection’s clipping circle radius to the specified angle in degrees. If null, switches to [antimeridian](http://bl.ocks.org/mbostock/3788999) cutting rather than small-circle clipping.

clipExtent : List(List(float))

Sets the projection’s viewport clip extent to the specified bounds in pixels. The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left-side of the viewport, y0 is the top, x1 is the right and y1 is the bottom. If null, no viewport clipping is performed.

coefficient : float
distance : float
fraction : float
lobes : float
parallel : float
precision : Mapping(required=[length])

Sets the threshold for the projection’s [adaptive resampling](http://bl.ocks.org/mbostock/3795544) to the specified value in pixels. This value corresponds to the [Douglas–Peucker distance](http://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm).

If precision is not specified, returns the projection’s current resampling

precision which defaults to √0.5 ≅ 0.70710….

radius : float
ratio : float
rotate : List(float)

Sets the projection’s three-axis rotation to the specified angles, which must be a two- or three-element array of numbers [lambda, phi, gamma] specifying the rotation angles in degrees about each spherical axis. (These correspond to yaw, pitch and roll.)

Default value: [0, 0, 0]

spacing : float
tilt : float
properties(**kwargs)

Set top-level properties of the Chart.

Argument names and types are the same as class initialization.

repeat(row=Undefined, column=Undefined, **kwargs)

Return a RepeatChart built from the chart

Fields within the chart can be set to correspond to the row or column using alt.repeat(‘row’) and alt.repeat(‘column’).

Parameters:
row : list

a list of data column names to be mapped to the row facet

column : list

a list of data column names to be mapped to the column facet

Returns:
chart : RepeatChart

a repeated chart.

resolve_axis(x=Undefined, y=Undefined, **kwds)

AxisResolveMap schema wrapper

Mapping(required=[])

Attributes:
x : ResolveMode
y : ResolveMode
resolve_legend(color=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, **kwds)

LegendResolveMap schema wrapper

Mapping(required=[])

Attributes:
color : ResolveMode
fill : ResolveMode
fillOpacity : ResolveMode
opacity : ResolveMode
shape : ResolveMode
size : ResolveMode
stroke : ResolveMode
strokeOpacity : ResolveMode
strokeWidth : ResolveMode
resolve_references(schema=None)

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

resolve_scale(color=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, x=Undefined, y=Undefined, **kwds)

ScaleResolveMap schema wrapper

Mapping(required=[])

Attributes:
color : ResolveMode
fill : ResolveMode
fillOpacity : ResolveMode
opacity : ResolveMode
shape : ResolveMode
size : ResolveMode
stroke : ResolveMode
strokeOpacity : ResolveMode
strokeWidth : ResolveMode
x : ResolveMode
y : ResolveMode
save(fp, format=None, override_data_transformer=True, scale_factor=1.0, vegalite_version='3.2.1', vega_version='4', vegaembed_version='3', **kwargs)

Save a chart to file in a variety of formats

Supported formats are json, html, png, svg

Parameters:
fp : string filename or file-like object

file in which to write the chart.

format : string (optional)

the format to write: one of [‘json’, ‘html’, ‘png’, ‘svg’]. If not specified, the format will be determined from the filename.

override_data_transformer : boolean (optional)

If True (default), then the save action will be done with the default data_transformer with max_rows set to None. If False, then use the currently active data transformer.

scale_factor : float

For svg or png formats, scale the image by this factor when saving. This can be used to control the size or resolution of the output. Default is 1.0

**kwargs :

Additional keyword arguments are passed to the output method associated with the specified format.

savechart(fp, format=None, **kwargs)

Save a chart to file in a variety of formats

Supported formats are json, html, png, svg

Parameters:
fp : string filename or file-like object

file in which to write the chart.

format : string (optional)

the format to write: one of [‘json’, ‘html’, ‘png’, ‘svg’]. If not specified, the format will be determined from the filename.

**kwargs :

Additional keyword arguments are passed to the output method associated with the specified format.

serve(ip='127.0.0.1', port=8888, n_retries=50, files=None, jupyter_warning=True, open_browser=True, http_server=None, **kwargs)

Open a browser window and display a rendering of the chart

Parameters:
html : string

HTML to serve

ip : string (default = ‘127.0.0.1’)

ip address at which the HTML will be served.

port : int (default = 8888)

the port at which to serve the HTML

n_retries : int (default = 50)

the number of nearby ports to search if the specified port is already in use.

files : dictionary (optional)

dictionary of extra content to serve

jupyter_warning : bool (optional)

if True (default), then print a warning if this is used within the Jupyter notebook

open_browser : bool (optional)

if True (default), then open a web browser to the given HTML

http_server : class (optional)

optionally specify an HTTPServer class to use for showing the figure. The default is Python’s basic HTTPServer.

**kwargs :

additional keyword arguments passed to the save() method

to_dict(*args, **kwargs)

Convert the chart to a dictionary suitable for JSON export

to_json(validate=True, ignore=[], context={}, indent=2, sort_keys=True, **kwargs)

Emit the JSON representation for this object as a string.

Parameters:
validate : boolean or string

If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.

ignore : list

A list of keys to ignore. This will not passed to child to_dict function calls.

context : dict (optional)

A context dictionary that will be passed to all child to_dict function calls

indent : integer, default 2

the number of spaces of indentation to use

sort_keys : boolean, default True

if True, sort keys in the output

**kwargs

Additional keyword arguments are passed to json.dumps()

Returns:
spec : string

The JSON specification of the chart object.

transform_aggregate(aggregate=Undefined, groupby=Undefined, **kwds)

Add an AggregateTransform to the schema.

Parameters:
aggregate : List(AggregatedFieldDef)

Array of objects that define fields to aggregate.

groupby : List(string)

The data fields to group by. If not specified, a single group containing all data objects will be used.

**kwds :

additional keywords are converted to aggregates using standard shorthand parsing.

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.AggregateTransform
underlying transform object

Examples

The aggregate transform allows you to specify transforms directly using the same shorthand syntax as used in encodings:

>>> import altair as alt
>>> chart1 = alt.Chart().transform_aggregate(
...     mean_acc='mean(Acceleration)',
...     groupby=['Origin']
... )
>>> print(chart1.transform[0].to_json())  
{
  "aggregate": [
    {
      "as": "mean_acc",
      "field": "Acceleration",
      "op": "mean"
    }
  ],
  "groupby": [
    "Origin"
  ]
}

It also supports including AggregatedFieldDef instances or dicts directly, so you can create the above transform like this:

>>> chart2 = alt.Chart().transform_aggregate(
...     [alt.AggregatedFieldDef(field='Acceleration', op='mean',
...                             **{'as': 'mean_acc'})],
...     groupby=['Origin']
... )
>>> chart2.transform == chart1.transform
True
transform_bin(as_=Undefined, field=Undefined, bin=True, **kwargs)

Add a BinTransform to the schema.

Parameters:
as_ : anyOf(string, List(string))

The output fields at which to write the start and end bin values.

bin : anyOf(boolean, BinParams)

An object indicating bin properties, or simply true for using default bin parameters.

field : string

The data field to bin.

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.BinTransform
underlying transform object

Examples

>>> import altair as alt
>>> chart = alt.Chart().transform_bin("x_binned", "x")
>>> chart.transform[0]
BinTransform({
  as: 'x_binned',
  bin: True,
  field: 'x'
})
>>> chart = alt.Chart().transform_bin("x_binned", "x",
...                                   bin=alt.Bin(maxbins=10))
>>> chart.transform[0]
BinTransform({
  as: 'x_binned',
  bin: BinParams({
    maxbins: 10
  }),
  field: 'x'
})
transform_calculate(as_=Undefined, calculate=Undefined, **kwargs)

Add a CalculateTransform to the schema.

Parameters:
as_ : string

The field for storing the computed formula value.

calculate : string or alt.expr expression

A expression string. Use the variable datum to refer to the current data object.

**kwargs

transforms can also be passed by keyword argument; see Examples

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.CalculateTransform
underlying transform object

Examples

>>> import altair as alt
>>> from altair import datum, expr
>>> chart = alt.Chart().transform_calculate(y = 2 * expr.sin(datum.x))
>>> chart.transform[0]
CalculateTransform({
  as: 'y',
  calculate: (2 * sin(datum.x))
})

It’s also possible to pass the CalculateTransform arguments directly:

>>> kwds = {'as': 'y', 'calculate': '2 * sin(datum.x)'}
>>> chart = alt.Chart().transform_calculate(**kwds)
>>> chart.transform[0]
CalculateTransform({
  as: 'y',
  calculate: '2 * sin(datum.x)'
})

As the first form is easier to write and understand, that is the recommended method.

transform_filter(filter, **kwargs)

Add a FilterTransform to the schema.

Parameters:
filter : a filter expression or LogicalOperandPredicate

The filter property must be one of the predicate definitions: (1) a string or alt.expr expression (2) a range predicate (3) a selection predicate (4) a logical operand combining (1)-(3) (5) a Selection object

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.FilterTransform
underlying transform object
transform_flatten(flatten, as_=Undefined)

Add a FlattenTransform to the schema.

Parameters:
flatten : List(string)

An array of one or more data fields containing arrays to flatten. If multiple fields are specified, their array values should have a parallel structure, ideally with the same length. If the lengths of parallel arrays do not match, the longest array will be used with null values added for missing entries.

as : List(string)

The output field names for extracted array values. Default value: The field name of the corresponding array field

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.FlattenTransform
underlying transform object
transform_fold(fold, as_=Undefined)

Add a FoldTransform to the schema.

Parameters:
fold : List(string)

An array of data fields indicating the properties to fold.

as : [string, string]

The output field names for the key and value properties produced by the fold transform. Default: ["key", "value"]

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.FoldTransform
underlying transform object
transform_impute(impute, key, frame=Undefined, groupby=Undefined, keyvals=Undefined, method=Undefined, value=Undefined)

Add an ImputeTransform to the schema.

Parameters:
impute : string

The data field for which the missing values should be imputed.

key : string

A key field that uniquely identifies data objects within a group. Missing key values (those occurring in the data but not in the current group) will be imputed.

frame : List(anyOf(None, float))

A frame specification as a two-element array used to control the window over which the specified method is applied. The array entries should either be a number indicating the offset from the current data object, or null to indicate unbounded rows preceding or following the current data object. For example, the value [-5, 5] indicates that the window should include five objects preceding and five objects following the current object. Default value: : [null, null] indicating that the window includes all objects.

groupby : List(string)

An optional array of fields by which to group the values. Imputation will then be performed on a per-group basis.

keyvals : anyOf(List(Mapping(required=[])), ImputeSequence)

Defines the key values that should be considered for imputation. An array of key values or an object defining a number sequence. If provided, this will be used in addition to the key values observed within the input data. If not provided, the values will be derived from all unique values of the key field. For impute in encoding, the key field is the x-field if the y-field is imputed, or vice versa. If there is no impute grouping, this property must be specified.

method : ImputeMethod

The imputation method to use for the field value of imputed data objects. One of value, mean, median, max or min. Default value: "value"

value : Mapping(required=[])

The field value to use when the imputation method is "value".

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.ImputeTransform
underlying transform object
transform_joinaggregate(joinaggregate=Undefined, groupby=Undefined, **kwargs)

Add a JoinAggregateTransform to the schema.

Parameters:
joinaggregate : List(JoinAggregateFieldDef)

The definition of the fields in the join aggregate, and what calculations to use.

groupby : List(string)

The data fields for partitioning the data objects into separate groups. If unspecified, all data points will be in a single group.

**kwargs

joinaggregates can also be passed by keyword argument; see Examples.

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.JoinAggregateTransform
underlying transform object

Examples

>>> import altair as alt
>>> chart = alt.Chart().transform_joinaggregate(x='sum(y)')
>>> chart.transform[0]
JoinAggregateTransform({
  joinaggregate: [JoinAggregateFieldDef({
    as: 'x',
    field: 'y',
    op: AggregateOp('sum')
  })]
})
transform_lookup(as_=Undefined, from_=Undefined, lookup=Undefined, default=Undefined, **kwargs)

Add a LookupTransform to the schema

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.LookupTransform
underlying transform object
Attributes:
as_ : anyOf(string, List(string))

The field or fields for storing the computed formula value. If from.fields is specified, the transform will use the same names for as. If from.fields is not specified, as has to be a string and we put the whole object into the data under the specified name.

from_ : LookupData

Secondary data reference.

lookup : string

Key in primary data source.

default : string

The default value to use if lookup fails. Default value: null

transform_sample(sample=1000)

Add a SampleTransform to the schema.

Parameters:
sample : float

The maximum number of data objects to include in the sample. Default: 1000.

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.SampleTransform
underlying transform object
transform_stack(as_, stack, groupby, offset=Undefined, sort=Undefined)

Add a StackTransform to the schema.

Parameters:
as_ : anyOf(string, List(string))

Output field names. This can be either a string or an array of strings with two elements denoting the name for the fields for stack start and stack end respectively. If a single string(eg.”val”) is provided, the end field will be “val_end”.

stack : string

The field which is stacked.

groupby : List(string)

The data fields to group by.

offset : enum(‘zero’, ‘center’, ‘normalize’)

Mode for stacking marks. Default: ‘zero’.

sort : List(SortField)

Field that determines the order of leaves in the stacked charts.

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.StackTransform
underlying transform object
transform_timeunit(as_=Undefined, field=Undefined, timeUnit=Undefined, **kwargs)

Add a TimeUnitTransform to the schema.

Parameters:
as_ : string

The output field to write the timeUnit value.

field : string

The data field to apply time unit.

timeUnit : TimeUnit

The timeUnit.

**kwargs

transforms can also be passed by keyword argument; see Examples

Returns:
self : Chart object

returns chart to allow for chaining

See also

alt.TimeUnitTransform
underlying transform object

Examples

>>> import altair as alt
>>> from altair import datum, expr
>>> chart = alt.Chart().transform_timeunit(month='month(date)')
>>> chart.transform[0]
TimeUnitTransform({
  as: 'month',
  field: 'date',
  timeUnit: 'month'
})

It’s also possible to pass the TimeUnitTransform arguments directly; this is most useful in cases where the desired field name is not a valid python identifier:

>>> kwds = {'as': 'month', 'timeUnit': 'month', 'field': 'The Month'}
>>> chart = alt.Chart().transform_timeunit(**kwds)
>>> chart.transform[0]
TimeUnitTransform({
  as: 'month',
  field: 'The Month',
  timeUnit: 'month'
})

As the first form is easier to write and understand, that is the recommended method.

transform_window(window=Undefined, frame=Undefined, groupby=Undefined, ignorePeers=Undefined, sort=Undefined, **kwargs)

Add a WindowTransform to the schema

Parameters:
window : List(WindowFieldDef)

The definition of the fields in the window, and what calculations to use.

frame : List(anyOf(None, float))

A frame specification as a two-element array indicating how the sliding window should proceed. The array entries should either be a number indicating the offset from the current data object, or null to indicate unbounded rows preceding or following the current data object. The default value is [null, 0], indicating that the sliding window includes the current object and all preceding objects. The value [-5, 5] indicates that the window should include five objects preceding and five objects following the current object. Finally, [null, null] indicates that the window frame should always include all data objects. The only operators affected are the aggregation operations and the first_value, last_value, and nth_value window operations. The other window operations are not affected by this.

Default value: : [null, 0] (includes the current object and all preceding objects)

groupby : List(string)

The data fields for partitioning the data objects into separate windows. If unspecified, all data points will be in a single group.

ignorePeers : boolean

Indicates if the sliding window frame should ignore peer values. (Peer values are those considered identical by the sort criteria). The default is false, causing the window frame to expand to include all peer values. If set to true, the window frame will be defined by offset values only. This setting only affects those operations that depend on the window frame, namely aggregation operations and the first_value, last_value, and nth_value window operations.

Default value: false

sort : List(SortField)

A sort field definition for sorting data objects within a window. If two data objects are considered equal by the comparator, they are considered “peer” values of equal rank. If sort is not specified, the order is undefined: data objects are processed in the order they are observed and none are considered peers (the ignorePeers parameter is ignored and treated as if set to true ).

**kwargs

transforms can also be passed by keyword argument; see Examples

Examples

A cumulative line chart

>>> import altair as alt
>>> import numpy as np
>>> import pandas as pd
>>> data = pd.DataFrame({'x': np.arange(100),
...                      'y': np.random.randn(100)})
>>> chart = alt.Chart(data).mark_line().encode(
...     x='x:Q',
...     y='ycuml:Q'
... ).transform_window(
...     ycuml='sum(y)'
... )
>>> chart.transform[0]
WindowTransform({
  window: [WindowFieldDef({
    as: 'ycuml',
    field: 'y',
    op: 'sum'
  })]
})
validate(instance, schema=None)

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

validate_property(name, value, schema=None)

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