agorum.composite.search.result

Mit diesem aguila-Widget können Sie:

• eigene Oberflächen in der Suche anzeigen
• zwischen einer Listen- oder einer Explorer-Darstellung wählen

Beispiel einer Oberfläche

---

Skript zur beispielhaften Oberfläche

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


let searchWidgetList = aguila.create({
  type: 'agorum.composite.search.result',
  listType: 'detail',
  query: '*',
  thumbnails: false,
  timeline: false,
  sort: [
    {
      property: 'lastModifyDate',
      direction: 'DESC'
    }
  ]
});

// oder explorer suche
let searchWidgetExplorer = aguila.create({
  type: 'agorum.composite.search.result',
  listType: 'explorer',
  list: 'Standard',
  query: '*',
  sort: [
    {
      property: 'lastModifyDate',
      direction: 'DESC'
    }
  ]  
}); 

searchWidgetList;
//searchWidgetExplorer;

Parameter für Detail-Listen und Explorer-Listen

---

query

Enthält die Query, die das System im Widget ausführt.

Sie können diesen Parameter nachträglich nicht ändern.

Beispiel

searchWidget.query = '*';

sort

Definiert optional die Sortierung des Suchergebnisses.

• Wenn Sie den Parameter nicht angeben, sortiert das System standardmäßig mit lastModifyDate, DESC bei Detail-Listen. Bei Explorer-Listen gilt die Sortierung der Liste selbst.
• Wenn Sie bei Explorer-Listen sort angeben, kann der Benutzer die Liste nicht mehr manuell sortieren.
• Sie können mehrere Sortierkriterien nacheinander angeben.
• Sie können diesen Parameter nachträglich nicht ändern.

Beispiel

searchWidget.sort = [
  {
    property: 'lastModifyDate',
    direction: 'DESC'
  }
];

Parameter für Detail-Listen

---

selection

Nimmt eine Auswahl in der Liste vor.

• Funktioniert nur bei Explorer-Listen und nur für Elemente im dargestellten Bereich.
• Das System übergibt ein String-Array von IDs.
• Die Selektierung führt das System nur durch, wenn lediglich 1 Element im Array ist.
• Wenn Sie mehrere Elemente übergeben, wird keine Selektierung durchgeführt.
• Sie können diesen Parameter nachträglich nicht ändern.

Beispiel

searchWidget.selection = [ '12345' ];

thumbnails

Wert	Beschreibung
true (Standard)	Aktiviert Vorschau-Thumbnails in der Liste.
false	Deaktiviert Vorschau-Thumbnails in der Liste.

Beispiel

searchWidget.thumbnails = true;

Sie können diesen Parameter nachträglich nicht ändern.

timeline

Wert	Beschreibung
true (Standard)	Aktiviert den Zeitstrahl in der Liste.
false	Deaktiviert den Zeitstrahl in der Liste.

Beispiel

searchWidget.timeline = true;

Sie können diesen Parameter nachträglich nicht ändern.

listParams

Enthält weitere Parameter, die das System intern an die jeweiligen Listen-Elemente (ListItemBricks) gibt und dort verwendet.

Sie können diesen Parameter nachträglich nicht ändern.

Beispiel

searchWidget.listParams = { context: 'Test' };

listParameters

Sie können Parameter an die Ergebnis-Liste, die cards anzeigen, übergeben, etwa den Parameter level.

Beispiel

let aguila = require('common/aguila');
let decorators = require('/agorum/roi/customers/agorum.cards/js/decorators');

let resultWdg = aguila.create({
  type: 'agorum.composite.search.result',
  listType: 'detail',
  query: '*',
  listParameters: {
    level: decorators.LEVEL.SMALL,
  },
  sort: [
    {
      property: 'lastModifyDate',
      direction: 'DESC',
    },
  ],
});

resultWdg;

lastSeenDate

Stellt optional bei einer absteigend sortierten Liste einen Balken ab dem in lastSeenDate gelieferten Datum mit dem Hinweis Bereits gesehene Ergebnisse dar.

• Wenn es sich um eine aufsteigend sortierte Liste handelt, fügt das System einen Balken mit dem Hinweis Neue Ergebnisse ein.
• Das Datum bezieht sich auf das updateDate (oder auf das im Parameter lastSeenProperty definierte Attribut) der jeweiligen Objekte im Suchergebnis.

Beispiel

searchWidget.lastSeenDate = new Date();

lastSeenProperty

Definiert optional, auf welches Attribut sich der Parameter lastSeenDate bezieht.

Im Standard bezieht sich das System auf das updateDate.

Beispiel

searchWidget.lastSeenPoperty = 'createDate';

Parameter für Explorer-Listen

---

Im agorum core smart assistant konfigurator können Sie eine Liste mit den gewünschten Spalten konfigurieren. Der Name dieser Konfiguration können Sie dann im Parameter list übergeben.

Wenn Sie den Parameter list nicht definieren, verwendet das System den Wert Standard.

let searchWidget = aguila.create({
  type: 'agorum.composite.search.result',
  query: '*',
  listType: 'explorer',
  list: 'Name der Listenkonfiguration aus dem agorum core smart assistant konfigurator'
});

Events (fire)

---

Events, die Sie zum Widget senden können.

refresh

Führt die Suche erneut mit den aktuell eingestellten Parametern aus.

Beispiel

searchWidget.fire('refresh');

Events (on)

---

Events, die das Widget sendet und auf die Sie reagieren können.

selectionChanged

Löst aus, sobald ein Benutzer ein Element aus der Suchliste markiert.

Das System liefert:

• die ID des gewählten Elements als Parameter
• ein String-Array

Beispiel

searchWidget.on('selectionChanged', ids => {
  // hier kann jetzt etwas mit der ID gemacht werden. Die ID wird als Array geliefert
  ...
});

loading

Löst aus, wenn die Liste lädt.

loaded

Löst aus, wenn das System die Liste fertig geladen hat.

Komplettes Beispiel einer Oberfläche

---

Skript zum kompletten Beispiel

/* global parameters */
let aguila = require('common/aguila');

// Aufbau eines Rahmens, in dem jeweils eine Explorer-Suche und eine Detail-Suche dargestellt werden
let widget = aguila.create({
  type: 'agorum.hbox',
  width: 1000,
  height: 600,
  items: [
    {
      type: 'agorum.composite.search.result',
      listType: 'explorer',
      list: 'Standard',
      name: 'explorerSearch',
      title: 'Explorer Suche',
      query: 'inpath:9999',
      flexible: true
    }, 
    {
      type: 'agorum.composite.search.result',
      listType: 'detail',
      name: 'detailSearch',
      title: 'Detail Suche',
      flexible: true,
      thumbnails: false,
      timeline: false
    }
  ]
});

// dem jeweiligen Bereich zuordnen
let explorerSearch = widget.down('explorerSearch');
let detailSearch = widget.down('detailSearch');

// explorerSearch sucht gleich, weil query direkt als Parameter mitgegeben wird
// detailSearch wird die query beispielhaft nach Generierung des widgets gesetzt und dadurch die Suche ausgelöst
detailSearch.query = 'inpath:9999';

widget;