altair.Url

class altair.Url(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, format=Undefined, formatType=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)

Url schema wrapper。

参数:

shorthandstr, dict, Sequence[str], RepeatRef

field, aggregate 和 type 的简写

aggregatedict, Aggregate, ArgmaxDef, ArgminDef, NonArgAggregateOp, Literal[‘average’, ‘count’, ‘distinct’, ‘max’, ‘mean’, ‘median’, ‘min’, ‘missing’, ‘product’, ‘q1’, ‘q3’, ‘ci0’, ‘ci1’, ‘stderr’, ‘stdev’, ‘stdevp’, ‘sum’, ‘valid’, ‘values’, ‘variance’, ‘variancep’, ‘exponential’, ‘exponentialb’]

字段的聚合函数（例如，"mean", "sum", "median", "min", "max", "count"）。

默认值: undefined (None)

另请参见: aggregate 文档。

bandPositionfloat

堆叠、分箱、时间单位或带状比例尺上的带的相对位置。例如，如果设置为0，标记将位于带的开头，如果设置为0.5，则位于带的中间。

binbool, dict, Literal[‘binned’], BinParams, None

对quantitative字段进行分箱的标志，定义分箱参数的对象，或指示x或y通道的数据在导入Vega-Lite之前已分箱（"binned"）。

• 如果为true，将应用默认的分箱参数。

• 如果为"binned"，这表示x（或y）通道的数据已经分箱。可以将分箱开始字段映射到x（或y），将分箱结束字段映射到x2（或y2）。比例尺和轴将采用类似于Vega-Lite中分箱的格式。要根据分箱步长调整轴刻度，您还可以设置轴的tickMinStep属性。

默认值: false

另请参见: bin 文档。

conditiondict, ConditionalValueDefstringExprRef, ConditionalParameterValueDefstringExprRef, ConditionalPredicateValueDefstringExprRef, Sequence[dict, ConditionalValueDefstringExprRef, ConditionalParameterValueDefstringExprRef, ConditionalPredicateValueDefstringExprRef]

一个或多个值定义，带有参数或测试谓词。

注意: 字段定义的condition属性只能包含条件值定义，因为Vega-Lite每个编码通道最多只允许一个编码字段。

fieldstr, dict, Field, FieldName, RepeatRef

必需。 定义从哪个字段获取数据值的字符串，或定义从repeat操作符迭代值的对象。

另请参见: field 文档。

注意: 1) 点号（.）和方括号（[和]）可用于访问嵌套对象（例如，"field": "foo.bar"和"field": "foo['bar']"）。如果字段名称包含点号或方括号但不是嵌套的，可以使用\\转义点号和方括号（例如，"a\\.b"和"a\\[0\\]"）。有关转义的更多详细信息，请参阅field 文档。2) 如果aggregate是count，则不需要field。

formatstr, dict, Dict

当与默认的"number"和"time"格式类型一起使用时，用于指南（轴、图例、头部）标签和文本标记的文本格式模式。

• 如果格式类型是"number"（例如，用于定量字段），这是D3的数字格式模式。

• 如果格式类型是"time"（例如，用于时间字段），这是D3的时间格式模式。

有关更多示例，请参阅format 文档。

当与自定义格式类型一起使用时，此值将作为format与datum.value一起传递给注册函数。

默认值: 数字格式从numberFormat配置派生，时间格式从timeFormat配置派生。

formatTypestr

标签的格式类型。可以是"number"、"time"，或注册的自定义格式类型之一。

默认值

• 对于时间字段以及带有timeUnit的有序字段和名义字段，为"time"。

• 对于定量字段以及没有timeUnit的有序字段和名义字段，为"number"。

timeUnitdict, TimeUnit, MultiTimeUnit, BinnedTimeUnit, SingleTimeUnit, TimeUnitParams, UtcMultiTimeUnit, UtcSingleTimeUnit, LocalMultiTimeUnit, LocalSingleTimeUnit, Literal[‘binnedutcyear’, ‘binnedutcyearquarter’, ‘binnedutcyearquartermonth’, ‘binnedutcyearmonth’, ‘binnedutcyearmonthdate’, ‘binnedutcyearmonthdatehours’, ‘binnedutcyearmonthdatehoursminutes’, ‘binnedutcyearmonthdatehoursminutesseconds’, ‘binnedutcyearweek’, ‘binnedutcyearweekday’, ‘binnedutcyearweekdayhours’, ‘binnedutcyearweekdayhoursminutes’, ‘binnedutcyearweekdayhoursminutesseconds’, ‘binnedutcyeardayofyear’, ‘binnedyear’, ‘binnedyearquarter’, ‘binnedyearquartermonth’, ‘binnedyearmonth’, ‘binnedyearmonthdate’, ‘binnedyearmonthdatehours’, ‘binnedyearmonthdatehoursminutes’, ‘binnedyearmonthdatehoursminutesseconds’, ‘binnedyearweek’, ‘binnedyearweekday’, ‘binnedyearweekdayhours’, ‘binnedyearweekdayhoursminutes’, ‘binnedyearweekdayhoursminutesseconds’, ‘binnedyeardayofyear’, ‘utcyear’, ‘utcquarter’, ‘utcmonth’, ‘utcweek’, ‘utcday’, ‘utcdayofyear’, ‘utcdate’, ‘utchours’, ‘utcminutes’, ‘utcseconds’, ‘utcmilliseconds’, ‘utcyearquarter’, ‘utcyearquartermonth’, ‘utcyearmonth’, ‘utcyearmonthdate’, ‘utcyearmonthdatehours’, ‘utcyearmonthdatehoursminutes’, ‘utcyearmonthdatehoursminutesseconds’, ‘utcyearweek’, ‘utcyearweekday’, ‘utcyearweekdayhours’, ‘utcyearweekdayhoursminutes’, ‘utcyearweekdayhoursminutesseconds’, ‘utcyeardayofyear’, ‘utcquartermonth’, ‘utcmonthdate’, ‘utcmonthdatehours’, ‘utcmonthdatehoursminutes’, ‘utcmonthdatehoursminutesseconds’, ‘utcweekday’, ‘utcweekdayhours’, ‘utcweekdayhoursminutes’, ‘utcweekdayhoursminutesseconds’, ‘utcdayhours’, ‘utcdayhoursminutes’, ‘utcdayhoursminutesseconds’, ‘utchoursminutes’, ‘utchoursminutesseconds’, ‘utcminutesseconds’, ‘utcsecondsmilliseconds’, ‘yearquarter’, ‘yearquartermonth’, ‘yearmonth’, ‘yearmonthdate’, ‘yearmonthdatehours’, ‘yearmonthdatehoursminutes’, ‘yearmonthdatehoursminutesseconds’, ‘yearweek’, ‘yearweekday’, ‘yearweekdayhours’, ‘yearweekdayhoursminutes’, ‘yearweekdayhoursminutesseconds’, ‘yeardayofyear’, ‘quartermonth’, ‘monthdate’, ‘monthdatehours’, ‘monthdatehoursminutes’, ‘monthdatehoursminutesseconds’, ‘weekday’, ‘weekdayhours’, ‘weekdayhoursminutes’, ‘weekdayhoursminutesseconds’, ‘dayhours’, ‘dayhoursminutes’, ‘dayhoursminutesseconds’, ‘hoursminutes’, ‘hoursminutesseconds’, ‘minutesseconds’, ‘secondsmilliseconds’]

时间字段的时间单位（例如，year, yearmonth, month, hours）。 或被转换为有序类型的时间字段。

默认值: undefined (None)

另请参见: timeUnit 文档。

titlestr, Text, Sequence[str], None

字段的标题。如果为null，则移除标题。

默认值: 从字段名称和转换函数（aggregate, bin 和 timeUnit）派生。如果字段有聚合函数，该函数将作为标题的一部分显示（例如，"Sum of Profit"）。如果字段经过分箱或应用了时间单位，则应用的函数会显示在括号中（例如，"Profit (binned)"，"Transaction Date (year-month)"）。否则，标题就是字段名称。

注意:

1) 您可以通过在config中提供fieldTitle属性或通过compile 函数的选项中的 fieldTitle 函数来自定义默认字段标题格式。

2) 如果同时定义了字段定义的title以及轴、头部或图例的title，则将使用轴/头部/图例的标题。

typeStandardType, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’]

编码字段或常量值（datum）的度量类型（"quantitative", "temporal", "ordinal", 或 "nominal"）。它也可以是用于编码‘geoshape’的"geojson"类型。

Vega-Lite在许多情况下会自动推断数据类型，如下所述。但是，在以下情况下，字段需要指定类型：(1) 字段不是名义类型，且字段编码没有指定aggregate（argmin和argmax除外）、bin、比例尺类型、自定义sort顺序或timeUnit；或 (2) 如果您希望对带有bin或timeUnit的字段使用有序比例尺。

默认值

1) 对于数据field，除非字段编码包含满足以下条件的aggregate, channel, bin, 比例尺类型, sort, 或 timeUnit，否则"nominal"是默认数据类型：

• 在以下情况下，"quantitative"是默认类型：(1) 编码字段包含bin或aggregate（"argmin"和"argmax"除外）；(2) 编码通道是latitude或longitude通道；或者 (3) 如果指定的比例尺类型是定量比例尺。

• 在以下情况下，"temporal"是默认类型：(1) 编码字段包含timeUnit；或 (2) 如果指定的比例尺类型是时间或 utc 比例尺。

• 在以下情况下，"ordinal"是默认类型：(1) 编码字段包含自定义排序顺序；(2) 如果指定的比例尺类型是序数/点/带状比例尺；或者 (3) 编码通道是order。

2. 对于数据域中的常量值（datum）

• 如果 datum 是数字，则为"quantitative"

• 如果 datum 是字符串，则为"nominal"

• 如果 datum 是日期时间对象，则为"temporal"

注意

• 数据type描述的是数据的语义，而不是基本数据类型（数字、字符串等）。相同的基础数据类型可以有不同的度量类型。例如，数值数据可以表示定量数据、有序数据或名义数据。

• 时间字段的数据值可以是日期时间字符串（例如，"2015-03-07 12:32:17", "17:01", "2015-03-16". "2015"）或时间戳数字（例如，1552199579097）。

• 与bin一起使用时，type属性可以是"quantitative"（用于线性分箱比例尺）或“ordinal”（用于序数分箱比例尺）。

• 与timeUnit一起使用时，type属性可以是"temporal"（默认，用于时间比例尺）或“ordinal”（用于序数比例尺）。

• 与aggregate一起使用时，type属性指的是聚合后的数据类型。例如，我们可以使用{"aggregate": "distinct", "field": "cat"}计算分类字段"cat"的distinct计数。聚合输出的"type"是"quantitative"。

• 次要通道（例如，x2, y2, xError, yError）没有type属性，因为它们的类型必须与其主要通道（例如，x, y）完全相同。

另请参见: type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, format=Undefined, formatType=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)

方法

__init__([shorthand, aggregate, ...])
返回对象的副本。	copy([deep, ignore])
从字典表示构建类。	from_dict(dct[, validate])
从有效的 JSON 字符串实例化对象。	from_json(json_string[, validate])
在此对象的 schema 或根 schema 上下文中解析引用。	resolve_references([schema])
返回对象的字典表示。	to_dict([validate, ignore, context])
将此对象的 JSON 表示作为字符串输出。	to_json([validate, indent, sort_keys, ...])
在根 schema 的上下文中，根据类 schema 验证实例。	validate(instance[, schema])
在根 schema 的上下文中，根据属性 schema 验证属性。	validate_property(name, value[, schema])

属性

aggregate	Aggregate schema wrapper。
bandPosition	堆叠、分箱、时间单位或带状比例尺上的带的相对位置。
bin	BinParams schema wrapper。
condition	一个或多个值定义，带有[参数或测试谓词](https://vega.github.io/vega-lite/docs/condition.html)。
field	Field schema wrapper。
format	当与默认的"number"和"time"格式类型一起使用时，用于指南（轴、图例、头部）标签和文本标记的文本格式模式。
formatType	标签的格式类型。
timeUnit	TimeUnit schema wrapper。
title	TitleParams schema wrapper。
type	Type schema wrapper。