Plotly.io.to_templated

Plotly Io To Templated



En este artículo, aprenderemos cómo mover el estilo de una figura de Plotly a una plantilla específica usando la función to_templated()f. Luego puede usar la plantilla para diseñar otras figuras usando la propiedad de la plantilla.

Sumerjámonos.

Sintaxis de la función

La función proporciona una sintaxis simple que le permite concentrarse en el código. La sintaxis se expresa de la siguiente manera:







con trama este . a_templado ( higo , saltar = ( 'título' , 'texto' ) )

Los parámetros de la función son:



  1. Fig: especifica el objeto de figura cuyo estilo desea mover a una plantilla.
  2. Omitir: especifica una colección de nombres de las propiedades que desea excluir al mover el estilo a una plantilla. De forma predeterminada, solo se incluye la propiedad del título. Esto evita que el texto de la figura, como los títulos de los ejes, sea importado por otras figuras.

La figura devuelve una copia de la figura con el estilo movido a una plantilla. El tipo de retorno de go.Figure.



Ejemplo

Ilustremos cómo podemos usar la función to_templated() para exportar el estilo de una figura específica a una plantilla.





Comencemos creando una figura con un estilo personalizado. A continuación se muestra un código de ejemplo:

importar con trama Rápido como píxeles
d.f. = px. datos . iris ( )
higo = px. dispersión ( d.f. , X = 'sepal_longitud' , y = 'sepal_ancho' , color = 'especies' ,
título = 'Estilo personalizado' )
higo. actualizar_diseño (
Familia tipográfica = 'Courier New, monoespacio' ,
color de fuente = 'rojo' ,
tamaño de fuente = 18 ,
title_font_family = 'Times New Roman' ,
title_font_color = 'azul' ,
legend_title_font_color = 'verde'
)
higo. actualizar_xaxes ( title_font_family = 'arial' )
higo. mostrar ( )

En este ejemplo, creamos un diagrama de dispersión con estilo de texto personalizado, como familia de fuentes, color de fuente, tamaño de fuente, etc.



El código anterior debería devolver un diagrama de dispersión simple como se muestra:

Podemos convertir esta figura en una figura con una plantilla de estilo usando la función to_template().

Un código de ejemplo es el que se muestra:

importar con trama este como este

fig_templated = este. a_templado ( higo )

En el código anterior, comenzamos importando el módulo plotly io como io. Luego creamos una copia de la figura con el estilo guardado en una plantilla personalizada usando la función to_templated().

Podemos ver la plantilla ejecutando el código:

fig_templated. diseño . modelo

Esto debería devolver un diccionario con propiedades que definen el estilo de la figura. Un valor de salida de ejemplo es el que se muestra:

diseño. Modelo ( {

'datos' : { 'bar' : [ { 'error_x' : { 'color' : '#2a3f5f' } ,

'error_y' : { 'color' : '#2a3f5f' } ,

'marcador' : { 'línea' : { 'color' : '#E5ECF6' , 'ancho' : 0.5 } ,

'patrón' : { 'modo de relleno' : 'cubrir' , 'Talla' : 10 , 'solidez' : 0.2 } } ,

--------------------------------------------salida truncada---------- -------------------------------

Puede mostrar la figura simplemente llamando a la plantilla guardada como:

fig_templated

Esto debería mostrar la figura guardada en la plantilla.

Crear una figura con la plantilla

Una vez que hayamos guardado el estilo de una figura en una plantilla personalizada, podemos usar esa plantilla para aplicar el estilo a otra figura.

Un código de ejemplo es el que se muestra:

importar con trama objetos_gráficos Vamos
nuevo_higo = Vamos. Figura ( diseño = {
    'modelo' : fig_plantilla. diseño . modelo
} )
nuevo_higo

En el ejemplo anterior, comenzamos importando el módulo graph_objects de Plotly. En este caso, estamos usando graph_objects porque deseamos crear una figura vacía pero solo usamos el estilo.

Usando la función go.Figure(), pasamos el parámetro de diseño y especificamos la plantilla de destino usando la propiedad 'plantilla'.

Luego podemos mostrar la figura resultante llamando a new_fig. Esto debería devolver:


Tenga en cuenta que la figura anterior no contiene datos ni texto. Solo incluye el estilo, como el color del texto, la familia de fuentes, el tamaño de fuente, etc.

Para crear un diagrama de dispersión con esta plantilla, podemos usar el código como se muestra:

importar con trama objetos_gráficos Vamos
importar número np
norte = 1000
t = p.ej. espacio lineal ( 0 , 10 , 50 )
y = p.ej. sin ( t )

higo = Vamos. Figura ( datos = Vamos. Dispersión ( X = t , y = y , modo = 'marcadores' ) , diseño = {
    'modelo' : fig_plantilla. diseño . modelo
} )
higo. mostrar ( )

El ejemplo anterior debería devolver una figura como se muestra:

Tenga en cuenta que el color, la familia y el tamaño de la fuente son similares a los establecidos en la plantilla.

Guardar una plantilla con nombre

Podemos guardar la plantilla personalizada usando el objeto templates como se muestra en el siguiente código:

importar con trama este como este

este. plantillas [ 'mi_plantilla_personalizada' ] = fig_templated. diseño . modelo

El código anterior guardará la plantilla con el nombre 'my_custom_template'. A continuación, puede utilizar este nombre para especificar la plantilla que desea utilizar:

diseño = {

      'modelo' : 'mi_plantilla_personalizada'

}

Conclusión

En este tutorial, aprendimos a crear una figura con el estilo guardado en una plantilla personalizada. También cubrimos cómo usar la plantilla en otras figuras y cómo guardar la plantilla para su uso posterior.