Plotly.io.to_html

Plotly Io To Html



Les documents Hypertext Markup Language ou HTML sont des documents de balisage qui vous permettent d'afficher des informations sur le World Wide Web. Lorsque vous consultez un site Web spécifique, vous utilisez un document HTML.

Il n'est donc pas surprenant que vous deviez convertir une figure Plotly spécifique en une chaîne HTML.

Dans ce tutoriel, nous allons apprendre à utiliser le module Plotly io pour convertir une figure en une représentation sous forme de chaîne HTML.







Plongeons dedans.



Fonction Plotly.io.to_html()

La fonction to_html() du module io de Plotly vous permet de passer un chiffre spécifique en paramètre et de le convertir en une chaîne HTML.



La syntaxe de la fonction est exprimée comme indiqué ci-dessous :





complot. cette . to_html ( figure , configuration = Aucun , lecture automatique = Vrai , include_plotlyjs = Vrai , include_mathjax = Faux , post_script = Aucun , full_html = Vrai , animation_opts = Aucun , default_width = '100%' , default_height = '100%' , valider = Vrai , div_id = Aucun )

Explorons les paramètres de la fonction, ci-dessous :

  1. Fig - fait référence à l'objet figure ou à la représentation du dictionnaire de la figure.
  2. Config – spécifie les options de configuration de plotly.js. Passez les options de configuration sous forme de dictionnaire.
  3. Auto_play - détermine si la séquence d'animation doit être lue automatiquement lors du chargement de la page. Ce paramètre est utile si vous avez une figure contenant des cadres animés.
  4. Include_plotlyjs – ce paramètre spécifie comment la bibliothèque plotly.js est incluse dans le HTML. Les valeurs acceptées dans ce paramètre incluent :
    • Vrai – inclut la bibliothèque plotly.js en tant que balise de script dans le document HTML. Cela augmentera la taille du fichier mais permettra au fichier d'être utilisé dans des environnements hors ligne.
    • 'cdn' - définir le paramètre include_plotlyjs sur 'cdn' ajoutera une balise de script pointant vers un lien distant pour la bibliothèque plotly.js. Utilisez cette option dans un environnement en réseau ou dans un environnement sensible à la taille des fichiers.
    • 'répertoire' - inclut une balise de script qui pointe vers un ensemble plotly.min.js externe situé dans le même répertoire que le document HTML.
    • 'require' - définir la valeur sur require chargera la bibliothèque plotly.js à l'aide de require.js. Assurez-vous que require.js est installé et disponible globalement sur le système.
    • 'False' - n'inclut pas la bibliothèque plotly.js. Évitez cette valeur lorsque vous définissez le paramètre full_html sur True car cela rendra le document entier inutilisable.
  5. include_mathjax - spécifie si le fichier doit inclure la bibliothèque mathjax.js. Les valeurs acceptées sont similaires à include_plotlyjs à l'exception de la valeur 'require'.
  6. Post_script - vous permet d'inclure des extraits de code JavaScript qui sont exécutés après la création du tracé.
  7. Full_html - si vrai, la fonction renverra une chaîne contenant le document HTML entier, en commençant par les balises . Si false, la fonction renverra une chaîne HTML commençant par l'élément
    .
  8. Animation_opts - vous permet de spécifier des propriétés d'animation personnalisées sous forme de dictionnaire. Ces valeurs sont ensuite transmises à la fonction plotly.animate dans plotly.js.
  9. Default_width - spécifie la largeur par défaut de la figure résultante en pixels.
  10. Default_height – spécifie la hauteur par défaut de la figure en pixels.
  11. Valider – détermine si la figure doit être validée avant d'être convertie en chaîne HTML.
  12. Div_id - spécifie une valeur de l'attribut id de la balise div où se trouve le tracé.

Ensuite, la fonction renvoie une représentation sous forme de chaîne de la figure sous forme de chaîne.



Exemple d'utilisation

Le code suivant montre comment utiliser la fonction to_html pour convertir une figure en une représentation sous forme de chaîne HTML.

importer complot. Express comme pixels

df = px. Les données . actions ( indexé = Vrai )

figure = px. Région ( df , facette_col = 'compagnie' , facet_col_wrap = deux )

figue. Afficher ( )

Dans l'exemple ci-dessus, nous commençons par importer le module Plotly express au format px. Nous créons ensuite un bloc de données en utilisant les données de stock de Plotly.

Enfin, nous créons un graphique à facettes à l'aide de la fonction px.area. Cela devrait renvoyer un chiffre comme indiqué ci-dessous :

Nous pouvons convertir la figure ci-dessus en une représentation sous forme de chaîne HTML, comme indiqué dans le code ci-dessous :

importer complot. cette comme cette

cette. to_html ( figure , full_html = Faux )

L'exécution du code ci-dessus devrait renvoyer une chaîne HTML massive, comme indiqué dans la capture d'écran ci-dessous :

Notez que le document HTML commence à l'élément

. Si vous souhaitez inclure l'intégralité du fichier HTML, définissez le paramètre full_html=True comme indiqué :

importer complot. cette comme cette

cette. to_html ( figure , full_html = Vrai )

Notez que le balisage commence à la balise .

Pour inclure plotly.js, nous pouvons définir le paramètre comme :

importer complot. cette comme cette

cette. to_html ( figure , include_plotlyjs = 'cdn' , full_html = Vrai )

Dans l'exemple ci-dessus, nous indiquons à la fonction d'inclure la bibliothèque plotly.js via un lien CDN.

Nous pouvons vérifier cela à partir de la sortie ci-dessous :

La meilleure façon d'utiliser le document to_html consiste à exporter la chaîne HTML dans un fichier HTML.

Nous pouvons le faire en exécutant un code simple comme indiqué ci-dessous :

importer complot. cette comme cette

avec ouvert ( 'facettes.html' , 'dans' ) comme F:

F. lignes d'écriture ( cette. to_html ( figure , include_plotlyjs = 'cnd' , full_html = Vrai ) )

Dans cet exemple, nous utilisons le module file en Python pour écrire la chaîne HTML sous la forme d'un fichier html N.

Nous pouvons ensuite ouvrir le document HTML dans le navigateur et afficher la figure comme indiqué :

Conclusion

Félicitations, vous avez réussi à exporter votre figure Plotly sous forme de chaîne HTML à l'aide de la fonction plotly.io.to_html.