Documentation Frappe Framework

Frappe Framework

API JavaScript

Ce chapitre est la référence de l’API JavaScript de Frappe Framework côté bureau (Desk) : scripts de formulaire, contrôles, listes, pages, dialogues, graphiques, appels serveur et journalisation.

1 min de lectureMis à jour le Source : docs.frappe.io

Contenu du chapitre

Ce chapitre est la référence de l’API JavaScript de Frappe Framework côté bureau (Desk) : scripts de formulaire, contrôles, listes, pages, dialogues, graphiques, appels serveur et journalisation.

Pages de ce chapitre, dans l’ordre de la documentation officielle :

  1. API développeur
  2. Scripts de formulaire
  3. Contrôles
  4. Liste
  5. API Page
  6. Arbre (Tree)
  7. Utilitaires communs
  8. API Dialog
  9. API Chart
  10. API Scanner
  11. Appels serveur (AJAX)
  12. Journalisation (Logging)
  13. Visites guidées de formulaire (Form Tours)

Dans ce chapitre

  1. 01API développeurCôté Python, presque tout est dans le module frappe. Côté JavaScript, l’objet frappe du bureau expose formulaires, pages et appels.
  2. 02Scripts de formulaireUn fichier {doctype}.js ou un Client Script de site. frm enregistre, soumet, ajoute un bouton et appelle une méthode en liste blanche.
  3. 03ContrôlesOn pose un contrôle hors formulaire avec make_control. Chaque fieldtype a ses options. Un formateur personnalise l’affichage des textes.
  4. 04ListePas de liste pour une table enfant ni un Single. Le fichier {doctype}_list.js ou un Client Script règle l’affichage.
  5. 05API PageLa page porte un titre, un indicateur, des boutons et une barre de champs. Les menus Actions et Menu se vident à part.
  6. 06Arbre (Tree)Dès qu’un DocType est un arbre, une vue arbre est générée. Un fichier JavaScript homonyme en personnalise les filtres, les nœuds et la barre.
  7. 07Utilitaires communsCinq fonctions du bureau lisent la route, la changent, formatent une valeur, préparent un espace de noms et chargent un asset.
  8. 08API DialogUne boîte se construit avec des champs et une action principale. new_doc ouvre un formulaire, ou la saisie rapide si elle est activée.
  9. 09API ChartRealtimeChart dessine un graphique SVG et y ajoute des points reçus par un événement temps réel, ou ajoutés à la main.
  10. 10API ScannerLe scanner ouvre la caméra pour lire un code-barres ou un QR, une fois ou en continu, et renvoie le texte décodé à on_scan.
  11. 11Appels serveur (AJAX)Le bureau interroge le serveur avec frappe.call et les raccourcis frappe.db : lire, lister, compter, insérer, modifier, supprimer.
  12. 12Journalisation (Logging)Chaque logger porte le module et le site. Le fichier va dans logs du bench et dans logs du site concerné.
  13. 13Visites guidées de formulaire (Form Tours)Une visite guidée explique un formulaire en quelques étapes. On la crée depuis l’AwesomeBar, puis on la démarre avec frm.tour.start.
API JavaScript Frappe : formulaires, dialogues, listes | ERPNext Lab