@vertigis/viewer-spec 51.2.0 → 51.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -567,7 +567,15 @@
567
567
  </annotation>
568
568
  <complexType>
569
569
  <complexContent mixed="true">
570
- <extension base="tns:Component" />
570
+ <extension base="tns:Component">
571
+ <attribute name="showBackground" type="boolean" default="true">
572
+ <annotation>
573
+ <documentation xml:lang="en">
574
+ Whether or not the text background should be displayed. Mobile only. Defaults to true.
575
+ </documentation>
576
+ </annotation>
577
+ </attribute>
578
+ </extension>
571
579
  </complexContent>
572
580
  </complexType>
573
581
  </element>
@@ -1,11 +1,11 @@
1
1
  import type { ItemRef } from "app-config/common/ItemRef.js";
2
2
  import type { Operation } from "../Operation.js";
3
3
  import { OperationRegistry } from "../OperationRegistry.js";
4
- import type { Model } from "../common.js";
4
+ import type { HasFeatures, HasLayers, HasMaps, Model } from "../common.js";
5
5
  /**
6
6
  * The arguments for the arcade.run operation.
7
7
  */
8
- export interface RunArcadeArgs {
8
+ export interface RunArcadeArgs extends HasMaps, HasLayers, HasFeatures {
9
9
  /**
10
10
  * The stringified Arcade script to run. If this property is included, the
11
11
  * operation will return the result of the script.
@@ -15,14 +15,18 @@ export interface RunArcadeArgs {
15
15
  * The stringified Arcade script used to determine whether or not the
16
16
  * executeScript can/should be run. If no executeScript is provided and the
17
17
  * canExecuteScript returns a truthy value, the operation will return its
18
- * input arguments; otherwise, if the canEecuteScript returns a falsey
18
+ * input arguments; otherwise, if the canExecuteScript returns a falsey
19
19
  * value, it will throw a {@link Cancellation}.
20
20
  */
21
21
  canExecuteScript?: string;
22
22
  /**
23
23
  * An arguments object that provides named variables and associated values,
24
24
  * which can be referenced from within the executeScript and
25
- * canExecuteScript.
25
+ * canExecuteScript. Note that context variables will be passed in if
26
+ * available under the well known arcade variable names: $feature,
27
+ * $features, $map, and $layer and $featuremap a constructed arcade
28
+ * dictionary that exposes a feature mapping dictionary keyed via feature
29
+ * source ID with the following values: id, title and features.
26
30
  *
27
31
  * NOTE: All variable keys must consist of only lowercase letters;
28
32
  * camel-cased context variables will break the script when they are
@@ -53,7 +57,7 @@ export interface ItemPropertyPath {
53
57
  export declare class ArcadeOperations extends OperationRegistry {
54
58
  /**
55
59
  * Runs a stringified Arcade script. If only a string is passed in as an
56
- * argument, it is interpreted as an executeScript. If an executeSript is
60
+ * argument, it is interpreted as an executeScript. If an executeScript is
57
61
  * provided, the operation will return its result. If only a canExecute
58
62
  * script is provided and it returns a truthy result, the operation will
59
63
  * return its input arguments. If a canExecuteScript returns a falsey value,
@@ -4249,16 +4249,28 @@
4249
4249
  "description": "The arguments for the arcade.run operation.",
4250
4250
  "properties": {
4251
4251
  "arguments": {
4252
- "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
4252
+ "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. Note that context variables will be passed in if available under the well known arcade variable names: $feature, $features, $map, and $layer and $featuremap a constructed arcade dictionary that exposes a feature mapping dictionary keyed via feature source ID with the following values: id, title and features. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
4253
4253
  },
4254
4254
  "canExecuteScript": {
4255
- "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canEecuteScript returns a falsey value, it will throw a{@linkCancellation}.",
4255
+ "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canExecuteScript returns a falsey value, it will throw a{@linkCancellation}.",
4256
4256
  "type": "string"
4257
4257
  },
4258
4258
  "executeScript": {
4259
4259
  "description": "The stringified Arcade script to run. If this property is included, the operation will return the result of the script.",
4260
4260
  "type": "string"
4261
4261
  },
4262
+ "features": {
4263
+ "$ref": "#/definitions/FeaturesLike",
4264
+ "description": "Features to use for the command/operation."
4265
+ },
4266
+ "layers": {
4267
+ "$ref": "#/definitions/LayersLike",
4268
+ "description": "Layer(s) to use for the command/operation."
4269
+ },
4270
+ "maps": {
4271
+ "$ref": "MapsLike",
4272
+ "description": "Map(s) to use for the command/operation."
4273
+ },
4262
4274
  "watchHandles": {
4263
4275
  "description": "Properties used to set a series of watch handles and/or event listeners on an item that will trigger the canExecuteChanged event for the 'arcade.run' operation.",
4264
4276
  "items": {
@@ -6026,7 +6038,7 @@
6026
6038
  ]
6027
6039
  },
6028
6040
  "arcade.run": {
6029
- "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeSript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation }.",
6041
+ "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeScript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation }.",
6030
6042
  "enum": [
6031
6043
  "arcade.run"
6032
6044
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "51.2.0",
3
+ "version": "51.4.0",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "VertiGIS Viewer Specification",
6
6
  "type": "module",
package/version.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export declare const version = "51.2.0";
4
+ export declare const version = "51.4.0";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export const version = "51.2.0";
4
+ export const version = "51.4.0";