altair.Stroke#

class altair.Stroke(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, legend=Undefined, scale=Undefined, sort=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

Stroke 模式封装器。

参数:
shorthandstr, dict, Sequence[str], RepeatRef

字段、聚合和类型的简写

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 (无)

另请参阅: aggregate 文档。

bandPositionfloat

在堆叠、分箱、时间单位或带状刻度的带上的相对位置。例如,如果设置为 0,标记将定位在带的起始位置;如果设置为 0.5,则定位在带的中间。

binbool, dict, BinParams, None

一个标志,用于对quantitative字段进行分箱,一个定义分箱参数的对象,或指示xy通道的数据在导入 Vega-Lite 之前已经分箱("binned")。

  • 如果为true,将应用默认分箱参数

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

默认值: false

另请参阅: bin 文档。

conditiondict, ConditionalValueDefGradientstringnullExprRef, ConditionalParameterValueDefGradientstringnullExprRef, ConditionalPredicateValueDefGradientstringnullExprRef, Sequence[dict, ConditionalValueDefGradientstringnullExprRef, ConditionalParameterValueDefGradientstringnullExprRef, ConditionalPredicateValueDefGradientstringnullExprRef]

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

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

fieldstr, dict, Field, FieldName, RepeatRef

必需。定义从中提取数据值的字段名称的字符串,或定义来自repeat操作符的迭代值对象。

另请参阅: field 文档。

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

legenddict, Legend, None

定义图例属性的对象。如果为null,则将移除该编码通道的图例。

默认值:如果未定义,则应用默认图例属性

另请参阅: legend 文档。

scaledict, Scale, None

定义通道刻度属性的对象,刻度是将数据域(数字、日期、字符串等)中的值转换为编码通道的可视值(像素、颜色、大小)的函数。

如果为null,刻度将被禁用,数据值将被直接编码

默认值:如果未定义,则应用默认刻度属性

另请参阅: scale 文档。

sortdict, Sort, Sequence[str], Sequence[bool], Sequence[float], SortArray, SortOrder, AllSortString, SortByChannel, SortByEncoding, EncodingSortField, SortByChannelDesc, Sequence[dict, DateTime], Literal[‘-x’, ‘-y’, ‘-color’, ‘-fill’, ‘-stroke’, ‘-strokeWidth’, ‘-size’, ‘-shape’, ‘-fillOpacity’, ‘-strokeOpacity’, ‘-opacity’, ‘-text’, ‘ascending’, ‘descending’, ‘x’, ‘y’, ‘color’, ‘fill’, ‘stroke’, ‘strokeWidth’, ‘size’, ‘shape’, ‘fillOpacity’, ‘strokeOpacity’, ‘opacity’, ‘text’], None

编码字段的排序顺序。

对于连续字段(定量或时间),sort可以是"ascending"(升序)或"descending"(降序)。

对于离散字段,sort可以是以下之一:

  • "ascending"(升序)或"descending"(降序)– 根据值在 JavaScript 中的自然顺序进行排序。

  • 一个字符串,指示按哪个编码通道名称进行排序(例如,"x""y"),可选地带一个负号前缀表示降序排序(例如,"-x" 表示按 x 字段降序排序)。此通道字符串是sort-by-encoding 定义的简写形式。例如,"sort": "-x" 等同于 "sort": {"encoding": "x", "order": "descending"}

  • 一个排序字段定义,用于按另一个字段进行排序。

  • 一个指定字段值首选顺序的数组。在这种情况下,排序顺序将遵循数组中的值,然后是任何未指定值的原始顺序。对于离散时间字段,排序数组中的值可以是日期时间定义对象。此外,对于时间单位"month""day",值可以是月份或日期的名称(不区分大小写)或其 3 个字母的缩写(例如,"Mon""Tue")。

  • null 表示不排序。

默认值: "ascending"

注意: null 和按另一个通道排序不支持用于rowcolumn

另请参阅: sort 文档。

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’, ‘year’, ‘quarter’, ‘month’, ‘week’, ‘day’, ‘dayofyear’, ‘date’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’, ‘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’]

时间字段的时间单位(例如,yearyearmonthmonthhours),或者被强制转换为序数的时间字段。

默认值: undefined (无)

另请参阅: timeUnit 文档。

titlestr, Text, Sequence[str], None

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

默认值:从字段名称和转换函数(aggregatebintimeUnit)派生。如果字段有聚合函数,该函数将作为标题的一部分显示(例如,"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)字段不是名义类型,且字段编码没有指定aggregateargminargmax 除外)、bin、刻度类型、自定义sort顺序或timeUnit;或者(2)如果您希望对带有bintimeUnit的字段使用序数刻度。

默认值

1) 对于数据field"nominal"是默认数据类型,除非字段编码具有满足以下条件的aggregatechannelbin、刻度类型、sorttimeUnit

  • "quantitative"是默认类型,如果 (1) 编码字段包含binaggregate"argmin""argmax"除外),(2) 编码通道是latitudelongitude通道,或者 (3) 如果指定的刻度类型是定量刻度

  • "temporal"是默认类型,如果 (1) 编码字段包含timeUnit,或者 (2) 指定的刻度类型是时间或 utc 刻度。

  • "ordinal"是默认类型,如果 (1) 编码字段包含自定义排序顺序,(2) 指定的刻度类型是序数/点/带状刻度,或者 (3) 编码通道是order

  1. 对于数据域中的常数值(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"

  • 次级通道(例如,x2y2xErroryError)没有type,因为它们的类型必须与其主通道(例如,xy)完全相同。

另请参阅: type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, legend=Undefined, scale=Undefined, sort=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

__init__([shorthand, aggregate, ...])

copy([deep, ignore])

返回对象的副本。

from_dict(dct[, validate])

从字典表示构建类。

from_json(json_string[, validate])

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

resolve_references([schema])

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

to_dict([validate, ignore, context])

返回对象的字典表示。

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

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

validate(instance[, schema])

在根模式的上下文中根据类模式验证实例。

validate_property(name, value[, schema])

在根模式的上下文中根据属性模式验证属性。

属性

aggregate

Aggregate 模式封装器。

bandPosition

在堆叠、分箱、时间单位或带状刻度的带上的相对位置。

bin

BinParams 模式封装器。

condition

一个或多个带有[参数或测试谓词](https://vega.github.io/vega-lite/docs/condition.html)的值定义。

field

Field 模式封装器。

legend

Legend 模式封装器。

scale

Scale 模式封装器。

sort

Sort 模式封装器。

timeUnit

TimeUnit 模式封装器。

title

TitleParams 模式封装器。

type

Type 模式封装器。