Technische Dokumentation des PDF-Viewer-Widget
- Florian Pieper
- Anna Janzen
Beschreibung
Auf dieser Seite finden Sie die technische Beschreibung zur Integration des PDF-Viewers. Mit dem PDF Viewer können PDF-Dokumente gesichtet werden. Innerhalb des PDF-Viewers können viele Zusatzfunktionen wie ein Downloadbutton, ein Warenkorb, eine Suche etc. nutzen und ergänzen. Im Folgenden finden Sie den Überblick über den Inhalt dieser Seite:
Inhalt
Parameter “xs-pdf-viewer”
Dieses Widget öffnet das über die Link-Id identifizierte PDF-Dokument.
Eingang | |||
|---|---|---|---|
Parameter | Pflicht | Beschriebung | Beispielwert |
linkID | Ja | Externe Link-ID des Uploads, der im Viewer geöffnet werden soll. Die ID kann im Infopaket-Upload am Upload erzeugt werden. | b8fd8f7c-d815-41a3-b36b-d7120821d1d1 |
download | Nein | Aktiviert die Downloadfunktion der PDF-Dokumente für diesen Kanal. Wenn deaktiviert, wird der Downloadbutton nicht angezeigt. | true |
shopcart | Nein | Aktiviert das Warenkorbevent, dass das einbindende System zum Öffnen des Warenkorboverlays verwenden kann. Wenn deaktiviert, wird der Warenkorbbutton im PDF-Viewer nicht angezeigt. | true |
shopsearch | Nein | Aktiviert das Suchevent, dass das einbindende System zur weiteren Suche verwenden kann. Wenn deaktiviert, wird der Suchbutton für den Shop nicht angezeigt. | true |
externalsearch | Nein |
| true |
donwloadinnewtab | Nein | Wird der Parameter auf true gesetzt, so öffnet sich beim klick auf den Downloadbutton ein neuer Tab und die Datei wird heruntergeladen | true |
downloadinnewtabtarget | Nein | In Verbindung mit “downloadinnewtab” zu verwenden. Wird nur verwendet, wenn “downloadinnewtab” auf true gesetzt ist Gibt das Ziel an, das die Download-URL öffnen soll Im Standard oder wenn kein Wert gesetzt ist, wird “_blank“ verwendet | {
...
"downloadinnewtabtarget": "_parent"
}
|
style | Nein | JSON-Objekt zur Definition der Primär- und Sekundär-Farbe des Widgets. Das Objekt hat zwei Felder:
| "style":{
"primarycolor": "#616161",
"secondarycolor": "#D3D3D3"
} |
Ausgang | |||
status |
| Dieses Event wird immer beim Initialisieren ausgegeben.
|
|
shopsearch |
| Dieses Event wird nur ausgegeben, wenn diese Funktion für den entsprechenden Kanal angeschaltet wurde. Das Event beinhaltet folgende zwei Informationen.
| {
"searchterm":"test",
"manufacturerid":"testid"
"callback": {
"searchterm":"test",
"manufacturerid":"testid",
"thumbnailurl": "https://2.0.open-datacheck.de/webservicehub/DateiabrufOMD?type=LO&fileID=c2l0ZXMvZGVmYXVsdC9maWxlcy9pbmZvcGFja2FnZS8yLzEzMDEvMTYzNTE3MjczMi90aHVtYm5haWxzLzEwMzE5MjY0LnBkZi5qcGVn"
"uploaddescription": "Installation 2021"
}
} |
shopcart |
| Dieses Event wird nur ausgegeben, wenn diese Funktion für den entsprechenden Kanal angeschaltet wurde.
| |
shopcart |
| Dieses Event wird bei einem Klick auf einen externen Link in einem PDF Dokument ausgegeben. | Ausgabe des im PDF Dokument angegebene Wert für den externen Link als String |
Beispielabbildung
Beispielparameter
Beispielintegration
Folgendes Codesnippet in den HTML DOM einbetten.
Beispielevent “shopsearch”
Folgendes Codebeispiel wartet auf das Rückgabevent “shopsearch” von der DeepSearch.
Beispielevent “shopcart”
Folgendes Codebeispiel wartet auf das Rückgabevent “shopcart” von der DeepSearch.
Beispielevent “status”
Folgendes Codebeispiel wartet auf das Rückgabevent “status” von der DeepSearch.