Angabe des Bildes für das Modul
Für ein Modul kann für die Größen 64x64, 32x32 und 16x16 ein Bild angegeben werden. Dieses Bild wird dann vom Designer und Client interpretiert und angezeigt.
In dem folgenden JSON-Objekt ist der Aufbau für die Angabe von Bildern beschrieben. Dieses JSON-Objekt wird in der Eigenschaft icon verwendet.
{
"icon": {
"small": "base64:<<BASE64>> or image:<<Relatvice path to image>> or font:<<Icon>>",
"medium": "base64:<<BASE64>> or image:<<Relatvice path to image>> or font:<<Icon>>",
"large": "base64:<<BASE64>> or image:<<Relatvice path to image>> or font:<<Icon>>"
}
}Das System stellt Ihnen 3 Optionen zur Verfügung um Bilder für Ihr Modul zu verwenden. Nachstehend sind die einzelnen Optionen aufgelistet und erläutert.
Verwenden von Base64 Strings
Möchten Sie das Bild als Base64-String übergeben, geben Sie vor dem Base64-String base64:<<BASE64>> an. Damit erkennt das System, dass es sich um eine Bilddatei handelt welche als Base64 übergeben wurde.
Verwenden von Bilddateien aus dem Modul-Container
Alternativ können Sie eine Bilddatei aus dem ZIP-Container des Moduls verwenden. Hierzu geben Sie image:<<Source>> an. Als Quelle verwenden sie den relativen Pfad zur Bilddatei. Liegt die Bilddatei beispielsweise im Ordner Icons/16x16 geben Sie die Bilddatei wie folgt an image:icons/16x16/attributes_to_json.png:
Sie können Bilder als Base64 String übergeben oder als Referenz zu einem Bild welches in dem ZIP-Container des Moduls hinterlegt ist. Sie sollten immer eine Bilddatei im ZIP-Container hinterlegen und diese referenzieren, dass verringert den Speicherbedarf für die Definitionsdatei.
Feld | Beschreibung |
|---|---|
large | Angabe eines Bildes welches für die Größe 64x64 oder größer ausgelegt ist. |
medium | Angabe eines Bildes welches für die Größe 32x32 bis 48x48 ausgelegt ist. |
small | Angabe eines Bildes welches für die Größe 16x16 bis 24x24 ausgelegt ist. |
Verwenden von Fontawesome Icons
Bei der Angabe von Bildern für ein Modul besteht auch die Möglichkeit auf Icons von Fontawesome zurückzugreifen. Hierzu geben Sie font:<<Icon>> an. Als Quelle für die Bilder greift das System jetzt auf die hinterlegten Fontawesome Icons zurück und gibt das jeweilige Icon in der entsprechenden größe dem System wieder. Möchten Sie beispielsweise das Icon microchip verwenden, geben Sie die Bilddatei wie folgt an: font:microchip
Welchen Namen Sie als Icon verwenden können, entnehmen Sie bitte von der Produktseite von Fontawesome: Gallerie zu den Icons.