altair.OverlayMarkDef#

class altair.OverlayMarkDef(align=Undefined, angle=Undefined, aria=Undefined, ariaRole=Undefined, ariaRoleDescription=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, clip=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, description=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, endAngle=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, innerRadius=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, radius=Undefined, radius2=Undefined, radius2Offset=Undefined, radiusOffset=Undefined, shape=Undefined, size=Undefined, smooth=Undefined, startAngle=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, tension=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, theta2Offset=Undefined, thetaOffset=Undefined, timeUnitBandPosition=Undefined, timeUnitBandSize=Undefined, tooltip=Undefined, url=Undefined, width=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined, **kwds)#

OverlayMarkDef schema wrapper

Mapping(required=[])

Parameters:
alignanyOf(Align, ExprRef)

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

Note: Expression reference is not supported for range marks.

angleanyOf(float, ExprRef)

The rotation angle of the text, in degrees.

ariaanyOf(boolean, ExprRef)

A boolean flag indicating if ARIA attributes should be included (SVG output only). If false, the “aria-hidden” attribute will be set on the output SVG element, removing the mark item from the ARIA accessibility tree.

ariaRoleanyOf(string, ExprRef)

Sets the type of user interface element of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “role” attribute. Warning: this property is experimental and may be changed in the future.

ariaRoleDescriptionanyOf(string, ExprRef)

A human-readable, author-localized description for the role of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “aria-roledescription” attribute. Warning: this property is experimental and may be changed in the future.

aspectanyOf(boolean, ExprRef)

Whether to keep aspect ratio of image marks.

baselineanyOf(TextBaseline, ExprRef)

For text marks, the vertical text baseline. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", "line-bottom", or an expression reference that provides one of the valid values. The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the lineHeight rather than fontSize alone.

For range marks, the vertical alignment of the marks. One of "top", "middle", "bottom".

Note: Expression reference is not supported for range marks.

blendanyOf(Blend, ExprRef)

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

__Default value:__ "source-over"

clipboolean

Whether a mark be clipped to the enclosing group’s width and height.

coloranyOf(Color, Gradient, ExprRef)

Default color.

Default value: ■ "#4682b4"

Note:

  • This property cannot be used in a style config.

  • The fill and stroke properties have higher precedence than color and will override color.

cornerRadiusanyOf(float, ExprRef)

The radius in pixels of rounded rectangles or arcs’ corners.

Default value: 0

cornerRadiusBottomLeftanyOf(float, ExprRef)

The radius in pixels of rounded rectangles’ bottom left corner.

Default value: 0

cornerRadiusBottomRightanyOf(float, ExprRef)

The radius in pixels of rounded rectangles’ bottom right corner.

Default value: 0

cornerRadiusTopLeftanyOf(float, ExprRef)

The radius in pixels of rounded rectangles’ top right corner.

Default value: 0

cornerRadiusTopRightanyOf(float, ExprRef)

The radius in pixels of rounded rectangles’ top left corner.

Default value: 0

cursoranyOf(Cursor, ExprRef)

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

descriptionanyOf(string, ExprRef)

A text description of the mark item for ARIA accessibility (SVG output only). If specified, this property determines the “aria-label” attribute.

diranyOf(TextDirection, ExprRef)

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"

dxanyOf(float, ExprRef)

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

dyanyOf(float, ExprRef)

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

ellipsisanyOf(string, ExprRef)

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

Default value: "…"

endAngleanyOf(float, ExprRef)

The end angle in radians for arc marks. A value of 0 indicates up (north), increasing values proceed clockwise.

fillanyOf(Color, Gradient, None, ExprRef)

Default fill color. This property has higher precedence than config.color. Set to null to remove fill.

Default value: (None)

fillOpacityanyOf(float, ExprRef)

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

Default value: 1

filledboolean

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

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

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

fontanyOf(string, ExprRef)

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

fontSizeanyOf(float, ExprRef)

The font size, in pixels.

Default value: 11

fontStyleanyOf(FontStyle, ExprRef)

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

fontWeightanyOf(FontWeight, ExprRef)

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

heightanyOf(float, ExprRef)

Height of the marks.

hrefanyOf(URI, ExprRef)

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

innerRadiusanyOf(float, ExprRef)

The inner radius in pixels of arc marks. innerRadius is an alias for radius2.

Default value: 0

interpolateanyOf(Interpolate, ExprRef)

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.

invalidenum(‘filter’, None)

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

  • If set to "filter" (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).

  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.

limitanyOf(float, ExprRef)

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

lineBreakanyOf(string, ExprRef)

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

lineHeightanyOf(float, ExprRef)

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

opacityanyOf(float, ExprRef)

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.

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

orientOrientation

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.

outerRadiusanyOf(float, ExprRef)

The outer radius in pixels of arc marks. outerRadius is an alias for radius.

Default value: 0

padAngleanyOf(float, ExprRef)

The angular padding applied to sides of the arc, in radians.

radiusanyOf(float, ExprRef)

For arc mark, the primary (outer) radius in pixels.

For text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the x and y properties.

Default value: min(plot_width, plot_height)/2

radius2anyOf(float, ExprRef)

The secondary (inner) radius in pixels of arc marks.

Default value: 0

radius2OffsetanyOf(float, ExprRef)

Offset for radius2.

radiusOffsetanyOf(float, ExprRef)

Offset for radius.

shapeanyOf(anyOf(SymbolShape, string), ExprRef)

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"

sizeanyOf(float, ExprRef)

Default size for marks.

  • For point / circle / square, this represents the pixel area of the marks. Note that this value sets the area of the symbol; the side lengths will increase with the square root of this value.

  • For bar, this represents the band size of the bar, in pixels.

  • For text, this represents the font size, in pixels.

Default value:

  • 30 for point, circle, square marks; width/height’s step

  • 2 for bar marks with discrete dimensions;

  • 5 for bar marks with continuous dimensions;

  • 11 for text marks.

smoothanyOf(boolean, ExprRef)

A boolean flag (default true) indicating if the image should be smoothed when resized. If false, individual pixels should be scaled directly rather than interpolated with smoothing. For SVG rendering, this option may not work in some browsers due to lack of standardization.

startAngleanyOf(float, ExprRef)

The start angle in radians for arc marks. A value of 0 indicates up (north), increasing values proceed clockwise.

strokeanyOf(Color, Gradient, None, ExprRef)

Default stroke color. This property has higher precedence than config.color. Set to null to remove stroke.

Default value: (None)

strokeCapanyOf(StrokeCap, ExprRef)

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

Default value: "butt"

strokeDashanyOf(List(float), ExprRef)

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

strokeDashOffsetanyOf(float, ExprRef)

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

strokeJoinanyOf(StrokeJoin, ExprRef)

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

Default value: "miter"

strokeMiterLimitanyOf(float, ExprRef)

The miter limit at which to bevel a line join.

strokeOffsetanyOf(float, ExprRef)

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

strokeOpacityanyOf(float, ExprRef)

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

Default value: 1

strokeWidthanyOf(float, ExprRef)

The stroke width, in pixels.

styleanyOf(string, List(string))

A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the style configuration. If style is an array, later styles will override earlier styles. Any mark properties explicitly defined within the encoding will override a style default.

Default value: The mark’s name. For example, a bar mark will have style "bar" by default. Note: Any specified style will augment the default style. For example, a bar mark with "style": "foo" will receive from config.style.bar and config.style.foo (the specified style "foo" has higher precedence).

tensionanyOf(float, ExprRef)

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

textanyOf(Text, ExprRef)

Placeholder text if the text channel is not specified

thetaanyOf(float, ExprRef)

For arc marks, the arc length in radians if theta2 is not specified, otherwise the start arc angle. (A value of 0 indicates up or “north”, increasing values proceed clockwise.)

For text marks, polar coordinate angle in radians.

theta2anyOf(float, ExprRef)

The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise.

theta2OffsetanyOf(float, ExprRef)

Offset for theta2.

thetaOffsetanyOf(float, ExprRef)

Offset for theta.

timeUnitBandPositionfloat

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

timeUnitBandSizefloat

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

tooltipanyOf(float, string, boolean, TooltipContent, ExprRef, None)

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

  • If tooltip is true or {"content": "encoding"}, then all fields from encoding will be used.

  • If tooltip is {"content": "data"}, then all fields that appear in the highlighted data point will be used.

  • If set to null or false, then no tooltip will be used.

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

Default value: null

urlanyOf(URI, ExprRef)

The URL of the image file for image marks.

widthanyOf(float, ExprRef)

Width of the marks.

xanyOf(float, string, ExprRef)

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

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

x2anyOf(float, string, ExprRef)

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

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

x2OffsetanyOf(float, ExprRef)

Offset for x2-position.

xOffsetanyOf(float, ExprRef)

Offset for x-position.

yanyOf(float, string, ExprRef)

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

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

y2anyOf(float, string, ExprRef)

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

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

y2OffsetanyOf(float, ExprRef)

Offset for y2-position.

yOffsetanyOf(float, ExprRef)

Offset for y-position.

__init__(align=Undefined, angle=Undefined, aria=Undefined, ariaRole=Undefined, ariaRoleDescription=Undefined, aspect=Undefined, baseline=Undefined, blend=Undefined, clip=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cursor=Undefined, description=Undefined, dir=Undefined, dx=Undefined, dy=Undefined, ellipsis=Undefined, endAngle=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, height=Undefined, href=Undefined, innerRadius=Undefined, interpolate=Undefined, invalid=Undefined, limit=Undefined, lineBreak=Undefined, lineHeight=Undefined, opacity=Undefined, order=Undefined, orient=Undefined, outerRadius=Undefined, padAngle=Undefined, radius=Undefined, radius2=Undefined, radius2Offset=Undefined, radiusOffset=Undefined, shape=Undefined, size=Undefined, smooth=Undefined, startAngle=Undefined, stroke=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, strokeJoin=Undefined, strokeMiterLimit=Undefined, strokeOffset=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, tension=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, theta2Offset=Undefined, thetaOffset=Undefined, timeUnitBandPosition=Undefined, timeUnitBandSize=Undefined, tooltip=Undefined, url=Undefined, width=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined, **kwds)#

Methods

__init__([align, angle, aria, ariaRole, ...])

copy([deep, ignore])

Return a copy of the object

from_dict(dct[, validate, _wrapper_classes])

Construct class from a dictionary representation

from_json(json_string[, validate])

Instantiate the object from a valid JSON string

resolve_references([schema])

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

to_dict([validate, ignore, context])

Return a dictionary representation of the object

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

Emit the JSON representation for this object as a string.

validate(instance[, schema])

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

validate_property(name, value[, schema])

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