MPP_API: JavaScript-API für Multi Perspective Preview

JavaScript-Objekt: top.MPP_API
Access-API-Dokumentation: MPPWebControl

Die Multi Perspective Preview-JavaScript-API wird über das JavaScript-Objekt top.MPP_API verfügbar gemacht und bietet mehrere Funktionen, die den Zugriff auf die aktuelle Zeiteinstellung und von Benutzern definierte Parameter der MPP-Toolbar bieten.

Die MPP-JavaScript-API stellt keine Funktion bereit, um die aktive Viewport-Einstellung zu erfragen.

MPP-Status erfragen

boolean isParameterized() gibt an, ob MPP-Parametrisierung aktiv (true; die MPP-Toolbar wird angezeigt) oder inaktiv (false; MPP-Toolbar wird nicht angezeigt) ist.

In der MPP-Toolbar gesetzte Parameter erfragen

Die folgenden Funktionen bieten Zugriff auf Parameterwerte, die aktuell in der MPP-Toolbar gesetzt sind. Dies ermöglicht die dynamische Anpassung des Vorschauinhalts an die MPP-Einstellungen, z. B. können bestimmte Inhaltselemente aufgrund der aktuellen Zeiteinstellung (Zeitleiste) oder der in der Toolbar gesetzten Benutzerrolle (projektspezifische MPP-Parameter) ein- oder ausgeblendet werden.

JavaScriptObject getTimeParameter() liefert die aktuell in der MPP-Zeitleiste eingestellte Zeit zurück.

Object getParameter(String name) liefert den Wert des als Parameter genannten, projektspezifischen MPP-Parameters zurück. Der Parameter name gibt dabei den Namen einer Eingabekomponente, der für die MPP-Parametrisierung genutzten Seitenvorlage an.

MPP-Parameter in der Toolbar setzen

Durch Interaktionen in der Vorschau kann es notwendig werden, MPP-Parameter abzuändern. Beispielsweise könnte sich die Benutzerrolle vom Zustand "nicht angemeldet" zum Zustand "angemeldet" verändern. Die nachfolgend genannten Funktionen ermöglichen, die Anzeige der MPP-Parameter in der Toolbar so zu setzen, dass sie den aktuellen Zustand in der Vorschau widerspiegeln.

void setTimeParameter(JavaScriptObject date) setzt die MPP-Zeitleiste auf die angegebene Zeit.

void setParameter(String name, Object value) setzt den Wert eines projektspezifischen MPP-Parameters in der Toolbar. Der Parameter name gibt dabei den Namen einer Eingabekomponente der für MPP-Parametrisierung genutzten Seitenvorlage an. Der Objekttyp des Parameters value muss mit dem Objekttyp dieser Eingabekomponente kompatibel sein.

MPP im SiteArchitect verwenden: Injection-Zeitpunkt abfragen

Bei der Verwendung der MPP-JavaScript-API im SiteArchitect muss der Injection-Zeitpunkt abgewartet werden. Dazu kann folgende Anweisung verwendet werden:  

<script type="text/javascript" language="javascript"> 
<!-- 
  function anyFunction() { 
      // PUT YOUR CODE HERE 
  } 
$CMS_IF(isWebEdit)$ 
  anyFunction(); 
$CMS_ELSE$ 
  window.onBrowserInjection = function(name, object) {  
      if (name == "MPP_API") { 
    anyFunction(); 
      } 
  } 
$CMS_END_IF$ 
--> 
</script>