Plotly.io.to_html

Plotly Io To Html

Hypertext Markup Language ou documentos HTML são documentos de marcação que permitem exibir informações na World Wide Web. Ao visualizar um site específico, você está usando um documento HTML.

Portanto, não é surpresa que você precise converter uma figura específica do Plotly em uma string HTML.

Neste tutorial, aprenderemos como usar o módulo Plotly io para converter uma figura em uma representação de string HTML.



Vamos mergulhar.



Função Plotly.io.to_html()

A função to_html() do módulo io do Plotly permite passar uma figura específica como parâmetro e convertê-la em uma string HTML.



A sintaxe da função é expressa como mostrado abaixo:

tramamente. isto . to_html ( FIG , configuração = Nenhum , Reprodução automática = Verdadeiro , include_plotlyjs = Verdadeiro , include_mathjax = Falso , post_script = Nenhum , full_html = Verdadeiro , animação_opts = Nenhum , largura_padrão = '100%' , altura_padrão = '100%' , validar = Verdadeiro , div_id = Nenhum )

Vamos explorar os parâmetros da função, abaixo:

  1. Fig – refere-se ao objeto figura ou à representação do dicionário da figura.
  2. Config – especifica as opções de configuração do plotly.js. Passe as opções de configuração como um dicionário.
  3. Auto_play – determina se a sequência de animação deve ser reproduzida automaticamente no carregamento da página. Este parâmetro é útil se você tiver uma figura contendo quadros animados.
  4. Include_plotlyjs – este parâmetro especifica como a biblioteca plotly.js é incluída no HTML. Os valores aceitos neste parâmetro incluem:
    • True – inclui a biblioteca plotly.js como uma tag de script no documento HTML. Isso aumentará o tamanho do arquivo, mas permitirá que o arquivo seja usado em ambientes offline.
    • ‘cdn’ – definir o parâmetro include_plotlyjs para ‘cdn’ adicionará uma tag de script apontando para um link remoto para a biblioteca plotly.js. Use esta opção quando estiver em um ambiente de rede ou ambiente sensível ao tamanho do arquivo.
    • 'diretório' – inclui uma tag de script que aponta para um pacote externo plotly.min.js localizado no mesmo diretório que o documento HTML.
    • ‘require’ – definir o valor para require carregará a biblioteca plotly.js usando require.js. Certifique-se de que o require.js esteja instalado e disponível globalmente no sistema.
    • ‘False’ – não inclui a biblioteca plotly.js. Evite esse valor ao definir o parâmetro full_html como True, pois ele tornará o documento inteiro inutilizável.
  5. include_mathjax – especifica se o arquivo deve incluir a biblioteca mathjax.js. Os valores aceitos são semelhantes a include_plotlyjs, exceto o valor 'require'.
  6. Post_script – permite incluir trechos de JavaScript que são executados após a criação do gráfico.
  7. Full_html – se true, a função retornará uma string contendo todo o documento HTML, começando com as tags . Se false, a função retornará uma string HTML começando com o elemento
    .
  8. Animation_opts – permite especificar propriedades de animação personalizadas como um dicionário. Esses valores são então passados ​​para a função plotly.animate em plotly.js.
  9. Default_width – especifica a largura padrão da figura resultante em pixels.
  10. Default_height – especifica a altura padrão da figura em pixels.
  11. Validate – determina se a figura deve ser validada antes de ser convertida em uma string HTML.
  12. Div_id – especifica um valor do atributo id da tag div onde o gráfico está localizado.

Em seguida, a função retorna uma representação de string da figura como uma string.



Exemplo de uso

O código a seguir mostra como usar a função to_html para converter uma figura em uma representação de string HTML.

importar tramamente. expressar Como px

df = px. dados . ações ( indexado = Verdadeiro )

FIG = px. área ( df , facet_col = 'companhia' , facet_col_wrap = dois )

FIG. mostrar ( )

No exemplo acima, começamos importando o módulo Plotly express como px. Em seguida, criamos um quadro de dados usando os dados de estoque do Plotly.

Finalmente, criamos um gráfico de área facetada usando a função px.area. Isso deve retornar uma figura como mostrado abaixo:

Podemos converter a figura acima em uma representação de string HTML, conforme mostrado no código abaixo:

importar tramamente. isto Como isto

isto. to_html ( FIG , full_html = Falso )

A execução do código acima deve retornar uma string HTML enorme, conforme mostrado na captura de tela abaixo:

Observe que o documento HTML começa no elemento

. Se você quiser incluir todo o arquivo HTML, defina o parâmetro full_html=True conforme mostrado:

importar tramamente. isto Como isto

isto. to_html ( FIG , full_html = Verdadeiro )

Observe que a marcação começa na tag .

Para incluir plotly.js, podemos definir o parâmetro como:

importar tramamente. isto Como isto

isto. to_html ( FIG , include_plotlyjs = 'cdn' , full_html = Verdadeiro )

No exemplo acima, informamos à função para incluir a biblioteca plotly.js por meio de um link CDN.

Podemos verificar isso na saída abaixo:

A melhor maneira de usar o documento to_html é exportando a string HTML para um arquivo HTML.

Podemos fazer isso executando um código simples como mostrado abaixo:

importar tramamente. isto Como isto

com abrir ( 'facetado.html' , 'dentro' ) Como f:

f. linhas de escrita ( isto. to_html ( FIG , include_plotlyjs = 'cnd' , full_html = Verdadeiro ) )

Neste exemplo, usamos o módulo de arquivo em Python para escrever a string HTML como um arquivo N html.

Podemos então abrir o documento HTML no navegador e visualizar a figura como mostrado:

Conclusão

Parabéns, você exportou com sucesso sua figura Plotly como uma string HTML usando a função plotly.io.to_html.