Embed
Incrustar es una forma sencilla de incluir la aplicación en tu sitio web. Añade el siguiente código a tu sitio web:
<iframe src="https://web.butterfly.linwood.dev/embed" width="100%" height="500px" allowtransparency="true"></iframe>Opciones
Sección titulada «Opciones»| Opción | Tipo | Por defecto | Descripción |
|---|---|---|---|
| guardar | Boolean (true, false) | true | Activar guardar. Si está desactivado, sólo se mostrará un botón de salida |
| editable | Boolean (true, false) | true | Activar la edición. Si está deshabilitado, el documento será de sólo lectura |
| idioma | Cadena (…, sistema, usuario) | system | Idioma del documento. Si el sistema, el idioma se detectará desde el navegador. Si el usuario, el idioma se ajustará a las preferencias de los usuarios |
Eventos
Sección titulada «Eventos»Ejemplos de cómo usarlo:
const embedElement = document.querySelector('#butterfly');embedElement.addEventListener('message', (data) => { if(data.detail.type === 'save') { console.log('Saving...', data.detail.message); }});guardar
Sección titulada «guardar»The
saveevent is emitted when the user clicks the save button.
Parámetros:
data(TypeList<int>): The data of the document.
The
exitevent is emitted when the user clicks the exit button.
Parámetros:
data(TypeList<int>): The data of the document.
The
changeevent is emitted when the user changes the document.
Parámetros:
data(TypeList<int>): The data of the document.
Métodos
Sección titulada «Métodos»Ejemplo de cómo usarlo:
const embedElement = document.querySelector('#butterfly');embedElement.pushMessage('getData', {});embedElement.addEventListener('message', (data) => { if(data.detail.type === 'getData') { console.log(data.detail.message); }});getData
Sección titulada «getData»The
getDatamethod returns the data of the document.
No hay parámetros.
Returns: List<int>
setData
Sección titulada «setData»The
setDatamethod sets the data of the document.
Parámetros:
data(TypeList<int>): The data of the document.
The
rendermethod renders the document to a png image.
Parámetros:
width(TypeNumber): The width of the image.height(TypeNumber): The height of the image.scale(TypeNumber): The scale of the image.renderBackground(TypeBoolean): If true, the background will be rendered.
Returns: String (Base64 encoded image)
renderSVG
Sección titulada «renderSVG»The
renderSVGmethod renders the document to a svg image.
Parámetros:
width(TypeNumber): The width of the image.height(TypeNumber): The height of the image.renderBackground(TypeBoolean): If true, the background will be rendered.
Returns: String (SVG)