@vertigis/viewer-spec 56.9.1 → 56.11.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.
@@ -82,6 +82,7 @@ export interface BrandingColors {
82
82
  inputBorderDisabled: ColorConfig;
83
83
  itemHoverBackground: ColorConfig;
84
84
  itemSelectedBackground: ColorConfig;
85
+ loadingBarBackground: ColorConfig;
85
86
  none: ColorConfig;
86
87
  panelBorder: ColorConfig;
87
88
  primaryAccent: ColorConfig;
@@ -164,18 +164,32 @@ export interface SetVisualStateArgs {
164
164
  */
165
165
  export interface DisplayBusyStateArgs {
166
166
  /**
167
- * The title to display.
167
+ * The ID used to link a busy state to its caller. Web only.
168
+ */
169
+ id?: string;
170
+ /**
171
+ * The title to display. Mobile only.
168
172
  */
169
173
  title?: string;
170
174
  /**
171
175
  * The message to display.
172
176
  */
173
177
  message?: string;
178
+ /**
179
+ * The number of milliseconds to wait before displaying the message. Default
180
+ * is 3000. Web only.
181
+ */
182
+ messageDelayMs?: number;
174
183
  /**
175
184
  * The minimum duration, in milliseconds, that the busy state will be
176
- * displayed. Defaults to 500.
185
+ * displayed. Defaults to 500. Mobile only.
177
186
  */
178
187
  minimumDisplayDurationMs?: number;
188
+ /**
189
+ * The maximum number of milliseconds the busy state will be displayed. Web
190
+ * only.
191
+ */
192
+ maximumDisplayDurationMs?: number;
179
193
  }
180
194
  /**
181
195
  * A component's ID in the layout.
@@ -283,10 +297,8 @@ export declare class UICommands extends CommandRegistry {
283
297
  */
284
298
  get deactivate(): Command<ComponentId | Model>;
285
299
  /**
286
- * Displays a spinner and custom message to the user to indicate that the UI
287
- * is busy. Mobile only.
288
- *
289
- * @mobileOnly
300
+ * Displays a loading indicator and custom message to the user to indicate
301
+ * that the UI is busy.
290
302
  */
291
303
  get displayBusyState(): Command<DisplayBusyStateArgs>;
292
304
  /**
@@ -313,11 +325,10 @@ export declare class UICommands extends CommandRegistry {
313
325
  */
314
326
  get focus(): Command<FocusArgs>;
315
327
  /**
316
- * Hides the busy state if currently shown. Mobile only.
317
- *
318
- * @mobileOnly
328
+ * Hides the busy state if currently shown. In Web, requires the ID of the
329
+ * caller that was used to show the busy state.
319
330
  */
320
- get hideBusyState(): Command;
331
+ get hideBusyState(): Command<string | void>;
321
332
  /**
322
333
  * Hides a notification previously shown to the user.
323
334
  */
@@ -496,9 +507,6 @@ export declare class UIEvents extends EventRegistry {
496
507
  get reordered(): Event<ComponentId>;
497
508
  /**
498
509
  * Raised when the app's theme is changed. The argument is the theme id.
499
- * Mobile only.
500
- *
501
- * @mobileOnly
502
510
  */
503
511
  get themeChanged(): Event<string>;
504
512
  /**
@@ -1298,6 +1298,37 @@
1298
1298
  },
1299
1299
  "type": "object"
1300
1300
  },
1301
+ "DisplayBusyStateArgs": {
1302
+ "additionalProperties": false,
1303
+ "description": "Arguments for the \"ui.display-busy-state\" args.",
1304
+ "properties": {
1305
+ "id": {
1306
+ "description": "The ID used to link a busy state to its caller. Web only.",
1307
+ "type": "string"
1308
+ },
1309
+ "maximumDisplayDurationMs": {
1310
+ "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
1311
+ "type": "number"
1312
+ },
1313
+ "message": {
1314
+ "description": "The message to display.",
1315
+ "type": "string"
1316
+ },
1317
+ "messageDelayMs": {
1318
+ "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
1319
+ "type": "number"
1320
+ },
1321
+ "minimumDisplayDurationMs": {
1322
+ "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
1323
+ "type": "number"
1324
+ },
1325
+ "title": {
1326
+ "description": "The title to display. Mobile only.",
1327
+ "type": "string"
1328
+ }
1329
+ },
1330
+ "type": "object"
1331
+ },
1301
1332
  "DisplayNotificationArgs": {
1302
1333
  "additionalProperties": false,
1303
1334
  "description": "The arguments for the `ui.display-notification` command.",
@@ -14029,6 +14060,15 @@
14029
14060
  }
14030
14061
  ]
14031
14062
  },
14063
+ "ui.display-busy-state": {
14064
+ "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
14065
+ "enum": [
14066
+ "ui.display-busy-state"
14067
+ ]
14068
+ },
14069
+ "ui.display-busy-state:input": {
14070
+ "$ref": "#/definitions/DisplayBusyStateArgs"
14071
+ },
14032
14072
  "ui.display-notification": {
14033
14073
  "description": "Shows a notification to the user.",
14034
14074
  "enum": [
@@ -14038,6 +14078,18 @@
14038
14078
  "ui.display-notification:input": {
14039
14079
  "$ref": "#/definitions/DisplayNotificationArgs"
14040
14080
  },
14081
+ "ui.hide-busy-state": {
14082
+ "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
14083
+ "enum": [
14084
+ "ui.hide-busy-state"
14085
+ ]
14086
+ },
14087
+ "ui.hide-busy-state:input": {
14088
+ "type": [
14089
+ "string",
14090
+ "null"
14091
+ ]
14092
+ },
14041
14093
  "ui.hide-notification": {
14042
14094
  "description": "Hides a notification previously shown to the user.",
14043
14095
  "enum": [
@@ -14862,6 +14914,22 @@
14862
14914
  ],
14863
14915
  "type": "object"
14864
14916
  },
14917
+ {
14918
+ "additionalProperties": false,
14919
+ "properties": {
14920
+ "arguments": {
14921
+ "$ref": "#/definitions/ui.display-busy-state:input"
14922
+ },
14923
+ "name": {
14924
+ "$ref": "#/definitions/ui.display-busy-state"
14925
+ }
14926
+ },
14927
+ "required": [
14928
+ "name",
14929
+ "arguments"
14930
+ ],
14931
+ "type": "object"
14932
+ },
14865
14933
  {
14866
14934
  "additionalProperties": false,
14867
14935
  "properties": {
@@ -14878,6 +14946,22 @@
14878
14946
  ],
14879
14947
  "type": "object"
14880
14948
  },
14949
+ {
14950
+ "additionalProperties": false,
14951
+ "properties": {
14952
+ "arguments": {
14953
+ "$ref": "#/definitions/ui.hide-busy-state:input"
14954
+ },
14955
+ "name": {
14956
+ "$ref": "#/definitions/ui.hide-busy-state"
14957
+ }
14958
+ },
14959
+ "required": [
14960
+ "name",
14961
+ "arguments"
14962
+ ],
14963
+ "type": "object"
14964
+ },
14881
14965
  {
14882
14966
  "additionalProperties": false,
14883
14967
  "properties": {
@@ -15082,9 +15166,15 @@
15082
15166
  {
15083
15167
  "$ref": "#/definitions/ui.deactivate"
15084
15168
  },
15169
+ {
15170
+ "$ref": "#/definitions/ui.display-busy-state"
15171
+ },
15085
15172
  {
15086
15173
  "$ref": "#/definitions/ui.display-notification"
15087
15174
  },
15175
+ {
15176
+ "$ref": "#/definitions/ui.hide-busy-state"
15177
+ },
15088
15178
  {
15089
15179
  "$ref": "#/definitions/ui.hide-notification"
15090
15180
  },
@@ -9850,6 +9850,15 @@
9850
9850
  "ui.deactivated:input": {
9851
9851
  "type": "string"
9852
9852
  },
9853
+ "ui.theme-changed": {
9854
+ "description": "Raised when the app's theme is changed. The argument is the theme id.",
9855
+ "enum": [
9856
+ "ui.theme-changed"
9857
+ ]
9858
+ },
9859
+ "ui.theme-changed:input": {
9860
+ "type": "string"
9861
+ },
9853
9862
  "viewer-spec.Event": {
9854
9863
  "anyOf": [
9855
9864
  {
@@ -9924,6 +9933,9 @@
9924
9933
  {
9925
9934
  "$ref": "#/definitions/ui.deactivated"
9926
9935
  },
9936
+ {
9937
+ "$ref": "#/definitions/ui.theme-changed"
9938
+ },
9927
9939
  {
9928
9940
  "$ref": "#/definitions/workflow.workflow-error"
9929
9941
  },
@@ -1506,16 +1506,28 @@
1506
1506
  "additionalProperties": false,
1507
1507
  "description": "Arguments for the \"ui.display-busy-state\" args.",
1508
1508
  "properties": {
1509
+ "id": {
1510
+ "description": "The ID used to link a busy state to its caller. Web only.",
1511
+ "type": "string"
1512
+ },
1513
+ "maximumDisplayDurationMs": {
1514
+ "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
1515
+ "type": "number"
1516
+ },
1509
1517
  "message": {
1510
1518
  "description": "The message to display.",
1511
1519
  "type": "string"
1512
1520
  },
1521
+ "messageDelayMs": {
1522
+ "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
1523
+ "type": "number"
1524
+ },
1513
1525
  "minimumDisplayDurationMs": {
1514
- "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500.",
1526
+ "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
1515
1527
  "type": "number"
1516
1528
  },
1517
1529
  "title": {
1518
- "description": "The title to display.",
1530
+ "description": "The title to display. Mobile only.",
1519
1531
  "type": "string"
1520
1532
  }
1521
1533
  },
@@ -16184,7 +16196,7 @@
16184
16196
  ]
16185
16197
  },
16186
16198
  "ui.display-busy-state": {
16187
- "description": "Displays a spinner and custom message to the user to indicate that the UI is busy. Mobile only.",
16199
+ "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
16188
16200
  "enum": [
16189
16201
  "ui.display-busy-state"
16190
16202
  ]
@@ -16202,11 +16214,17 @@
16202
16214
  "$ref": "#/definitions/DisplayNotificationArgs"
16203
16215
  },
16204
16216
  "ui.hide-busy-state": {
16205
- "description": "Hides the busy state if currently shown. Mobile only.",
16217
+ "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
16206
16218
  "enum": [
16207
16219
  "ui.hide-busy-state"
16208
16220
  ]
16209
16221
  },
16222
+ "ui.hide-busy-state:input": {
16223
+ "type": [
16224
+ "string",
16225
+ "null"
16226
+ ]
16227
+ },
16210
16228
  "ui.hide-notification": {
16211
16229
  "description": "Hides a notification previously shown to the user.",
16212
16230
  "enum": [
@@ -18051,6 +18069,22 @@
18051
18069
  ],
18052
18070
  "type": "object"
18053
18071
  },
18072
+ {
18073
+ "additionalProperties": false,
18074
+ "properties": {
18075
+ "arguments": {
18076
+ "$ref": "#/definitions/ui.hide-busy-state:input"
18077
+ },
18078
+ "name": {
18079
+ "$ref": "#/definitions/ui.hide-busy-state"
18080
+ }
18081
+ },
18082
+ "required": [
18083
+ "name",
18084
+ "arguments"
18085
+ ],
18086
+ "type": "object"
18087
+ },
18054
18088
  {
18055
18089
  "additionalProperties": false,
18056
18090
  "properties": {
@@ -11923,7 +11923,7 @@
11923
11923
  "type": "string"
11924
11924
  },
11925
11925
  "ui.theme-changed": {
11926
- "description": "Raised when the app's theme is changed. The argument is the theme id. Mobile only.",
11926
+ "description": "Raised when the app's theme is changed. The argument is the theme id.",
11927
11927
  "enum": [
11928
11928
  "ui.theme-changed"
11929
11929
  ]
@@ -1995,6 +1995,37 @@
1995
1995
  },
1996
1996
  "type": "object"
1997
1997
  },
1998
+ "DisplayBusyStateArgs": {
1999
+ "additionalProperties": false,
2000
+ "description": "Arguments for the \"ui.display-busy-state\" args.",
2001
+ "properties": {
2002
+ "id": {
2003
+ "description": "The ID used to link a busy state to its caller. Web only.",
2004
+ "type": "string"
2005
+ },
2006
+ "maximumDisplayDurationMs": {
2007
+ "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
2008
+ "type": "number"
2009
+ },
2010
+ "message": {
2011
+ "description": "The message to display.",
2012
+ "type": "string"
2013
+ },
2014
+ "messageDelayMs": {
2015
+ "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
2016
+ "type": "number"
2017
+ },
2018
+ "minimumDisplayDurationMs": {
2019
+ "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
2020
+ "type": "number"
2021
+ },
2022
+ "title": {
2023
+ "description": "The title to display. Mobile only.",
2024
+ "type": "string"
2025
+ }
2026
+ },
2027
+ "type": "object"
2028
+ },
1998
2029
  "DisplayNotificationArgs": {
1999
2030
  "additionalProperties": false,
2000
2031
  "description": "The arguments for the `ui.display-notification` command.",
@@ -21585,6 +21616,15 @@
21585
21616
  }
21586
21617
  ]
21587
21618
  },
21619
+ "ui.display-busy-state": {
21620
+ "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
21621
+ "enum": [
21622
+ "ui.display-busy-state"
21623
+ ]
21624
+ },
21625
+ "ui.display-busy-state:input": {
21626
+ "$ref": "#/definitions/DisplayBusyStateArgs"
21627
+ },
21588
21628
  "ui.display-notification": {
21589
21629
  "description": "Shows a notification to the user.",
21590
21630
  "enum": [
@@ -21657,6 +21697,18 @@
21657
21697
  "ui.get-visual-state:output": {
21658
21698
  "type": "string"
21659
21699
  },
21700
+ "ui.hide-busy-state": {
21701
+ "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
21702
+ "enum": [
21703
+ "ui.hide-busy-state"
21704
+ ]
21705
+ },
21706
+ "ui.hide-busy-state:input": {
21707
+ "type": [
21708
+ "string",
21709
+ "null"
21710
+ ]
21711
+ },
21660
21712
  "ui.hide-notification": {
21661
21713
  "description": "Hides a notification previously shown to the user.",
21662
21714
  "enum": [
@@ -24129,6 +24181,22 @@
24129
24181
  ],
24130
24182
  "type": "object"
24131
24183
  },
24184
+ {
24185
+ "additionalProperties": false,
24186
+ "properties": {
24187
+ "arguments": {
24188
+ "$ref": "#/definitions/ui.display-busy-state:input"
24189
+ },
24190
+ "name": {
24191
+ "$ref": "#/definitions/ui.display-busy-state"
24192
+ }
24193
+ },
24194
+ "required": [
24195
+ "name",
24196
+ "arguments"
24197
+ ],
24198
+ "type": "object"
24199
+ },
24132
24200
  {
24133
24201
  "additionalProperties": false,
24134
24202
  "properties": {
@@ -24161,6 +24229,22 @@
24161
24229
  ],
24162
24230
  "type": "object"
24163
24231
  },
24232
+ {
24233
+ "additionalProperties": false,
24234
+ "properties": {
24235
+ "arguments": {
24236
+ "$ref": "#/definitions/ui.hide-busy-state:input"
24237
+ },
24238
+ "name": {
24239
+ "$ref": "#/definitions/ui.hide-busy-state"
24240
+ }
24241
+ },
24242
+ "required": [
24243
+ "name",
24244
+ "arguments"
24245
+ ],
24246
+ "type": "object"
24247
+ },
24164
24248
  {
24165
24249
  "additionalProperties": false,
24166
24250
  "properties": {
@@ -24785,12 +24869,18 @@
24785
24869
  {
24786
24870
  "$ref": "#/definitions/ui.deactivate"
24787
24871
  },
24872
+ {
24873
+ "$ref": "#/definitions/ui.display-busy-state"
24874
+ },
24788
24875
  {
24789
24876
  "$ref": "#/definitions/ui.display-notification"
24790
24877
  },
24791
24878
  {
24792
24879
  "$ref": "#/definitions/ui.focus"
24793
24880
  },
24881
+ {
24882
+ "$ref": "#/definitions/ui.hide-busy-state"
24883
+ },
24794
24884
  {
24795
24885
  "$ref": "#/definitions/ui.hide-notification"
24796
24886
  },
@@ -11081,6 +11081,15 @@
11081
11081
  "ui.reordered:input": {
11082
11082
  "type": "string"
11083
11083
  },
11084
+ "ui.theme-changed": {
11085
+ "description": "Raised when the app's theme is changed. The argument is the theme id.",
11086
+ "enum": [
11087
+ "ui.theme-changed"
11088
+ ]
11089
+ },
11090
+ "ui.theme-changed:input": {
11091
+ "type": "string"
11092
+ },
11084
11093
  "ui.visual-state-changed": {
11085
11094
  "description": "Raised when a component's visual state is changed. Web only.",
11086
11095
  "enum": [
@@ -11242,6 +11251,9 @@
11242
11251
  {
11243
11252
  "$ref": "#/definitions/ui.reordered"
11244
11253
  },
11254
+ {
11255
+ "$ref": "#/definitions/ui.theme-changed"
11256
+ },
11245
11257
  {
11246
11258
  "$ref": "#/definitions/ui.visual-state-changed"
11247
11259
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "56.9.1",
3
+ "version": "56.11.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 = "56.9.1";
4
+ export declare const version = "56.11.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 = "56.9.1";
4
+ export const version = "56.11.0";