Die Integration oxomi.galleries rendert eine Liste von Exposés in den angegebenen DOM-Container. Dabei wird das Vorschau-Bild des Exposés sowie dessen Name angezeigt. Die Integration bietet verschiedene Filter-, Sortier- und Gruppiermöglichkeiten, mit denen Sie die Ergebnisse einschränken und anpassen können. Darüber hinaus kann ein Gruppenfilter angezeigt werden.
Die gerenderte Liste von Exposés enthält bis zu 50 Einträge. Falls mehr Exposés gefunden wurden, so wird eine Karte mit dem Label „Weitere anzeigen“ dargestellt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Exposés nachgeladen.
Die Integration bietet verschiedene CSS -cust Klassen an, um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.
Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.
oxomi.galleries({
target: "#output",
showActions: true,
showGroupFilter: true,
groupBy: "brand",
supplierNumbers: "L10190"
}).then((result) => {
console.log("success");
}).catch((error) => {
console.log("failed");
});
Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.
| Parameter | Parametertyp | Beschreibung | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| target | string |
Gibt das Ziel-Element an, in welches die gerenderte Liste von Exposés eingefügt wird. Hinweis:
|
||||||||||||
| supplierNumbers | string |
Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| excludedSupplierNumbers | string |
Gibt die Lieferantennummern der Partner an, deren Inhalte von den Ergebnissen ausgeschlossen werden sollen. Hinweis:
|
||||||||||||
| brandIds | string |
Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| brands | string |
Gibt die Namen der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| seriesIds | string |
Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| tags | string |
Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| categoryIds | string |
Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| categories | string |
Gibt die Namen der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen. Hinweis:
|
||||||||||||
| types | string |
Gibt die Exposés-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: gallery-types Hinweis:
|
||||||||||||
| filterLanguages | string |
Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes Hinweis:
|
||||||||||||
| filterCountries | string |
Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes Hinweis:
|
||||||||||||
| own | boolean |
Gibt an, ob nur eigene Exposés oder nur Exposés von anderen Anbietern angezeigt werden sollen. Hinweis:
|
||||||||||||
| includeOutdated | boolean |
Gibt an, ob auch archivierte Exposés in den Ergebnissen angezeigt werden sollen. Hinweis:
|
||||||||||||
| onlyOutdated | boolean |
Gibt an, ob ausschließlich archivierte Exposés in den Ergebnissen angezeigt werden sollen. Hinweis:
|
||||||||||||
| sortBy | string |
Gibt die Sortierung der Ergebnisse vor. Die nachfolgenden Werte stehen hier zur Verfügung:
Hinweis:
|
||||||||||||
| showGroupFilter | boolean |
Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf true gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt. Hinweis:
|
||||||||||||
| groupBy | string |
Gibt an ob und wie das Ergebnis gruppiert werden soll. Die nachfolgenden Werte stehen hier zur Verfügung:
Hinweis:
|
||||||||||||
| limit | integer |
Gibt die maximale Anzahl an Exposés an, welche initial angezeigt werden sollen. Hinweis:
|
Ausgabebereich
Die Integration oxomi.embedGallery rendert entweder das Cover-Bild eines einzelnen angegebenen Exposés (sowie dessen Name) oder das Exposé im Viewer geöffnet in den angegebenen DOM-Container.
Die Integration bietet zudem verschiedene CSS -cust Klassen an um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.
Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.
oxomi.embedGallery({
target: "#output",
gallery: "7733",
image: "1",
inline: false
}).then((result) => {
console.log("success");
}).catch((error) => {
console.log("failed");
});
Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.
| Parameter | Parametertyp | Beschreibung |
|---|---|---|
| gallery | string |
Gibt die ID oder den Code des Exposés an. Hinweis:
|
| supplierNumber | string |
Gibt die Nummer des Lieferanten an, über welchen der Inhalt bezogen wird. Hinweis:
|
| target | string |
Gibt das Ziel-Element an, in welches das gerenderte Exposé eingefügt wird. Hinweis:
|
| image | string |
Gibt die Nummer des Bildes an, das beim Öffnen des Exposés angezeigt werden soll (beginnend bei 1). Hinweis:
|
| inline | boolean |
Gibt an, ob das Exposé im Ziel-Element mit geöffnetem Viewer direkt eingebettet werden soll. Hinweis:
|
Ausgabebereich
Mit der Integration oxomi.openGallery kann ein Exposé in einem Overlay geöffnet werden. So können Sie beispielsweise ein Exposé aus einer Liste oder aus einem anderen Kontext heraus anzeigen. Dabei können Sie die Nummer des Bildes angeben, das initial angezeigt werden soll.
Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.
oxomi.openGallery({
gallery: "7733",
image: "1"
}).then((result) => {
console.log("success");
}).catch((error) => {
console.log("failed");
});
Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.
| Parameter | Parametertyp | Beschreibung |
|---|---|---|
| gallery | string |
Gibt die ID oder den Code des Exposés an. Hinweis:
|
| supplierNumber | string |
Gibt die Nummer des Lieferanten an, über welchen der Inhalt bezogen wird. Hinweis:
|
| image | string |
Gibt die Nummer des Bildes an, das beim Öffnen des Exposés angezeigt werden soll (beginnend bei 1). Hinweis:
|