Passer au contenu principal

Intégrer

Intégrer est un moyen simple d'inclure l'application dans votre site Web. Ajoute le code suivant à ton site web :

<iframe src="https://web.butterfly.linwood.dev/embed" width="100%" height="500px" allowtransparency="true"></iframe>

Options

OptionType de textePar défautLibellé
économiserBooléen (vrai, faux)vraiActiver la sauvegarde. Si désactivé, seul un bouton de sortie sera affiché
modifiableBooléen (vrai, faux)vraiActiver l'édition. Si désactivé, le document sera en lecture seule
LangueChaîne de caractères (..., système, utilisateur)systèmeLangue du document. Si le système, la langue sera détectée à partir du navigateur. Si l'utilisateur, la langue sera définie à la préférence des utilisateurs

Évènements

Exemples d'utilisation :

const embedElement = document.querySelector('#butterfly');
embedElement.addEventListener('message', (data) => {
if(data.detail.type === 'save') {
console.log('Sauvegarde...', data.detail.message);
}
});

économiser

L'événement save est émis lorsque l'utilisateur clique sur le bouton Enregistrer.

Paramètres:

  • données (Type Liste<int>) : Les données du document.

Sortir

L'événement exit est émis lorsque l'utilisateur clique sur le bouton de fermeture.

Paramètres:

  • données (Type Liste<int>) : Les données du document.

changer

L'événement change est émis lorsque l'utilisateur change le document.

Paramètres:

  • données (Type Liste<int>) : Les données du document.

Méthodes

Exemple d'utilisation :

const embedElement = document.querySelector('#butterfly');
embedElement.pushMessage('getData', {});
embedElement.addEventListener('message', (data) => {
if(data.detail.type === 'getData') {
console.log(data.detail.message);
}
});

getData

La méthode getData retourne les données du document.

Aucun paramètre. Renvoie : Liste<int>

définir les données

La méthode setData définit les données du document.

Paramètres:

  • données (Type Liste<int>) : Les données du document.

rendu

La méthode render rend le document à une image png.

Paramètres:

  • width (Type Number): La largeur de l'image.
  • height (Type Number): La hauteur de l'image.
  • échelle (Type Number) : L'échelle de l'image.
  • renderBackground (Type Boolean): Si vrai, l'arrière-plan sera affiché.

Renvoie : String (image encodée en Base64)

Raccourci SVG

La méthode renderSVG rend le document à une image svg.

Paramètres:

  • width (Type Number): La largeur de l'image.
  • height (Type Number): La hauteur de l'image.
  • renderBackground (Type Boolean): Si vrai, l'arrière-plan sera affiché.

Renvoie : String (SVG)