Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Explorer-Darstellung anpassen (agorum.explorer)

Das Widget agorum.explorer steuert, wie Ordner und Dateien angezeigt werden, wenn Sie im Navigationsbaum im Explorer einen Ordner auswählen. Mithilfe des Widgets können Sie etwa steuern,

Verwendung

Wenn Sie den Explorer ohne weitere Einstellungen aufrufen, werden alle vorhandenen Wurzelordner angezeigt.

Explorer-Anzeige ohne Einschränkungen

Sie verwenden das Widget agorum.explorer wie folgt, um zu steuern, welche Ordner angezeigt werden:

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

let widget = aguila.create({
  type: 'agorum.explorer',
  // --- Properties
  // UUID des geöffneten Ordners (wird konvertiert, wenn nötig)
  id: '/agorum/roi/Files/Demo/Projekte',
  roots: ['/agorum/roi/Files/Demo'],
});
widget;

Die Property roots dient dazu, einen oder mehrere Ordner anzugeben, die in der Navigation als Wurzelordner angezeigt werden. Die id steuert, welcher Ordnerinhalt angezeigt wird. In diesem Beispiel ist der Wurzelordner für die Navigation der Ordner Demo, im Detailfenster werden die Inhalte aus dem Unterordner Projekte angezeigt. Alternativ können Sie auch mit config einen smart assistant konfigurator-Einsprungspunkt als Wurzelordner festlegen.

Beispiel für die Verwendung von agorum.explorer

Properties und Parameter

Sie können den Explorer-Aufruf durch folgende Eigenschaften anpassen. Diese Eigenschaften können nachträglich durch den Benutzer geändert werden.

Eigenschaft Beschreibung Mögliche Werte
id Gibt den Ordner an, dessen Inhalt angezeigt wird. Die Angabe ist optional. Pfad oder ID des Ordners
roots Gibt einen oder mehrere Ordner an, die als Wurzelordner im Navigationsbaum angezeigt werden. Die Angabe ist optional. Array von Ordnerangaben (Pfade oder IDs der Ordner) 
roots: ['/agorum/roi/Files/Demo', '/agorum/roi/Files/DemoWorkflows'],
sort Initiale Sortierung der Objekte in der Anzeigeliste. Der Benutzer kann die Sortierung verändern. Sie können mehrere Sortierkriterien angeben, die in absteigender Reihenfolge angewendet werden. Die Angabe ist optional. Array von Sortierangaben bestehend aus dem Sortierkriterium und der Sortierreihenfolge 
  sort: [
    {
      property: 'name',
      descending: true,
    },
  ],
view Definiert optional Kriterien für die Anzeige der Ordnerdetails über Suchkritieren. Die Suchkritieren werden für baseQuery angegeben 
  view: {
    type: 'search',
    // zusätzlich immer eingeschränkt über inpath_uuid:<id>
    baseQuery: 'isfolder:false',
  },
displayName Anzeigename des Ordners - (nur lesbar)
selection Informationen zu den Selektionskriterien. - (nur lesbar)

Zusätzlich können Sie folgende Parameter angeben, die nachträglich nicht geändert werden können.

Parameter Beschreibung Mögliche Werte
config Verweist auf einen smart assistant konfigurator-Einsprungspunkt. Name des Einsprungspunkts wie in smart assistant konfigurator definiert
initiallyVisibleDepth Definiert die Anzahl der Ordnerebenen, die im Navigationsbaum angezeigt werden.

Hinweis: Die Einstellung sollte nur nach sorgfältiger Prüfung auf 1 oder höher gesetzt werden. Abhängig von der Zahl der enthaltenen Objekte kann es zu Performance-Einbußen kommen.

 Ganzzahl, Standardwert: 0
noHistory Gibt an, dass die Benutzerhistorie nicht beim Öffnen der Ansicht berücksichtigt werden soll. Boolescher Wert, Standardwert: false
showDetails Legt fest, dass das Detailfenster zusätzlich zum Ordnerinhalt angezeigt wird. Boolescher Wert, Standardwert: false

Beispiele

Beispiel: Anzeige des Detailfensters

Sie können durch Angabe von showDetails steuern, dass das Detailfenster angezeigt wird.

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

let widget = aguila.create({
  type: 'agorum.explorer',
  // --- Properties
  // UUID des geöffneten Ordners (wird konvertiert, wenn nötig)
  id: '/agorum/roi/Files/Demo',
  roots: ['/agorum/roi/Files'],
  // --- Parameter
  showDetails: true,
});
widget;

 

Explorer-Anzeige mit Detailfenster

Beispiel: Einschränkung der Anzeige in den Ordnerdetails

Sie können die Anzeige der Ordnerdetails anpassen, indem Sie die Suche anpassen. In diesem Beispiel werden Ordner nicht in den Ordnerdetails angezeigt, sondern nur die beiden vorhandenen Dateien:

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

let widget = aguila.create({
  type: 'agorum.explorer',
  // --- Properties
  // UUID des geöffneten Ordners (wird konvertiert, wenn nötig)
  id: '/agorum/roi/Files/Demo',
  roots: ['/agorum/roi/Files'],
  view: {
    type: 'search',
    // zusätzlich immer eingeschränkt über inpath_uuid:<id>
    baseQuery: 'isfolder:false',
  }
});
widget;

 

Explorer mit Ordnerinhalt-Anzeige ohne Unterordner

 

Beispiel: Verwendung von agorum.explorer in einer Form

Das Widget agorum.explorer kann in einer Form verwendet werden, etwa wie folgt:

let aguila = require('common/aguila');
let form = aguila.create({
  type: 'agorum.border',
  width: 600,
  height: 400,
  docked: {
    top: {
      type: 'agorum.toolBar',
      items: [
        {
          type: 'agorum.button',
          text: '',
        },
      ],
    },
    bottom: {
      type: 'agorum.toolBar',
      items: [
        {
          type: 'agorum.button',
          text: '',
        },
      ],
    },
    left: {
      type: 'agorum.toolBar',
      items: [
        {
          type: 'agorum.button',
          text: '',
        },
      ],
    },
    right: {
      type: 'agorum.toolBar',
      items: [
        {
          type: 'agorum.button',
          text: '',
        },
      ],
    },
    center: {
      type: 'agorum.explorer',
      name: 'explorer',
      showDetails: true,
    },
  },
});

form.down('explorer').roots = ['/agorum/roi/Files/Demo'];

form;

 

Verwendung von agorum.explorer in einer Form