Plotly.io.to_html

Por lo tanto, no sorprende que necesite convertir una figura específica de Plotly en una cadena HTML.

En este tutorial, aprenderemos cómo usar el módulo Plotly io para convertir una figura en una representación de cadena HTML.

Sumerjámonos.

Función plotly.io.to_html()

La función to_html() del módulo io de Plotly le permite pasar una figura específica como parámetro y convertirla en una cadena HTML.

La sintaxis de la función se expresa como se muestra a continuación:

Exploremos los parámetros de la función, a continuación:

1. Fig: se refiere al objeto de figura o la representación de diccionario de la figura.
2. Config: especifica las opciones de configuración de plotly.js. Pasa las opciones de configuración como un diccionario.
3. Auto_play: determina si la secuencia de animación debe reproducirse automáticamente al cargar la página. Este parámetro es útil si tiene una figura que contiene fotogramas animados.
4. Include_plotlyjs: este parámetro especifica cómo se incluye la biblioteca plotly.js en el HTML. Los valores aceptados en este parámetro incluyen:
   • Verdadero: incluye la biblioteca plotly.js como una etiqueta de secuencia de comandos en el documento HTML. Esto aumentará el tamaño del archivo pero permitirá que el archivo se use en entornos fuera de línea.
   • 'cdn': establecer el parámetro include_plotlyjs en 'cdn' agregará una etiqueta de secuencia de comandos que apunta a un enlace remoto para la biblioteca plotly.js. Utilice esta opción cuando se encuentre en un entorno de red o en un entorno sensible al tamaño del archivo.
   • 'directorio': incluye una etiqueta de secuencia de comandos que apunta a un paquete externo plotly.min.js ubicado en el mismo directorio que el documento HTML.
   • 'requerir': establecer el valor para requerir cargará la biblioteca plotly.js usando require.js. Asegúrese de que require.js esté instalado y disponible globalmente en el sistema.
   • 'Falso': no ​​incluye la biblioteca plotly.js. Evite este valor cuando establezca el parámetro full_html en True, ya que hará que todo el documento quede inutilizable.
5. include_mathjax: especifica si el archivo debe incluir la biblioteca mathjax.js. Los valores aceptados son similares a include_plotlyjs excepto el valor 'requerir'.
6. Post_script: le permite incluir fragmentos de JavaScript que se ejecutan después de la creación de la trama.
7. Full_html: si es verdadero, la función devolverá una cadena que contiene el documento HTML completo, comenzando con las etiquetas . Si es falso, la función devolverá una cadena HTML que comienza con el elemento
   .
8. Animation_opts: le permite especificar propiedades de animación personalizadas como un diccionario. Estos valores luego se pasan a la función plotly.animate en plotly.js.
9. Default_width: especifica el ancho predeterminado de la figura resultante en píxeles.
10. Default_height: especifica la altura predeterminada de la figura en píxeles.
11. Validar: determina si la figura debe validarse antes de convertirse en una cadena HTML.
12. Div_id: especifica un valor del atributo id de la etiqueta div donde se encuentra el gráfico.

Luego, la función devuelve una representación de cadena de la figura como una cadena.

Ejemplo de uso

El siguiente código muestra cómo usar la función to_html para convertir una figura en una representación de cadena HTML.

En el ejemplo anterior, comenzamos importando el módulo Plotly express como px. Luego creamos un marco de datos utilizando los datos de stock de Plotly.

Finalmente, creamos una gráfica de área facetada usando la función px.area. Esto debería devolver una figura como se muestra a continuación:

Podemos convertir la figura anterior en una representación de cadena HTML como se muestra en el siguiente código:

Ejecutar el código anterior debería devolver una cadena HTML masiva como se muestra en la siguiente captura de pantalla:

Tenga en cuenta que el documento HTML comienza en el elemento