altair.theme.ScaleConfigKwds#

class altair.theme.ScaleConfigKwds#

altair.ScaleConfig TypedDict wrapper.

Parameters:
bandPaddingInner

Default inner padding for x and y band scales.

Default value:

  • nestedOffsetPaddingInner for x/y scales with nested x/y offset scales.

  • barBandPaddingInner for bar marks (0.1 by default)

  • rectBandPaddingInner for rect and other marks (0 by default)

bandPaddingOuter

Default outer padding for x and y band scales.

Default value: paddingInner/2 (which makes width/height = number of unique values * step)

bandWithNestedOffsetPaddingInner

Default inner padding for x and y band scales with nested xOffset and yOffset encoding.

Default value: 0.2

bandWithNestedOffsetPaddingOuter

Default outer padding for x and y band scales with nested xOffset and yOffset encoding.

Default value: 0.2

barBandPaddingInner

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

Default value: 0.1

clamp

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

continuousPadding

Default padding for continuous x/y scales.

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

invalid

An object that defines scale outputs per channel for invalid values (nulls and NaNs on a continuous scale).

  • The keys in this object are the scale channels.

  • The values is either "zero-or-min" (use zero if the scale includes zero or min value otherwise) or a value definition {value: ...}.

Example: Setting this config.scale.invalid property to {color: {value: '#aaa'}} will make the visualization color all invalid values with ‘#aaa’.

See [https://vega.github.io/vega-lite/docs/invalid-data.html](Invalid Data Docs) for more details.

maxBandSize

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

If undefined (default), we will use the axis’s size (width or height) - 1.

maxFontSize

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

Default value: 40

maxOpacity

Default max opacity for mapping a field to opacity.

Default value: 0.8

maxSize

Default max value for point size scale.

maxStrokeWidth

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

Default value: 4

minBandSize

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

Default value: 2

minFontSize

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

Default value: 8

minOpacity

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

minSize

Default minimum value for point size scale.

Default value: 9

minStrokeWidth

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

Default value: 1

offsetBandPaddingInner

Default padding inner for xOffset/yOffset’s band scales.

Default Value: 0

offsetBandPaddingOuter

Default padding outer for xOffset/yOffset’s band scales.

Default Value: 0

pointPadding

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

Default value: 0.5 (which makes width/height = number of unique values * step)

quantileCount

Default range cardinality for quantile scale.

Default value: 4

quantizeCount

Default range cardinality for quantize scale.

Default value: 4

rectBandPaddingInner

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

Default value: 0

round

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

tickBandPaddingInner

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

Default value: 0.25

useUnaggregatedDomain

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

xReverse

Reverse x-scale by default (useful for right-to-left charts).

zero

Default scale.zero for continuous scales except for (1) x/y-scales of non-ranged bar or area charts and (2) size scales.

Default value: true

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

clear()

copy()

fromkeys(iterable[, value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

pop(key[, default])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Attributes

bandPaddingInner

bandPaddingOuter

bandWithNestedOffsetPaddingInner

bandWithNestedOffsetPaddingOuter

barBandPaddingInner

clamp

continuousPadding

invalid

maxBandSize

maxFontSize

maxOpacity

maxSize

maxStrokeWidth

minBandSize

minFontSize

minOpacity

minSize

minStrokeWidth

offsetBandPaddingInner

offsetBandPaddingOuter

pointPadding

quantileCount

quantizeCount

rectBandPaddingInner

round

tickBandPaddingInner

useUnaggregatedDomain

xReverse

zero