Embed
Embutir é uma maneira simples de incluir o aplicativo em seu site. Adicione o seguinte código ao seu site:
<iframe src="https://web.butterfly.linwood.dev/embed" width="100%" height="500px" allowtransparency="true"></iframe>| Alternativa | Tipo | Padrão | Descrição |
|---|---|---|---|
| save | Boolean (true, false) | true | Habilitar salvamento. Se desativado, somente um botão de saída será mostrado |
| editable | true | Habilitar edição. Se desativado, o documento será somente leitura | |
| language | String (…, sistema, usuário) | system | Idioma do documento. Se o sistema, o idioma será detectado do navegador. Se o usuário, o idioma será ajustado para as preferências de usuários |
Eventos
Seção intitulada “Eventos”Exemplo de como usá-lo:
const embedElement = document.querySelector('#butterfly');embedElement.addEventListener('message', (data) => { if(data.detail.type === 'save') { console.log('Saving...', data.detail.message); }});O evento
saveé emitido quando o usuário clica no botão salvar.
Parâmetros:
dados(TipoList<int>): Os dados do documento.
O evento
exité emitido quando o usuário clica no botão de sair.
Parâmetros:
data(TipoList<int>): Os dados do documento.
O evento
changeé emitido quando o usuário altera o documento.
Parâmetros:
data(TipoList<int>): Os dados do documento.
Métodos
Seção intitulada “Métodos”Exemplo de como usá-lo:
const embedElement = document.querySelector('#butterfly');embedElement.pushMessage('getData', {});embedElement.addEventListener('message', (data) => { if(data.detail.type === 'getData') { console.log(data.detail.message); }});getData
Seção intitulada “getData”O método
getDataretorna os dados do documento.
Nenhum parâmetro.
Retorna: List<int>
setData
Seção intitulada “setData”O método
setDatadefine os dados do documento.
Parâmetros:
data(TipoList<int>): Os dados do documento.
O método
renderrenderiza o documento em uma imagem png.
Parâmetros:
width(TipoNumber): A largura da imagem.height(TipoNumber): A altura da imagem.scale(TipoNumber): A escala da imagem.renderBackground(TipoBoolean): Setrue, o fundo será renderizado.
Retorna: String (imagem codificada em Base64)
renderSVG
Seção intitulada “renderSVG”O método
renderSVGrenderiza o documento em uma imagem svg.
Parâmetros:
width(TipoNumber): A largura da imagem.height(TipoNumber): A altura da imagem.renderBackground(TipoBoolean): Setrue, o plano de fundo será renderizado.
Retorna: String (SVG)