Vložit
Embedding is a simple way to include the app in your website. Add the following code to your website:
<iframe src="https://web.butterfly.linwood.dev/embed" width="100%" height="500px" allowtransparency="true"></iframe>Možnosti
Section titled “Možnosti”| Možnost | Typ | Výchozí | Popis |
|---|---|---|---|
| uložit | Boolean (true, false) | true | Enable save. If disabled, only an exit button will be shown |
| editable | Boolean (true, false) | true | Enable editing. If disabled, the document will be read-only |
| jazyk | Řetězec (…, systém, uživatel) | system | Language of the document. If system, the language will be detected from the browser. If user, the language will set to the users preference |
Události
Section titled “Události”Příklady jak je použít:
const embedElement = document.querySelector('#butterfly');embedElement.addEventListener('message', (data) => { if(data.detail.type === 'save') { console.log('Saving...', data.detail.message); }});uložit
Section titled “uložit”The
saveevent is emitted when the user clicks the save button.
Parametry:
data(TypeList<int>): The data of the document.
ukončit
Section titled “ukončit”The
exitevent is emitted when the user clicks the exit button.
Parametry:
data(TypeList<int>): The data of the document.
change
Section titled “change”The
changeevent is emitted when the user changes the document.
Parametry:
data(TypeList<int>): The data of the document.
Metody
Section titled “Metody”Příklad jak jej použít:
const embedElement = document.querySelector('#butterfly');embedElement.pushMessage('getData', {});embedElement.addEventListener('message', (data) => { if(data.detail.type === 'getData') { console.log(data.detail.message); }});getData
Section titled “getData”The
getDatamethod returns the data of the document.
No parameters.
Returns: List<int>
setData
Section titled “setData”The
setDatamethod sets the data of the document.
Parametry:
data(TypeList<int>): The data of the document.
render
Section titled “render”The
rendermethod renders the document to a png image.
Parametry:
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
Section titled “renderSVG”The
renderSVGmethod renders the document to a svg image.
Parametry:
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)