Plotly.io.to_template

Давайте углубимся.

Синтаксис функции

Функция предоставляет простой синтаксис, позволяющий сосредоточиться на коде. Синтаксис выражается следующим образом:

Параметры функции:

1. Fig — указывает объект фигуры, стиль которого вы хотите перенести в шаблон.
2. Пропустить — указывает набор имен свойств, которые вы хотите исключить при перемещении стиля в шаблон. По умолчанию включено только свойство title. Это предотвращает импорт текста рисунка, например, заголовков осей, другими рисунками.

Фигура возвращает копию фигуры со стилем, перемещенным в шаблон. Возвращаемый тип go.Figure.

Пример

Давайте проиллюстрируем, как мы можем использовать функцию to_templated() для экспорта стиля определенной фигуры в шаблон.

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

В этом примере мы создаем точечную диаграмму с пользовательским стилем текста, таким как семейство шрифтов, цвет шрифта, размер шрифта и т. д.

Приведенный выше код должен возвращать простую диаграмму рассеяния, как показано ниже:

Мы можем преобразовать эту фигуру в фигуру с шаблоном стиля, используя функцию to_template().

Пример кода показан ниже:

В приведенном выше коде мы начинаем с импорта модуля plotly io как io. Затем мы создаем копию фигуры со стилем, сохраненным в пользовательском шаблоне, с помощью функции to_templated().

Мы можем просмотреть шаблон, запустив код:

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

Вы можете отобразить фигуру, просто вызвав сохраненный шаблон как:

Это должно отображать фигуру, сохраненную в шаблоне.

Создайте фигуру с помощью шаблона

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

Пример кода показан ниже:

В приведенном выше примере мы начинаем с импорта модуля graph_objects из Plotly. В этом случае мы используем graph_objects, так как хотим создать пустую фигуру, но используем только стиль.

Используя функцию go.Figure(), мы передаем параметр макета и указываем целевой шаблон с помощью свойства «шаблон».

Затем мы можем отобразить полученную фигуру, вызвав new_fig. Это должно вернуть:

Обратите внимание, что рисунок выше не содержит данных или текста. Он включает только стили, такие как цвет текста, семейство шрифтов, размер шрифта и т. д.

Чтобы создать точечную диаграмму с помощью этого шаблона, мы можем использовать код, как показано ниже:

Приведенный выше пример должен возвращать фигуру, как показано ниже:

Обратите внимание, что цвет, семейство и размер шрифта аналогичны установленным в шаблоне.

Сохранение именованного шаблона

Мы можем сохранить пользовательский шаблон, используя объект шаблонов, как показано в коде ниже:

Приведенный выше код сохранит шаблон под именем «my_custom_template». Затем вы можете использовать это имя, чтобы указать шаблон, который вы хотите использовать:

Вывод

В этом уроке мы узнали, как создать фигуру со стилем, сохраненным в пользовательском шаблоне. Мы также рассмотрели, как использовать шаблон на других рисунках и сохранить шаблон для последующего использования.