@vertigis/viewer-spec 51.7.0 → 51.9.0

package/app-config/mobile/EventListenerModelProperties.d.ts

@@ -0,0 +1,39 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ComponentModelProperties } from "../common/ComponentModelProperties.js";
+import type { ItemRef } from "../common/ItemRef.js";
+/**
+ * Configuration for a generic event listener.
+ */
+export interface EventListenerModelProperties extends ComponentModelProperties {
+    /**
+     * A collection of event listener definitions. Each element has to be an
+     * inline JSON defining an event listener definition item.
+     */
+    listeners: EventListenerDefinitionProperties[];
+}
+/**
+ * Properties for a generic event listener definition. Specifies an action to
+ * execute whenever the target event is published.
+ * If the sender property is assigned, the action will only be executed
+ * if the event is published with the specified sender.
+ */
+export interface EventListenerDefinitionProperties {
+    /**
+     * The name of the event to listen to. This value has to match the events
+     * name that gets published (including its namespace prefix,
+     * e.g. map.navigation-completed). All events are supported, both built in
+     * events as well as custom events published through "viewer.publish-event"
+     * or the Publish Event workflow activity.
+     */
+    event: string;
+    /**
+     * An optional reference to an item, that is to be used as a filter.
+     * If set, only events published by the specified sender object,
+     * will cause the action to be executed.
+     */
+    sender?: ItemRef;
+    /**
+     * The action to perform, when the specified events gets published.
+     */
+    action: Action;
+}

package/app-config/mobile/EventListenerModelProperties.js

@@ -0,0 +1 @@
+export{};