altair.Text#
- class altair.Text(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, format=Undefined, formatType=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#
文本模式封装。
- 参数:
- 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,
ConditionalValueDefTextExprRef
,ConditionalParameterValueDefTextExprRef
,ConditionalPredicateValueDefTextExprRef
, Sequence[dict,ConditionalValueDefTextExprRef
,ConditionalParameterValueDefTextExprRef
,ConditionalPredicateValueDefTextExprRef
] 一个或多个带有参数或测试谓词的值定义。
注意: 字段定义的
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"
(时间)格式类型一起使用时,用于指南(轴、图例、标题)标签和文本标记的文本格式模式。有关更多示例,请参阅format 文档。
与自定义 formatType 一起使用时,此值将作为
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’, ‘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’] 时间字段的时间单位(例如,
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属性或通过编译函数的选项提供 fieldTitle 函数来自定义默认字段标题格式。
2) 如果同时定义了字段定义的
title
和轴、标题或图例的title
,将使用轴/标题/图例的标题。- type
StandardType
, 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
,默认数据类型是"nominal"
,除非字段编码具有满足以下条件的aggregate
、channel
、bin
、比例尺类型、sort
或timeUnit
如果出现以下情况,
"quantitative"
(定量)是默认类型:(1) 编码字段包含bin
或aggregate
("argmin"
和"argmax"
除外),(2) 编码通道是latitude
或longitude
通道,或者 (3) 如果指定的比例尺类型是定量比例尺。如果出现以下情况,
"temporal"
(时间)是默认类型:(1) 编码字段包含timeUnit
,或者 (2) 如果指定的比例尺类型是时间或utc比例尺。如果出现以下情况,
"ordinal"
(有序)是默认类型:(1) 编码字段包含自定义排序顺序,(2) 指定的比例尺类型是有序/点/带状比例尺,或者 (3) 编码通道是order
。
对于数据域中的常量值(
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 文档。
- shorthandstr, dict, Sequence[str],
- __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])从字典表示构造类。
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 模式封装。
format
与默认的“number”(数字)和“time”(时间)格式类型一起使用时,用于指南(轴、图例、标题)标签和文本标记的文本格式模式。
formatType
标签的格式类型。
timeUnit
TimeUnit 模式封装。
title
TitleParams 模式封装。
type
Type 模式封装。