Документация Engee

Справка по API

Представляет значения данных с форматированием, которое должно применяться к надписям делений.

Специальный тип, который разбивает входящие данные на группы и упрощает создание сгруппированных графиков.

Представляет контурную или поверхностную сетку.

is_key_supported(key)

Проверяет, поддерживает ли пакет построения графиков атрибут key.

_apply_type_recipe(plotattributes, v::T, letter)

Применяет шаблон типа с сигнатурой (::Type{T}, ::T).

_process_plotrecipes!(plt, kw_list)

Берет первый в строке обрабатываемый элемент и передает его через apply_recipe для создания списка объектов RecipeData. Если шаблон графика был применен без ошибки, добавляются ключевые слова возвращаемого списка данных, в противном случае добавляются только исходные ключевые слова.

_process_seriesrecipes!(plt, kw_list)

Рекурсивно применяет шаблоны рядов до тех пор, пока бэкенд не будет поддерживать тип ряда.

_process_userrecipes(plt, plotattributes, args)

Заключает входные аргументы в вектор RecipeData' и рекурсивно применяет пользовательские шаблоны и шаблоны типов к первому элементу. Предваряет возвращаемый векторRecipeData. Если возвращается элемент с пустымargs, извлекает его из вектора, завершает и передает в векторDictс обработанными рядами. После обработки всех аргументов возвращаетDict` рядов.

add_series!(plt, kw)

Добавляет ряд, определенный kw, к объекту plot. Например, Plots обновляет аргументы текущего подграфика, расширяет экстремумы и отправляет ряды в список series_list plt.

get_axis_limits(plt, letter)

Получает ограничения для оси, указанной letter (:x, :y или :z) в plt. В случае ошибки используется tryrange из PlotUtils.

is3d(::Type{Val{:myseriestype}})

Возвращает true, если myseriestype представляет трехмерный ряд. В противном случае возвращает false.

is_axis_attribute(plt, attr)

Возвращает true, если attr является атрибутом оси, т. е. применяется к xattr, yattr и zattr. В противном случае возвращает false.

is_seriestype_supported(plt, st)

Проверяет, поддерживает ли пакет построения графиков тип ряда st.

is_subplot_attribute(plt, attr)

Возвращает true, если attr является атрибутом подграфика. В противном случае возвращает false.

is_surface(::Type{Val{:myseriestype}})

Возвращает true, если myseriestype представляет ряд поверхности. В противном случае возвращает false.

needs_3d_axes(::Type{Val{:myseriestype}})

Возвращает true, если myseriestype требуются трехмерные оси. В противном случае возвращает false.

plot_setup!(plt, plotattributes, kw_list)

Настраивает график, подграфики и макеты. Например, Plots создает фигуру бэкенда, инициализирует подграфики, расширяет экстремумы и связывает оси подграфиков.

postprocess_axis_args!(plt, plotattributes, letter)

Удаляет ключ :letter из plotattributes и так же добавляет буквы в начало, как и preprocess_axis_args!.

preprocess_attributes!(plt, plotattributes)

Здесь происходит любая предварительная обработка пользовательских или шаблонных входных данных, специфичная для пакета построения графиков. Например, Plots заменяет псевдонимы и расширяет особые аргументы.

preprocess_axis_args!(plt, plotattributes, letter)

В этой версии название буквы дополнительно сохраняется в plotattributes[:letter].

preprocess_axis_args!(plt, plotattributes)

Выполняет предварительную обработку атрибутов оси. По умолчанию добавляет букву оси в начало атрибутов оси.

process_sliced_series_attributes!(plt, kw_list)

Теперь все атрибуты рядов разрешаются корректно. Любое изменение kw_list перед применением шаблонов должно происходить здесь.

process_userrecipe!(plt, attributes_list, attributes)

Выполняет постобработку, специфичную для пакета построения графиков, и добавляет атрибуты рядов в список attributes*list. Например, Plots увеличивает количество рядов в plt, задает :series*plotindex в атрибутах и, возможно, добавляет новые атрибуты серий для полос погрешностей и сглаживания.

recipe_pipeline!(plt, plotattributes, args)

Рекурсивно применяет шаблоны пользователей, шаблоны типов, шаблоны графиков и шаблоны рядов для создания списка Dict, каждый из которых соответствует ряду. Сначала plotattributes содержит только именованные атрибуты, передаваемые пользователем. Затем добавляет все ряды в объект plot plt и возвращает его.

series_defaults(plt)

Возвращает Dict, хранящий значения по умолчанию для атрибутов рядов.

slice_series_attributes!(plt, kw_list, kw)

Для атрибутов, заданных в виде вектора с одним элементом на ряд, выбирается значение только для текущих рядов.

split_attribute(plt, key, val, indices)

Выбирает подходящие индексы из val для атрибута key.

splittable_attribute(plt, key, val, len)

Возвращает true, если атрибут key со значением val может быть разбит на группы, где группа задана в виде вектора длиной len. В противном случае возвращает false.

type_alias(plt, st)

Возвращает псевдоним типа ряда для st.

warn_on_recipe_aliases!(plt, plotattributes, recipe_type, args...)

Предупреждает, если в plotattributes обнаружен псевдоним после применения к шаблона типа recipe_type к 'args'. recipe_type является :user, :type, :plot или :series.