altair.TopLevelUnitSpec
altair.TopLevelUnitSpec(data=Undefined, mark=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)
Обёртка схемы TopLevelUnitSpec.
Параметры
data—dict, Data, UrlData, Generator, NamedData, DataSource, InlineData, SphereGenerator, SequenceGenerator, GraticuleGenerator, NoneОбъект, описывающий источник данных. Задайте
null, чтобы игнорировать источник данных родительской спецификации. Если данные не заданы, они наследуются от родителя.mark—dict, Mark, AnyMark, BoxPlot, MarkDef, ErrorBar, ErrorBand, BoxPlotDef, ErrorBarDef, ErrorBandDef, CompositeMark, CompositeMarkDef, Literal['arc', 'area', 'bar', 'image', 'line', 'point', 'rect', 'rule', 'text', 'tick', 'trail', 'circle', 'square', 'geoshape', 'boxplot', 'errorband', 'errorbar']Строка с типом метки (
"bar","circle","square","tick","line","area","point","rule","geoshape"или"text") либо объект определения метки.align—dict, LayoutAlign, RowColLayoutAlign, Literal['all', 'each', 'none']Выравнивание строк и столбцов сетки:
"all","each","none".none— последовательное размещение соседних представлений.each— сетка с возможными различиями размеров строк и столбцов.all— сетка с одинаковыми размерами строк и столбцов по максимальному размеру; строка задаёт оба направления.
Объект
{"row": string, "column": string}позволяет задать разные правила для строк и столбцов.По умолчанию:
"all".autosize—dict, AutosizeType, AutoSizeParams, Literal['pad', 'none', 'fit', 'fit-x', 'fit-y']Способ определения размера визуализации. Строковое значение —
"pad","fit"или"none". Объект также позволяет задать параметры размера содержимого и автоматического изменения размеров.По умолчанию:
pad.background—str, dict, Color, ExprRef, HexColor, ColorName, Literal['black', 'silver', 'gray', 'white', 'maroon', 'red', 'purple', 'fuchsia', 'green', 'lime', 'olive', 'yellow', 'navy', 'blue', 'teal', 'aqua', 'orange', 'aliceblue', 'antiquewhite', 'aquamarine', 'azure', 'beige', 'bisque', 'blanchedalmond', 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey', 'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick', 'floralwhite', 'forestgreen', 'gainsboro', 'ghostwhite', 'gold', 'goldenrod', 'greenyellow', 'grey', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgray', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow', 'limegreen', 'linen', 'magenta', 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple', 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen', 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream', 'mistyrose', 'moccasin', 'navajowhite', 'oldlace', 'olivedrab', 'orangered', 'orchid', 'palegoldenrod', 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip', 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown', 'seagreen', 'seashell', 'sienna', 'skyblue', 'slateblue', 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'whitesmoke', 'yellowgreen', 'rebeccapurple']Цвет CSS для фона всей области отображения.
По умолчанию:
"white".bounds—Literal['full', 'flush']Способ вычисления границ панели:
full(по умолчанию) илиflush.fullучитывает все границы, включая оси, заголовок и легенду.flushучитывает только заданную ширину и высоту представления. Подходит для равномерной сетки панелей без осей и легенд.
По умолчанию:
"full".center—bool, dict, RowColbooleanЦентрировать ли представления относительно строк и столбцов. Объект
{"row": boolean, "column": boolean}задаёт разные значения по направлениям.По умолчанию:
false.config—dict, ConfigОбъект конфигурации Vega-Lite. Это свойство можно задавать только на верхнем уровне спецификации.
datasets—dict, DatasetsГлобальное хранилище именованных наборов данных: словарь, сопоставляющий имена встроенным наборам. Набор может быть массивом объектов или примитивных значений либо строкой. Примитивные значения из массивов считываются как объекты со свойством
data.description—strОписание метки, используемое как комментарий.
encoding—dict, FacetedEncodingСловарь, сопоставляющий каналам кодирования определения полей.
height—dict, float, Step, Literal['container']Высота визуализации.
- Если поле y непрерывное, высота должна быть числом.
- Если поле y дискретное или отсутствует, высоту можно задать числом для фиксированного размера либо объектом
{step: number}, определяющим высоту одного дискретного шага. Отсутствие поля y эквивалентно одному дискретному шагу. - Для адаптивной высоты используйте
"container".
Значение по умолчанию: определяется
config.view.continuousHeightдля непрерывного поля y иconfig.view.discreteHeightв остальных случаях.Примечание: для диаграмм с каналами
rowиcolumnзадаёт высоту одного представления; значение"container"недоступно.См. также: документация
height.name—strИмя визуализации для последующих ссылок на неё.
padding—dict, float, ExprRef, PaddingСтандартный отступ в пикселях от края холста визуализации до прямоугольной области данных. Число задаёт одинаковый отступ со всех сторон. Объект вида
{"left": 5, "top": 5, "right": 5, "bottom": 5}задаёт отступы отдельно.По умолчанию:
5.params—Sequence[dict, TopLevelParameter, VariableParameter, TopLevelSelectionParameter]Массив параметров: простых переменных или более сложных выделений, сопоставляющих действия пользователя запросам к данным.
projection—dict, ProjectionОбъект со свойствами географической проекции. Применяется к контуру
shapeметок"geoshape"и к каналамlatitudeиlongitudeостальных меток.resolve—dict, ResolveСогласование шкал, осей и легенд в спецификациях составных представлений.
spacing—dict, float, RowColnumberРасстояние между представлениями композиции в пикселях. Объект
{"row": number, "column": number}позволяет задать его отдельно для строк и столбцов.По умолчанию: свойство
spacingконфигурации композиции, обычно20.title—str, dict, Text, Sequence[str], TitleParamsЗаголовок диаграммы.
transform—Sequence[dict, Transform, BinTransform, FoldTransform, LoessTransform, PivotTransform, StackTransform, ExtentTransform, FilterTransform, ImputeTransform, LookupTransform, SampleTransform, WindowTransform, DensityTransform, FlattenTransform, QuantileTransform, TimeUnitTransform, AggregateTransform, CalculateTransform, RegressionTransform, JoinAggregateTransform]Массив преобразований данных, например фильтрации и вычисления новых полей.
usermeta—dict, DictНеобязательные метаданные, передаваемые в Vega. Vega и Vega-Lite полностью игнорируют этот объект; его можно использовать для пользовательских метаданных.
view—dict, ViewBackgroundОбъект, определяющий заливку и обводку фона представления.
Значение по умолчанию: отсутствует (прозрачный фон).
width—dict, float, Step, Literal['container']Ширина визуализации.
- Если поле x непрерывное, ширина должна быть числом.
- Если поле x дискретное или отсутствует, ширину можно задать числом для фиксированного размера либо объектом
{step: number}, определяющим ширину одного дискретного шага. Отсутствие поля x эквивалентно одному дискретному шагу. - Для адаптивной ширины используйте
"container".
Значение по умолчанию: определяется
config.view.continuousWidthдля непрерывного поля x иconfig.view.discreteWidthв остальных случаях.Примечание: для диаграмм с каналами
rowиcolumnзадаёт ширину одного представления; значение"container"недоступно.См. также: документация
width.$schema—strURL схемы JSON для спецификации Vega-Lite. Если нет причины менять его, используйте
https://vega.github.io/schema/vega-lite/v6.json. Свойство$schemaпозволяет автоматически проверять спецификацию и дополнять код в редакторах с поддержкой схем JSON.
Конструктор
__init__(data=Undefined, mark=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)
Методы
| Метод | Описание |
|---|---|
__init__ |
|
copy(deep, ignore) |
Возвращает копию объекта. |
from_dict(dct, validate) |
Создаёт экземпляр класса из представления в виде словаря. |
from_json(json_string, validate, **kwargs) |
Создаёт экземпляр объекта из корректной строки JSON. |
resolve_references(schema) |
Разрешает ссылки в контексте схемы объекта или корневой схемы. |
to_dict(validate, ignore, context) |
Возвращает представление объекта в виде словаря. |
to_json(validate, indent, sort_keys, ignore, …) |
Возвращает представление объекта в строке JSON. |
validate(instance, schema) |
Проверяет экземпляр по схеме класса в контексте корневой схемы. |
validate_property(name, value, schema) |
Проверяет свойство по его схеме в контексте корневой схемы. |