altair.Scale#

class altair.Scale(align=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainRaw=Undefined, exponent=Undefined, interpolate=Undefined, nice=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, range=Undefined, rangeMax=Undefined, rangeMin=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, zero=Undefined, **kwds)#

比例尺 schema 包装器。

参数:
aligndict, float, ExprRef

比例尺范围内的步长对齐方式。

该值必须在 [0,1] 范围内。值为 0.5 表示步长应居中对齐。值为 01 可用于将色带移动到一侧,例如将它们放置在轴旁边。

默认值: 0.5

basedict, float, ExprRef

log 比例尺的对数底数(默认为 10)。

binsdict, Sequence[float], ScaleBins, ScaleBinParams

可以以显式的 bin 边界数组或 bin 规范对象的形式为比例尺提供 bin 边界。合法值包括

  • 一个 bin 边界值的数组文字。例如,[0, 5, 10, 15, 20]。数组必须包含起始边界和结束边界。前面的示例使用五个值来表示总共四个 bin 区间:[0-5),[5-10),[10-15),[15-20]。数组文字可以包含信号引用作为元素。

  • 一个bin 规范对象,指示 bin 的*步长*,以及可选的*起始*和*结束*边界。

  • 比例尺域上的 bin 边界数组。如果提供,轴和图例将使用 bin 边界来指导刻度线和文本标签的选择。

clampbool, dict, ExprRef

如果为 true,则超出数据域的值将被限制在最小或最大范围值内

默认值: 派生自比例尺配置clamp(默认为 true)。

constantdict, float, ExprRef

确定 symlog 函数在零附近的斜率的常数。仅用于 symlog 比例尺。

默认值: 1

domaindict, ExprRef, Literal[‘unaggregated’], DomainUnionWith, ParameterExtent, Sequence[str, bool, dict, float, ExprRef, DateTime, None]

以常量值或由参数驱动的动态值形式自定义域值。

1) 定量字段的常量 domain 可以采用以下形式之一

  • 一个包含最小值和最大值的两元素数组。为了创建发散比例尺,此两元素数组可以与 domainMid 属性结合使用。

  • 一个包含两个以上条目的数组,用于分段定量比例尺

  • 一个字符串值 "unaggregated",如果输入字段已聚合,则表示域应包含聚合前的原始数据值。

2) 时间字段的常量 domain 可以是包含最小值和最大值的两元素数组,形式为时间戳或DateTime 定义对象

3) 有序名义字段的常量 domain 可以是列出有效输入值的数组。

4) 要将指定的常量域与字段值组合(联合),domain 可以是一个对象,其具有指定要组合的常量域的 unionWith 属性。例如,定量比例尺的 domain: {unionWith: [0, 100]} 意味着比例尺域始终包含 [0, 100],但将包含字段中超出 [0, 100] 的其他值。

5) 域还可以采用一个对象,该对象定义一个字段或参数的编码,用于交互式地确定比例尺域。

domainMaxdict, float, ExprRef, DateTime

设置比例尺域中的最大值,覆盖 domain 属性。此属性仅适用于具有连续域的比例尺。

domainMiddict, float, ExprRef

将单个中点值插入到两元素域中。中点值必须位于域的最小值和最大值之间。此属性对于为发散颜色比例尺设置中点非常有用。domainMid 属性仅适用于支持连续分段域的比例尺。

domainMindict, float, ExprRef, DateTime

设置比例尺域中的最小值,覆盖 domain 属性。此属性仅适用于具有连续域的比例尺。

domainRawdict, ExprRef

一个用于原始值数组的表达式,如果非空,则直接覆盖 domain 属性。这对于支持平移或缩放比例尺等交互非常有用。比例尺最初可以使用数据驱动的域确定,然后通过设置 rawDomain 值根据用户输入进行修改。

exponentdict, float, ExprRef

pow 比例尺的指数。

interpolatedict, ExprRef, ScaleInterpolateEnum, ScaleInterpolateParams, Literal[‘rgb’, ‘lab’, ‘hcl’, ‘hsl’, ‘hsl-long’, ‘hcl-long’, ‘cubehelix’, ‘cubehelix-long’]

范围值的插值方法。默认情况下,使用对数字、日期、字符串和颜色(在 HCL 空间中)进行一般插值的插值器。对于颜色范围,此属性允许在替代颜色空间中进行插值。合法值包括 rgbhslhsl-longlabhclhcl-longcubehelixcubehelix-long('-long' 变体在极坐标空间中使用较长的路径)。如果值为对象,则此属性接受一个对象,该对象具有字符串值的 type 属性和适用于 rgb 和 cubehelix 插值器的可选数字 gamma 属性。有关更多信息,请参阅 d3-interpolate 文档

  • 默认值: hcl

nicebool, dict, float, ExprRef, TimeInterval, TimeIntervalStep, Literal[‘millisecond’, ‘second’, ‘minute’, ‘hour’, ‘day’, ‘week’, ‘month’, ‘year’]

扩展域,使其以合适的整数值开始和结束。此方法通常会修改比例尺的域,并且可能只会将边界扩展到最近的整数值。如果域是从数据计算出来的并且可能不规则,那么进行“nicing”很有用。例如,对于域 [0.201479…, 0.996679…],一个合适的域可能是 [0.2, 1.0]

对于线性等定量比例尺,nice 可以是布尔标志或数字。如果 nice 是数字,则它将表示所需的刻度数。这允许更好地控制用于扩展边界的步长,确保返回的刻度完全覆盖域。

对于带有 time 和 utc 比例尺的时间字段,nice 值可以是表示所需时间间隔的字符串。合法值包括 "millisecond""second""minute""hour""day""week""month""year"。或者,timeutc 比例尺可以接受形如 {"interval": "month", "step": 3} 的对象值间隔指定器,其中包含所需的间隔步数。在此例中,域将对齐到季度(Jan, Apr, Jul, Oct)边界。

默认值: 对于没有显式域边界的未分箱定量字段为 true;否则为 false

paddingdict, float, ExprRef

对于 ` 比例尺,将比例尺域展开以容纳比例尺范围内每个指定数量的像素。比例尺范围必须表示像素,此参数才能按预期工作。填充调整在所有其他调整之前执行,包括 zeronicedomainMindomainMax 属性的效果。

对于 ` 比例尺,这是将 paddingInnerpaddingOuter 设置为相同值的快捷方式。

对于 ` 比例尺,这是 paddingOuter 的别名。

默认值: 对于连续比例尺,派生自比例尺配置continuousPadding。对于band 和 point 比例尺,请参阅 paddingInnerpaddingOuter。默认情况下,Vega-Lite 设置填充,使得 宽度/高度 = 唯一值数量 * 步长

paddingInnerdict, float, ExprRef

band 比例尺每个 band 步长内的内部填充(间距),作为步长的分数。此值必须在 [0,1] 范围内。

对于 point 比例尺,此属性无效,因为 point 比例尺没有内部 band 宽度(只有 band 之间的步长)。

默认值: 派生自比例尺配置bandPaddingInner

paddingOuterdict, float, ExprRef

band 和 point 比例尺范围两端的外部填充(间距),作为步长的分数。此值必须在 [0,1] 范围内。

默认值: 派生自比例尺配置的 band 比例尺的 bandPaddingOuter 和 point 比例尺的 pointPadding。默认情况下,Vega-Lite 设置外部填充,使得 宽度/高度 = 唯一值数量 * 步长

rangedict, RangeEnum, FieldRange, Sequence[str, dict, float, Sequence[float], ExprRef], Literal[‘width’, ‘height’, ‘symbol’, ‘category’, ‘ordinal’, ‘ramp’, ‘diverging’, ‘heatmap’]

比例尺的范围。可以是以下之一

  • 表示预定义的命名比例尺范围的字符串(例如,"symbol""diverging")。

  • 对于连续比例尺,表示最小值和最大值的两元素数组,或具有两个以上条目用于指定分段比例尺的数组。

  • 对于离散离散化比例尺,可以是所需输出值的数组,或具有表示范围值的 field 属性的对象。例如,如果字段 color 包含 CSS 颜色名称,我们可以将 range 设置为 {field: "color"}

注意

1) 对于颜色比例尺,您还可以指定颜色方案,而不是 range

2) 任何直接为 xy 通道指定的 range 都将被忽略。范围可以通过视图相应的大小widthheight)进行自定义。

rangeMaxstr, dict, float, ExprRef

设置比例尺范围中的最大值,覆盖 range 属性或默认范围。此属性仅适用于具有连续范围的比例尺。

rangeMinstr, dict, float, ExprRef

设置比例尺范围中的最小值,覆盖 range 属性或默认范围。此属性仅适用于具有连续范围的比例尺。

reversebool, dict, ExprRef

如果为 true,则反转比例尺范围的顺序。默认值: false

roundbool, dict, ExprRef

如果为 true,将数值输出值四舍五入为整数。这有助于对齐到像素网格。

默认值: false

schemedict, ExprRef, Cyclical, Diverging, Categorical, ColorScheme, SchemeParams, SequentialMultiHue, SequentialSingleHue, Literal[‘accent’, ‘category10’, ‘category20’, ‘category20b’, ‘category20c’, ‘dark2’, ‘paired’, ‘pastel1’, ‘pastel2’, ‘set1’, ‘set2’, ‘set3’, ‘tableau10’, ‘tableau20’, ‘blueorange’, ‘blueorange-3’, ‘blueorange-4’, ‘blueorange-5’, ‘blueorange-6’, ‘blueorange-7’, ‘blueorange-8’, ‘blueorange-9’, ‘blueorange-10’, ‘blueorange-11’, ‘brownbluegreen’, ‘brownbluegreen-3’, ‘brownbluegreen-4’, ‘brownbluegreen-5’, ‘brownbluegreen-6’, ‘brownbluegreen-7’, ‘brownbluegreen-8’, ‘brownbluegreen-9’, ‘brownbluegreen-10’, ‘brownbluegreen-11’, ‘purplegreen’, ‘purplegreen-3’, ‘purplegreen-4’, ‘purplegreen-5’, ‘purplegreen-6’, ‘purplegreen-7’, ‘purplegreen-8’, ‘purplegreen-9’, ‘purplegreen-10’, ‘purplegreen-11’, ‘pinkyellowgreen’, ‘pinkyellowgreen-3’, ‘pinkyellowgreen-4’, ‘pinkyellowgreen-5’, ‘pinkyellowgreen-6’, ‘pinkyellowgreen-7’, ‘pinkyellowgreen-8’, ‘pinkyellowgreen-9’, ‘pinkyellowgreen-10’, ‘pinkyellowgreen-11’, ‘purpleorange’, ‘purpleorange-3’, ‘purpleorange-4’, ‘purpleorange-5’, ‘purpleorange-6’, ‘purpleorange-7’, ‘purpleorange-8’, ‘purpleorange-9’, ‘purpleorange-10’, ‘purpleorange-11’, ‘redblue’, ‘redblue-3’, ‘redblue-4’, ‘redblue-5’, ‘redblue-6’, ‘redblue-7’, ‘redblue-8’, ‘redblue-9’, ‘redblue-10’, ‘redblue-11’, ‘redgrey’, ‘redgrey-3’, ‘redgrey-4’, ‘redgrey-5’, ‘redgrey-6’, ‘redgrey-7’, ‘redgrey-8’, ‘redgrey-9’, ‘redgrey-10’, ‘redgrey-11’, ‘redyellowblue’, ‘redyellowblue-3’, ‘redyellowblue-4’, ‘redyellowblue-5’, ‘redyellowblue-6’, ‘redyellowblue-7’, ‘redyellowblue-8’, ‘redyellowblue-9’, ‘redyellowblue-10’, ‘redyellowblue-11’, ‘redyellowgreen’, ‘redyellowgreen-3’, ‘redyellowgreen-4’, ‘redyellowgreen-5’, ‘redyellowgreen-6’, ‘redyellowgreen-7’, ‘redyellowgreen-8’, ‘redyellowgreen-9’, ‘redyellowgreen-10’, ‘redyellowgreen-11’, ‘spectral’, ‘spectral-3’, ‘spectral-4’, ‘spectral-5’, ‘spectral-6’, ‘spectral-7’, ‘spectral-8’, ‘spectral-9’, ‘spectral-10’, ‘spectral-11’, ‘blues’, ‘tealblues’, ‘teals’, ‘greens’, ‘browns’, ‘greys’, ‘purples’, ‘warmgreys’, ‘reds’, ‘oranges’, ‘rainbow’, ‘sinebow’, ‘turbo’, ‘viridis’, ‘inferno’, ‘magma’, ‘plasma’, ‘cividis’, ‘bluegreen’, ‘bluegreen-3’, ‘bluegreen-4’, ‘bluegreen-5’, ‘bluegreen-6’, ‘bluegreen-7’, ‘bluegreen-8’, ‘bluegreen-9’, ‘bluepurple’, ‘bluepurple-3’, ‘bluepurple-4’, ‘bluepurple-5’, ‘bluepurple-6’, ‘bluepurple-7’, ‘bluepurple-8’, ‘bluepurple-9’, ‘goldgreen’, ‘goldgreen-3’, ‘goldgreen-4’, ‘goldgreen-5’, ‘goldgreen-6’, ‘goldgreen-7’, ‘goldgreen-8’, ‘goldgreen-9’, ‘goldorange’, ‘goldorange-3’, ‘goldorange-4’, ‘goldorange-5’, ‘goldorange-6’, ‘goldorange-7’, ‘goldorange-8’, ‘goldorange-9’, ‘goldred’, ‘goldred-3’, ‘goldred-4’, ‘goldred-5’, ‘goldred-6’, ‘goldred-7’, ‘goldred-8’, ‘goldred-9’, ‘greenblue’, ‘greenblue-3’, ‘greenblue-4’, ‘greenblue-5’, ‘greenblue-6’, ‘greenblue-7’, ‘greenblue-8’, ‘greenblue-9’, ‘orangered’, ‘orangered-3’, ‘orangered-4’, ‘orangered-5’, ‘orangered-6’, ‘orangered-7’, ‘orangered-8’, ‘orangered-9’, ‘purplebluegreen’, ‘purplebluegreen-3’, ‘purplebluegreen-4’, ‘purplebluegreen-5’, ‘purplebluegreen-6’, ‘purplebluegreen-7’, ‘purplebluegreen-8’, ‘purplebluegreen-9’, ‘purpleblue’, ‘purpleblue-3’, ‘purpleblue-4’, ‘purpleblue-5’, ‘purpleblue-6’, ‘purpleblue-7’, ‘purpleblue-8’, ‘purpleblue-9’, ‘purplered’, ‘purplered-3’, ‘purplered-4’, ‘purplered-5’, ‘purplered-6’, ‘purplered-7’, ‘purplered-8’, ‘purplered-9’, ‘redpurple’, ‘redpurple-3’, ‘redpurple-4’, ‘redpurple-5’, ‘redpurple-6’, ‘redpurple-7’, ‘redpurple-8’, ‘redpurple-9’, ‘yellowgreenblue’, ‘yellowgreenblue-3’, ‘yellowgreenblue-4’, ‘yellowgreenblue-5’, ‘yellowgreenblue-6’, ‘yellowgreenblue-7’, ‘yellowgreenblue-8’, ‘yellowgreenblue-9’, ‘yellowgreen’, ‘yellowgreen-3’, ‘yellowgreen-4’, ‘yellowgreen-5’, ‘yellowgreen-6’, ‘yellowgreen-7’, ‘yellowgreen-8’, ‘yellowgreen-9’, ‘yelloworangebrown’, ‘yelloworangebrown-3’, ‘yelloworangebrown-4’, ‘yelloworangebrown-5’, ‘yelloworangebrown-6’, ‘yelloworangebrown-7’, ‘yelloworangebrown-8’, ‘yelloworangebrown-9’, ‘yelloworangered’, ‘yelloworangered-3’, ‘yelloworangered-4’, ‘yelloworangered-5’, ‘yelloworangered-6’, ‘yelloworangered-7’, ‘yelloworangered-8’, ‘yelloworangered-9’, ‘darkblue’, ‘darkblue-3’, ‘darkblue-4’, ‘darkblue-5’, ‘darkblue-6’, ‘darkblue-7’, ‘darkblue-8’, ‘darkblue-9’, ‘darkgold’, ‘darkgold-3’, ‘darkgold-4’, ‘darkgold-5’, ‘darkgold-6’, ‘darkgold-7’, ‘darkgold-8’, ‘darkgold-9’, ‘darkgreen’, ‘darkgreen-3’, ‘darkgreen-4’, ‘darkgreen-5’, ‘darkgreen-6’, ‘darkgreen-7’, ‘darkgreen-8’, ‘darkgreen-9’, ‘darkmulti’, ‘darkmulti-3’, ‘darkmulti-4’, ‘darkmulti-5’, ‘darkmulti-6’, ‘darkmulti-7’, ‘darkmulti-8’, ‘darkmulti-9’, ‘darkred’, ‘darkred-3’, ‘darkred-4’, ‘darkred-5’, ‘darkred-6’, ‘darkred-7’, ‘darkred-8’, ‘darkred-9’, ‘lightgreyred’, ‘lightgreyred-3’, ‘lightgreyred-4’, ‘lightgreyred-5’, ‘lightgreyred-6’, ‘lightgreyred-7’, ‘lightgreyred-8’, ‘lightgreyred-9’, ‘lightgreyteal’, ‘lightgreyteal-3’, ‘lightgreyteal-4’, ‘lightgreyteal-5’, ‘lightgreyteal-6’, ‘lightgreyteal-7’, ‘lightgreyteal-8’, ‘lightgreyteal-9’, ‘lightmulti’, ‘lightmulti-3’, ‘lightmulti-4’, ‘lightmulti-5’, ‘lightmulti-6’, ‘lightmulti-7’, ‘lightmulti-8’, ‘lightmulti-9’, ‘lightorange’, ‘lightorange-3’, ‘lightorange-4’, ‘lightorange-5’, ‘lightorange-6’, ‘lightorange-7’, ‘lightorange-8’, ‘lightorange-9’, ‘lighttealblue’, ‘lighttealblue-3’, ‘lighttealblue-4’, ‘lighttealblue-5’, ‘lighttealblue-6’, ‘lighttealblue-7’, ‘lighttealblue-8’, ‘lighttealblue-9’]

表示颜色方案名称(例如,"category10""blues")的字符串,或方案参数对象

离散颜色方案可用于离散离散化比例尺。连续颜色方案适用于颜色比例尺。

要设置自定义方案,请将值列表设置为比例尺范围

有关支持的完整方案列表,请参阅Vega Scheme 参考。

typeScaleType, Literal[‘linear’, ‘log’, ‘pow’, ‘sqrt’, ‘symlog’, ‘identity’, ‘sequential’, ‘time’, ‘utc’, ‘quantile’, ‘quantize’, ‘threshold’, ‘bin-ordinal’, ‘ordinal’, ‘point’, ‘band’]

比例尺类型。Vega-Lite 支持以下几类比例尺类型

1) 连续比例尺 – 将连续域映射到连续输出范围(“linear”“pow”“sqrt”“symlog”“log”“time”“utc”)。

2) 离散比例尺 – 将离散域映射到离散(“ordinal”)或连续(“band”“point”)输出范围。

3) 离散化比例尺 – 将连续域映射到离散输出范围:“bin-ordinal”“quantile”“quantize”“threshold”

默认值: 请参阅比例尺类型表

zerobool, dict, ExprRef

如果为 true,则确保比例尺域中包含零基准值。

默认值: 如果定量字段未分箱且未提供自定义 domain,则 x 和 y 通道为 true;否则为 false

注意: Log、time 和 utc 比例尺不支持 zero

__init__(align=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainRaw=Undefined, exponent=Undefined, interpolate=Undefined, nice=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, range=Undefined, rangeMax=Undefined, rangeMin=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, zero=Undefined, **kwds)#

方法

__init__([align, base, bins, clamp, ...])

copy([deep, ignore])

返回对象的副本。

from_dict(dct[, validate])

从字典表示构造类。

from_json(json_string[, validate])

从有效的 JSON 字符串实例化对象。

resolve_references([schema])

在此对象的 schema 或根 schema 上下文中解析引用。

to_dict([validate, ignore, context])

返回对象的字典表示。

to_json([validate, indent, sort_keys, ...])

将此对象的 JSON 表示作为字符串发出。

validate(instance[, schema])

在 rootschema 上下文中根据类 schema 验证实例。

validate_property(name, value[, schema])

在 rootschema 上下文中根据属性 schema 验证属性。