Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

agorum.metadata.collection.form

Mit dieser form verwenden Sie metadata collections (Sammlungen von Metadaten). Dadurch können Sie mehrere Elemente auf einmal angeben. Die metadata collections können Sie etwa für Rechnungen verwenden.

agorum.metadata.collection.form erbt alle grundlegenden Eigenschaften von agorum.composite.form.element.

Einfaches Beispiel


Dieses Beispiel zeigt eine Oberfläche, die eine metadata collection verwendet:

Einfaches Beispiel


Skript

let aguila = require('common/aguila');

aguila.create({
  type: 'agorum.metadata.collection.form',
  usage: 'form_no_date',
  collection: 'test_metadata_collection_06'
});

Die im Beispiel verwendete metadata collection finden Sie unter Beispiele für die metadata-collection.yml.

Komplexeres Beispiel 


Dieses Beispiel zeigt eine Oberfläche, die weitere forms verwendet:

Komplexeres Beispiel


Skript

let aguila = require('common/aguila');

let widget = aguila.create({
  type: 'agorum.composite.form.repeater',
  labelPosition: 'top',
  elements:  [
    // form für Anweisung und Beschreibung
    {
      type: 'agorum.composite.form.basic',
      elements: [
        {
          type: 'agorum.textDisplay',
          text: 'Tragen Sie hier die entsprechenden Werte ein:'
        },

        {
          type: 'agorum.composite.form.element.text',
          label: 'Beschreibung',
          name: 'description'
        }
      ]
    },
    // collection form für die Rechnungs-Metadaten
    {
      type: 'agorum.metadata.collection.form',
      usage: 'form',
      collection: 'test_metadata_collection_06'      
    },
    // form für Buttons
    {
      type: 'agorum.composite.form.basic',
      elements: [
        {
          type: 'agorum.spacer',
          height: 24
        },
        {
          type: 'agorum.hbox',
          items: [
            {
              type: 'agorum.spacer',
              flexible: true
            },
            {
              type: 'agorum.composite.form.element.button',
              name: 'finish',
              text: 'Ende',
              icon: 'aguila-icon check'
            }
          ]
        }
      ]
    }
  ]
});

widget.on('action', action => {
  console.log('button clicked', action);
});

widget.on('valueChanged', value => {
  console.log('resulting value', value);
});

widget;

Die im Beispiel verwendete metadata collection finden Sie unter Beispiele für die metadata-collection.yml.

Verpflichtende Parameter


usage

Definiert die Art der metadata collection (Verwendungszweck).

Im einfachen Beispiel erscheinen etwa durch diesen Parameter die Datumsfelder in der Oberfläche nicht. Im komplexeren Beispiel sind die Datumsfelder hingegen sichtbar.


Beispiel 1

usage: 'form', // die Standardsammlungen stehen zur Auswahl
Beispiel 1


Beispiel 2

usage: 'form_no_date', // nur die Sammlung Test Metadaten Sammlung 06 steht zur Auswahl
Beispiel 2


Beispiel 3

usage: '', // die Standardsammlungen stehen zur Auswahl, wenn Sie keine Angabe machen
Beispiel 3

collection

Umgeht die Auswahl der metadata collections, sodass Sie die gewünschte metadata collection direkt angeben können.

Die Felder der metadata collection erscheinen direkt beim Ausführen.

collection:'test_metadata_collection_06'

Optionale Parameter


Informationen zu den Parametern siehe agorum.composite.form - basic

Events


Alle Events unter agorum.composite.form - basic gelten.

Funktionen


validate()

Führt eine Validierung aller darunterliegenden Elemente durch und gibt das Ergebnis (true / false) zurück.