@vertigis/viewer-spec 51.13.0 → 51.15.0

package/layout/schema/layout-common.xsd

@@ -810,6 +810,23 @@
                             </documentation>
                         </annotation>
                     </attribute>
+                    <attribute name="show-filter-control" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether to show an text input control for
+                                filtering layers by title. Web only.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                    <attribute name="show-action-menu" type="boolean" default="true">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether to show a menu button that can be used
+                                to execute actions on all layers that are
+                                currently displayed in the layer list. Web only.
+                            </documentation>
+                        </annotation>
+                    </attribute>
                 </extension>
             </complexContent>
         </complexType>

package/messaging/registry/layers.d.ts

@@ -30,6 +30,19 @@ export interface SetLabelVisibilityArgs extends HasLayers, HasMaps {
  * Arguments for the layer.set-symbol command.
  */
 export type SetSymbolArgs = Required<HasSymbol & HasLayers> & Partial<HasMaps>;
+/**
+ * Arguments for the layer.set-visibility command. If no 'maps' are specified,
+ * all active maps in the layout will be targeted. If no 'layers' are specified,
+ * all viable layers and sublayers within the 'maps' will be affected. If the
+ * 'layers' property includes (Sub)Layer references or ESRI (Sub)Layers, they
+ * must exist within one of the 'maps'.
+ */
+export interface SetVisibilityArgs extends HasLayers, HasMaps {
+    /**
+     * The visibility of the provided layers.
+     */
+    visible: boolean;
+}
 export declare class LayersCommands extends CommandRegistry {
     /**
      * Guard command for enabling the layers.set-symbol command.
@@ -43,6 +56,12 @@ export declare class LayersCommands extends CommandRegistry {
      * @webOnly
      */
     get setSymbol(): Command<SetSymbolArgs>;
+    /**
+     * Updates the visibility of the provided layer(s).
+     *
+     * @webOnly
+     */
+    get setVisibility(): Command<SetVisibilityArgs>;
     /**
      * Turns on the layer's labels on the map.
      *

package/messaging/registry/layers.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";export class LayersCommands extends e{get ensureCanSetSymbol(){return this._messages.command("layers.ensure-can-set-symbol")}get setSymbol(){return this._messages.command("layers.set-symbol")}get showLabels(){return this._messages.command("layers.show-labels")}get hideLabels(){return this._messages.command("layers.hide-labels")}}export class LayersEvents extends s{get visibilityChanged(){return this._messages.event("layers.visibility-changed")}}
+import{CommandRegistry as s}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";export class LayersCommands extends s{get ensureCanSetSymbol(){return this._messages.command("layers.ensure-can-set-symbol")}get setSymbol(){return this._messages.command("layers.set-symbol")}get setVisibility(){return this._messages.command("layers.set-visibility")}get showLabels(){return this._messages.command("layers.show-labels")}get hideLabels(){return this._messages.command("layers.hide-labels")}}export class LayersEvents extends e{get visibilityChanged(){return this._messages.event("layers.visibility-changed")}}

package/messaging/registry/results.d.ts

@@ -16,7 +16,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob, Features, FeaturesLike, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
+import type { Blob, Features, FeaturesLike, File, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
 import type { VisualElement } from "../mobile.js";
 /**
  * Well known Results Set Ids.
@@ -24,6 +24,10 @@ import type { VisualElement } from "../mobile.js";
 export declare enum KnownResultSetIds {
     STARRED = "vgs-starred"
 }
+/**
+ * Args for `results.from-files`.
+ */
+export type FromConverterArgs = FromCsvConversionArgs | FromShapefileConversionArgs | FromXLSXConversionArgs;
 /**
  * Arguments for various commands that target a result set of features.
  */
@@ -514,6 +518,12 @@ export declare class ResultsOperations extends OperationRegistry {
      * @webOnly
      */
     get fromCsv(): Operation<FromCsvConversionArgs | Blob | Blob[], Features>;
+    /**
+     * Convert the specified csv, xlsx or shapefile files to Features.
+     *
+     * @webOnly
+     */
+    get fromFiles(): Operation<File[] | FromConverterArgs, Features>;
     /**
      * Convert the specified Shapefile blob to Features.
      *

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromFiles(){return this._messages.operation("results.from-files")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}

package/messaging/registry/system.d.ts

@@ -42,6 +42,11 @@ export interface ReadFileArgs extends HasUITarget {
      * user for a file.
      */
     promptMessage?: string;
+    /**
+     * If present, provides information about what file types are accepted by
+     * this dialog, eg: "*.jpg, *.gif and *.bmp files accepted".
+     */
+    fileTypeDescription?: string;
 }
 /**
  * Well-known location-based tokens that can be used in the system.open-url

package/messaging/schema/web-action.schema.json

@@ -4302,6 +4302,10 @@
                 "attributes": {
                     "description": "Optional layout XML attributes to be used for the transient UI container."
                 },
+                "fileTypeDescription": {
+                    "description": "If present, provides information about what file types are accepted by this dialog, eg: \"*.jpg, *.gif and *.bmp files accepted\".",
+                    "type": "string"
+                },
                 "icon": {
                     "description": "Optional icon that may be used by the transient UI container.",
                     "type": "string"
@@ -5036,6 +5040,28 @@
             ],
             "type": "object"
         },
+        "SetVisibilityArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the layer.set-visibility command. If no 'maps' are specified, all active maps in the layout will be targeted. If no 'layers' are specified, all viable layers and sublayers within the 'maps' will be affected. If the 'layers' property includes (Sub)Layer references or ESRI (Sub)Layers, they must exist within one of the 'maps'.",
+            "properties": {
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Layer(s) to use for the command/operation."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "visible": {
+                    "description": "The visibility of the provided layers.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "visible"
+            ],
+            "type": "object"
+        },
         "SetVisualStateArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"ui.set-visual-state\" command.",
@@ -16711,6 +16737,15 @@
         "layers.set-symbol:input": {
             "$ref": "#/definitions/SetSymbolArgs"
         },
+        "layers.set-visibility": {
+            "description": "Updates the visibility of the provided layer(s).",
+            "enum": [
+                "layers.set-visibility"
+            ]
+        },
+        "layers.set-visibility:input": {
+            "$ref": "#/definitions/SetVisibilityArgs"
+        },
         "layers.show-labels": {
             "description": "Turns on the layer's labels on the map.",
             "enum": [
@@ -18506,6 +18541,34 @@
         "results.from-csv:output": {
             "$ref": "#/definitions/Features"
         },
+        "results.from-files": {
+            "description": "Convert the specified csv, xlsx or shapefile files to Features.",
+            "enum": [
+                "results.from-files"
+            ]
+        },
+        "results.from-files:input": {
+            "anyOf": [
+                {
+                    "items": {
+                        "$ref": "File"
+                    },
+                    "type": "array"
+                },
+                {
+                    "$ref": "#/definitions/FromCsvConversionArgs"
+                },
+                {
+                    "$ref": "#/definitions/FromShapefileConversionArgs"
+                },
+                {
+                    "$ref": "#/definitions/FromXLSXConversionArgs"
+                }
+            ]
+        },
+        "results.from-files:output": {
+            "$ref": "#/definitions/Features"
+        },
         "results.from-graphics": {
             "description": "Converts provided GraphicsLike to VertiGIS Studio Features using any available metadata.",
             "enum": [
@@ -20167,6 +20230,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/layers.set-visibility:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/layers.set-visibility"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -21737,6 +21816,9 @@
                 {
                     "$ref": "#/definitions/layers.set-symbol"
                 },
+                {
+                    "$ref": "#/definitions/layers.set-visibility"
+                },
                 {
                     "$ref": "#/definitions/layers.show-labels"
                 },
@@ -22662,6 +22744,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.from-files:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.from-files"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -23193,6 +23291,9 @@
                 {
                     "$ref": "#/definitions/results.from-csv"
                 },
+                {
+                    "$ref": "#/definitions/results.from-files"
+                },
                 {
                     "$ref": "#/definitions/results.from-graphics"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "51.13.0",
+  "version": "51.15.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "51.13.0";
+export declare const version = "51.15.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "51.13.0";
+export const version = "51.15.0";