Ressource¶

Unter Ressourcen sind alle externen Daten die nachgeladen werden gemeint.

Resourcen können nachträglich über das Alvine.Package.Resource.<Type>-Objekt in eine Webseite eingebunden werden. Die Ressource wird dabei immer über eine eindeutige URL definiert. Mittels der Methode available() kann die Verfügbarkeit der Ressource sichergestellt werden. Die Methode prüft ob das Element bereits vorhanden mit der definierten URL vorhanden ist oder lädt die Ressource mit der entsprechenden URL. Das zurückgegebene Promise wird, sobald die definierte Ressource geladen ist erfüllt. Wird die Ressouce nicht gefunden, oder liefert der Server einen Fehler, so wirft auch das Promise einen Fehler.

Hinweis

Wir für die jeweilige Quelle eine relative URL übergeben, so wird die Basis-URL des Hauptdokuments herangezogen.

Als URL-Parameter kann auch jeweils das URL-Objekt von Javascript verwendet werden.

Script¶

Die Script-Ressource prüft auf vorhandene Script-Tags und fügt gegebenenfalls ein neues Script-Element ein.

Über die Optionen async und crossOrigin können die entsprechenden Attribute des Script-Tags gesteuert werden.

new Alvine.Package.Resource.Script('/js/example.js',{async:true, crossOrigin:'anonymous'})
     .available().then(
          result => console.log(result))
                 .catch(error => console.error(error))

Style¶

Die Style-Ressource prüft auf vorhandene Link-Tags und fügt gegebenenfalls ein neues Link-Element ein.

Über die Option media kann die Gültigkeit auf einen bestimmten Media-Type (z.B. print) festgelegt werden.

new Alvine.Package.Resource.Style('/styles/example.css', {media:'print'})
     .available().then(
          result => console.log(result))
                 .catch(error => console.error(error))

Dataset¶

Mit Hilfe der Dataset-Resource lassen sich alle Arten von JSON-Daten laden. Wird die Option raw auf true gesetzt, so wird das Ergebnis anstatt als Alvine.Types.Map als Javascript-Objekt zurückgegeben. Mittels cache-Option kann eine bereits geladene Ressource erneut vom Server gleaden werden.

new Alvine.Package.Resource.Dataset('/example.json', {cache: false, raw:false})
     .available().then(
          result => console.log(result))
                 .catch(error => console.error(error))

Locale¶

Mit Hilfe der Locale-Resource lassen sich Sprachdateien in Abhängigkeit der Dokumenten-Sprache laden. Anders als bei der Dataset-Ressource wird hier kein Name, sondern nur der Pfad referenziert. Der Name der Ressource wird automatisch von dem Objekt in Abhängigkeit des Dokuments erstellt. Siehe hierzu auch die I18N-Anleitung.

new Alvine.Package.Resource.Locale('/resource/', {tags: ['example'], registry:false})
     .available().then(
          result => console.log(result))
                 .catch(error => console.error(error))

Objektreferenz¶

Script¶

Script(url, options)

Beschreibung

Definiert über die URL ein externes Script

Parameter-Liste

url (String)

url, unter der das Script vom Server abrufbar ist. Wird eine relative URL angegeben, so wird die Basis-Adresse des Dokuments verwendet.

options (Object)

Verschiedene Optionen zur Steuerung der Einbindung. Über die Option document kann ein eigenes Dokument angegeben werden. Mit async wird gesteuert, das das Script asynchrone geladen wird (Default ist false). crossOrigin steuert zudem den Zugriff auf Scripts anderer Server. Standard ist anonymous

Rückgabewert

Neues Script-Objekt

Script.available()

Beschreibung

Wird das Script nicht im Dokument gefunden, so wird es in das DOM des Dokuments eingebunden. Diese Methode liefert ein Promise zurück, das sobald das Script verfügbar ist erfüllt wird.

Rückgabewert

Promise-Objekt, dass bei verfügbaren Script erfüllt und bei einem Fehler nicht erfüllt wird.

Style¶

Style(url, options)

Beschreibung

Definiert über die URL ein externes Stylesheet

Parameter-Liste

url (String)

url, unter der das Stylesheet vom Server abrufbar ist. Wird eine relative URL angegeben, so wird die Basis-Adresse des Dokuments verwendet.

options (Object)

Verschiedene Optionen zur Steuerung der Einbindung. Über die Option media kann ein Mediaquery definiert werden (Standardwert ist all).

Rückgabewert

Neues Style-Objekt

Style.available()

Beschreibung

Wird das Stylesheet nicht im Dokument gefunden, so wird es in das DOM des Dokuments eingebunden. Diese Methode liefert ein Promise zurück, dass sobald das Stylesheet verfügbar ist erfüllt wird.

Rückgabewert

Promise-Objekt, das bei verfügbaren Stylesheet erfüllt und bei einem Fehler nicht erfüllt wird.

Dataset¶

Dataset(url, options)

Beschreibung

Definiert über die URL ein externes Dataset

Parameter-Liste

url (String)

url, unter der das Dataset vom Server abrufbar ist. Wird eine relative URL angegeben, so wird die Basis-Adresse des Dokuments verwendet.

options (Object)

Verschiedene Optionen zur Steuerung der Einbindung. Über die Option cache=false kann der Zwischenspeicher deaktiviert werden und über raw=true wird das Ergebnis als Javascript Objekt anstatt eines Alvine.DOM.Dataset Objektes zurückgegeben.

Rückgabewert

Neues Dataset-Objekt

Dataset.available()

Beschreibung

Wird das Dataset nicht im Cache gefunden, oder ist die Option cache=false angegeben, so wird die Ressource vom Server abgerufen

Rückgabewert

Alvine.DOM.Dataset- oder Javascript-Objekte

Locale¶

Locale(url, options)

Beschreibung

Definiert über die URL eine externe Sprachdatei.

Parameter-Liste

url (String)

Basis-URL, unter der die Sprachdateien vom Server abrufbar sind. Wird eine relative URL angegeben, so wird die Basis-Adresse des Dokuments verwendet.

options (Object)

Verschiedene Optionen zur Steuerung der Einbindung. Über die Option registry=false wird das Ergebnis nicht in die Registry eingetragen. Über die Options tags können der Ressource Tags hinzugefügt werden.

Rückgabewert

Neues Style-Objekt

Locale.available()

Beschreibung

Wird die Locale nicht im Cache gefunden, so wird die Lokale vom Server geladen. Diese Methode liefert ein Promise zurück, dass sobald die Locale verfügbar ist erfüllt wird.

Rückgabewert

Promise-Objekt, das bei verfügbarer Locale erfüllt und bei einem Fehler nicht erfüllt wird.