@vertigis/viewer-spec 50.5.1 → 50.7.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.
@@ -22,6 +22,7 @@ export interface FeatureInfoModelProperties extends CommonFeatureDetailsModelPro
22
22
  onFeatureRemove?: Action;
23
23
  /**
24
24
  * A command or set of commands to execute when a related record is clicked.
25
+ * The related Feature is passed in as the argument for the command(s).
25
26
  */
26
27
  onRelatedRecordClick?: Action;
27
28
  /**
@@ -19,4 +19,9 @@ export interface FeatureSummaryModelProperties extends CommonFeatureDetailsModel
19
19
  * A command or set of commands to execute when the summary is clicked.
20
20
  */
21
21
  onFeatureClick?: Action;
22
+ /**
23
+ * A command or set of commands to execute when a related record is clicked.
24
+ * The related Feature is passed in as the argument for the command(s).
25
+ */
26
+ onRelatedRecordClick?: Action;
22
27
  }
@@ -1,12 +1,46 @@
1
- import type { ComponentModelProperties } from "./ComponentModelProperties.js";
1
+ import type { ServiceModelProperties } from "../common/ServiceModelProperties";
2
2
  import type { FeatureListProperties } from "./FeatureListProperties.js";
3
+ /**
4
+ * Values depicting part of the Popup Template that can be reordered.
5
+ */
6
+ export declare type PopupOrderElement = "popup-content" | "hyperlinks";
7
+ /**
8
+ * Properties to pass into the ViewSettings constructor.
9
+ */
10
+ export interface ViewSettingsProperties {
11
+ /**
12
+ * Whether to hide fields when they have null/empty values.
13
+ */
14
+ hideNullFields?: boolean;
15
+ /**
16
+ * The order of the popup elements within the results view. Excluded
17
+ * elements will not appear. In details views, the default is:
18
+ * ["popup-content", "hyperlinks"]. In summary views, the default is:
19
+ * ["popup-content"].
20
+ */
21
+ popupOrder?: PopupOrderElement[];
22
+ }
3
23
  /**
4
24
  * @inheritdoc
5
25
  */
6
- export interface ResultsServiceModelProperties extends ComponentModelProperties {
26
+ export interface ResultsServiceModelProperties extends ServiceModelProperties {
7
27
  /**
8
28
  * The name results list stored in the service. This property is only
9
29
  * serialized into saved projects.
10
30
  */
11
31
  results?: Record<string, FeatureListProperties>;
32
+ /**
33
+ * Settings that configure the way Result details are displayed in a detailed view.
34
+ */
35
+ detailsViewSettings?: ViewSettingsProperties;
36
+ /**
37
+ * Settings that configure the way Result details are displayed in a summary view.
38
+ */
39
+ summaryViewSettings?: ViewSettingsProperties;
40
+ /**
41
+ * The size of the summary card within the UI, in pixels. Setting a constant
42
+ * size for summary cards optimizes the performance when displaying many
43
+ * results in a virtualized list.
44
+ */
45
+ summaryCardHeight?: number;
12
46
  }
@@ -699,6 +699,55 @@
699
699
  <complexType>
700
700
  <complexContent>
701
701
  <extension base="tns:Component">
702
+ <attribute name="actionButtonSize" default="medium">
703
+ <annotation>
704
+ <documentation xml:lang="en">
705
+ The desired size for the action buttons. Web
706
+ only.
707
+ </documentation>
708
+ </annotation>
709
+ <simpleType>
710
+ <restriction base="string">
711
+ <enumeration value="small" />
712
+ <enumeration value="medium" />
713
+ <enumeration value="large" />
714
+ </restriction>
715
+ </simpleType>
716
+ </attribute>
717
+ <attribute name="relatedRecordDisplay" default="preview">
718
+ <annotation>
719
+ <documentation xml:lang="en">
720
+ The style in which related records are
721
+ displayed. Web only.
722
+ </documentation>
723
+ </annotation>
724
+ <simpleType>
725
+ <restriction base="string">
726
+ <enumeration value="preview" />
727
+ <enumeration value="table" />
728
+ </restriction>
729
+ </simpleType>
730
+ </attribute>
731
+ <attribute name="showActionIcons" type="boolean" default="true">
732
+ <annotation>
733
+ <documentation xml:lang="en">
734
+ Whether or not the icon should be displayed in
735
+ action buttons. If neither icons nor titles are
736
+ shown, then the action buttons will not display.
737
+ Web only.
738
+ </documentation>
739
+ </annotation>
740
+ </attribute>
741
+ <attribute name="showActionTitles" type="boolean" default="false">
742
+ <annotation>
743
+ <documentation xml:lang="en">
744
+ Whether or not the title should be displayed in
745
+ action buttons. If neither icons nor titles are
746
+ shown, then the action buttons will not display.
747
+ Web only.
748
+ </documentation>
749
+ </annotation>
750
+ </attribute>
702
751
  <attribute name="showStarControls" type="boolean" default="false">
703
752
  <annotation>
704
753
  <documentation xml:lang="en">
@@ -289,6 +289,12 @@ export declare class GeolocationCommands extends CommandRegistry {
289
289
  * @mobileOnly
290
290
  */
291
291
  get displayDeviceSelection(): Command;
292
+ /**
293
+ * Applies a datum transformation to the current GNSS device.
294
+ *
295
+ * @mobileOnly
296
+ */
297
+ get applyDatumTransformation(): Command<CoordinateTransformation | string | number | number[]>;
292
298
  }
293
299
  export declare class GeolocationOperations extends OperationRegistry {
294
300
  /**
@@ -1 +1 @@
1
- import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var GeolocateState;var GnssDeviceType;!function(e){e.DISABLED="Disabled",e.ENABLED="Enabled",e.RECENTERING="Recentering",e.RECENTERING_AND_REORIENTING="RecenteringAndReorienting"}(GeolocateState||(GeolocateState={})),function(e){e.INTEGRATED="integrated",e.BLUETOOTH="bluetooth",e.USB="usb",e.EMULATOR="emulator"}(GnssDeviceType||(GnssDeviceType={}));export var FixQuality;!function(e){e.INVALID="Invalid",e.GPS_FIX="GpsFix",e.DGPS_FIX="DgpsFix",e.PPS_FIX="PpsFix",e.RTK="Rtk",e.FLOAT_RTK="FloatRtk",e.ESTIMATED="Estimated",e.MANUAL_INPUT="ManualInput",e.SIMULATION="Simulation"}(FixQuality||(FixQuality={}));export var GpgsaFixMode;!function(e){e.NOT_AVAILABLE="NotAvailable",e.FIX_2D="Fix2D",e.FIX_3D="Fix3D"}(GpgsaFixMode||(GpgsaFixMode={}));export var GnssLockStatus;!function(e){e[e.Good=0]="Good",e[e.UncorrectedPosition=1]="UncorrectedPosition",e[e.EstimatedAccuracy=2]="EstimatedAccuracy",e[e.LostConnection=4]="LostConnection",e[e.NoLocation=16]="NoLocation",e[e.Integrated=32]="Integrated"}(GnssLockStatus||(GnssLockStatus={}));export class GeolocationCommands extends CommandRegistry{get autoRecenter(){return this._messages.command("geolocation.auto-recenter")}get autoRecenterAndReorient(){return this._messages.command("geolocation.auto-recenter-and-reorient")}get displayLocation(){return this._messages.command("geolocation.display-location")}get turnOffGeolocation(){return this._messages.command("geolocation.turn-off-geolocation")}get displayDeviceSettings(){return this._messages.command("geolocation.display-device-settings")}get displayDeviceMetadata(){return this._messages.command("geolocation.display-device-metadata")}get displayDeviceSelection(){return this._messages.command("geolocation.display-device-selection")}}export class GeolocationOperations extends OperationRegistry{get changeSource(){return this._messages.operation("geolocation.change-source")}get getActiveSource(){return this._messages.operation("geolocation.get-active-source")}get getAllSources(){return this._messages.operation("geolocation.get-all-sources")}get getCurrentState(){return this._messages.operation("geolocation.get-current-state")}get getLocationPermissionsEnabled(){return this._messages.operation("geolocation.get-location-permissions-enabled")}get getPosition(){return this._messages.operation("geolocation.get-position")}get getCoordinateTransformations(){return this._messages.operation("geolocation.get-coordinate-transformations")}}export class GeolocationEvents extends EventRegistry{get accuracyChanged(){return this._messages.event("geolocation.accuracy-changed")}get metadataChanged(){return this._messages.event("geolocation.metadata-changed")}get autoRecenterStarted(){return this._messages.event("geolocation.auto-recenter-started")}get autoRecenterAndReorientStarted(){return this._messages.event("geolocation.auto-recenter-and-reorient-started")}get autoRecenterStopped(){return this._messages.event("geolocation.auto-recenter-stopped")}get autoRecenterAndReorientStopped(){return this._messages.event("geolocation.auto-recenter-and-reorient-stopped")}get gnssDeviceDetectionStarted(){return this._messages.event("geolocation.gnss-device-detection-started")}get gnssDeviceDetectionStopped(){return this._messages.event("geolocation.gnss-device-detection-stopped")}get gnssLockStatusChanged(){return this._messages.event("geolocation.gnss-lock-status-changed")}get headingChanged(){return this._messages.event("geolocation.heading-changed")}get positionAcquired(){return this._messages.event("geolocation.position-acquired")}get positionChanged(){return this._messages.event("geolocation.position-changed")}get positionLost(){return this._messages.event("geolocation.position-lost")}get sourceChanged(){return this._messages.event("geolocation.source-changed")}get statusChanged(){return this._messages.event("geolocation.status-changed")}get displayLocationStarted(){return this._messages.event("geolocation.display-location-started")}get displayLocationStopped(){return this._messages.event("geolocation.display-location-stopped")}get transformationChanged(){return this._messages.event("geolocation.gnss-transformation-changed")}get antennaHeightChanged(){return this._messages.event("geolocation.gnss-antenna-height-changed")}get locationDisplayModeChanged(){return this._messages.event("geolocation.display-mode-changed")}}
1
+ import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var GeolocateState;var GnssDeviceType;!function(e){e.DISABLED="Disabled",e.ENABLED="Enabled",e.RECENTERING="Recentering",e.RECENTERING_AND_REORIENTING="RecenteringAndReorienting"}(GeolocateState||(GeolocateState={})),function(e){e.INTEGRATED="integrated",e.BLUETOOTH="bluetooth",e.USB="usb",e.EMULATOR="emulator"}(GnssDeviceType||(GnssDeviceType={}));export var FixQuality;!function(e){e.INVALID="Invalid",e.GPS_FIX="GpsFix",e.DGPS_FIX="DgpsFix",e.PPS_FIX="PpsFix",e.RTK="Rtk",e.FLOAT_RTK="FloatRtk",e.ESTIMATED="Estimated",e.MANUAL_INPUT="ManualInput",e.SIMULATION="Simulation"}(FixQuality||(FixQuality={}));export var GpgsaFixMode;!function(e){e.NOT_AVAILABLE="NotAvailable",e.FIX_2D="Fix2D",e.FIX_3D="Fix3D"}(GpgsaFixMode||(GpgsaFixMode={}));export var GnssLockStatus;!function(e){e[e.Good=0]="Good",e[e.UncorrectedPosition=1]="UncorrectedPosition",e[e.EstimatedAccuracy=2]="EstimatedAccuracy",e[e.LostConnection=4]="LostConnection",e[e.NoLocation=16]="NoLocation",e[e.Integrated=32]="Integrated"}(GnssLockStatus||(GnssLockStatus={}));export class GeolocationCommands extends CommandRegistry{get autoRecenter(){return this._messages.command("geolocation.auto-recenter")}get autoRecenterAndReorient(){return this._messages.command("geolocation.auto-recenter-and-reorient")}get displayLocation(){return this._messages.command("geolocation.display-location")}get turnOffGeolocation(){return this._messages.command("geolocation.turn-off-geolocation")}get displayDeviceSettings(){return this._messages.command("geolocation.display-device-settings")}get displayDeviceMetadata(){return this._messages.command("geolocation.display-device-metadata")}get displayDeviceSelection(){return this._messages.command("geolocation.display-device-selection")}get applyDatumTransformation(){return this._messages.command("geolocation.apply-datum-transformation")}}export class GeolocationOperations extends OperationRegistry{get changeSource(){return this._messages.operation("geolocation.change-source")}get getActiveSource(){return this._messages.operation("geolocation.get-active-source")}get getAllSources(){return this._messages.operation("geolocation.get-all-sources")}get getCurrentState(){return this._messages.operation("geolocation.get-current-state")}get getLocationPermissionsEnabled(){return this._messages.operation("geolocation.get-location-permissions-enabled")}get getPosition(){return this._messages.operation("geolocation.get-position")}get getCoordinateTransformations(){return this._messages.operation("geolocation.get-coordinate-transformations")}}export class GeolocationEvents extends EventRegistry{get accuracyChanged(){return this._messages.event("geolocation.accuracy-changed")}get metadataChanged(){return this._messages.event("geolocation.metadata-changed")}get autoRecenterStarted(){return this._messages.event("geolocation.auto-recenter-started")}get autoRecenterAndReorientStarted(){return this._messages.event("geolocation.auto-recenter-and-reorient-started")}get autoRecenterStopped(){return this._messages.event("geolocation.auto-recenter-stopped")}get autoRecenterAndReorientStopped(){return this._messages.event("geolocation.auto-recenter-and-reorient-stopped")}get gnssDeviceDetectionStarted(){return this._messages.event("geolocation.gnss-device-detection-started")}get gnssDeviceDetectionStopped(){return this._messages.event("geolocation.gnss-device-detection-stopped")}get gnssLockStatusChanged(){return this._messages.event("geolocation.gnss-lock-status-changed")}get headingChanged(){return this._messages.event("geolocation.heading-changed")}get positionAcquired(){return this._messages.event("geolocation.position-acquired")}get positionChanged(){return this._messages.event("geolocation.position-changed")}get positionLost(){return this._messages.event("geolocation.position-lost")}get sourceChanged(){return this._messages.event("geolocation.source-changed")}get statusChanged(){return this._messages.event("geolocation.status-changed")}get displayLocationStarted(){return this._messages.event("geolocation.display-location-started")}get displayLocationStopped(){return this._messages.event("geolocation.display-location-stopped")}get transformationChanged(){return this._messages.event("geolocation.gnss-transformation-changed")}get antennaHeightChanged(){return this._messages.event("geolocation.gnss-antenna-height-changed")}get locationDisplayModeChanged(){return this._messages.event("geolocation.display-mode-changed")}}
@@ -12870,6 +12870,31 @@
12870
12870
  },
12871
12871
  "type": "array"
12872
12872
  },
12873
+ "geolocation.apply-datum-transformation": {
12874
+ "description": "Applies a datum transformation to the current GNSS device.",
12875
+ "enum": [
12876
+ "geolocation.apply-datum-transformation"
12877
+ ]
12878
+ },
12879
+ "geolocation.apply-datum-transformation:input": {
12880
+ "anyOf": [
12881
+ {
12882
+ "items": {
12883
+ "type": "number"
12884
+ },
12885
+ "type": "array"
12886
+ },
12887
+ {
12888
+ "$ref": "#/definitions/CoordinateTransformation"
12889
+ },
12890
+ {
12891
+ "type": [
12892
+ "string",
12893
+ "number"
12894
+ ]
12895
+ }
12896
+ ]
12897
+ },
12873
12898
  "geolocation.auto-recenter": {
12874
12899
  "description": "Centers the map on the user's current location and keeps the location centered as it moves around. The maps parameter is only supported in VertiGIS Studio Mobile. In VertiGIS Studio Web, all maps are affected.",
12875
12900
  "enum": [
@@ -14958,6 +14983,22 @@
14958
14983
  ],
14959
14984
  "type": "object"
14960
14985
  },
14986
+ {
14987
+ "additionalProperties": false,
14988
+ "properties": {
14989
+ "arguments": {
14990
+ "$ref": "#/definitions/geolocation.apply-datum-transformation:input"
14991
+ },
14992
+ "name": {
14993
+ "$ref": "#/definitions/geolocation.apply-datum-transformation"
14994
+ }
14995
+ },
14996
+ "required": [
14997
+ "name",
14998
+ "arguments"
14999
+ ],
15000
+ "type": "object"
15001
+ },
14961
15002
  {
14962
15003
  "additionalProperties": false,
14963
15004
  "properties": {
@@ -16560,6 +16601,9 @@
16560
16601
  {
16561
16602
  "$ref": "#/definitions/file.open-file"
16562
16603
  },
16604
+ {
16605
+ "$ref": "#/definitions/geolocation.apply-datum-transformation"
16606
+ },
16563
16607
  {
16564
16608
  "$ref": "#/definitions/geolocation.auto-recenter"
16565
16609
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "50.5.1",
3
+ "version": "50.7.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 = "50.5.1";
4
+ export declare const version = "50.7.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 = "50.5.1";
4
+ export const version = "50.7.0";