Commands, Operations and Events Reference

Commands and operations are runnable, independent units of work within Geocortex Mobile. Commands are units of work which may take an input but do not produce an output, while operations differ because they produce output. You can learn more about commands and operations in our conceptual documentation

Events are distinct, discrete messaging about a change or update that occurs in the viewer. They can be used to initiate behaviors, communicate data changes, and more. Events themselves do not execute behavior, but merely provide messaging so subscribers can act on changes. You can learn more about events in the event reference

Commands

app.favorite

Adds the currently loaded app to the user's Favorites collection. Mobile only.
Argument
There are no arguments

app.go-to-app-selector

Returns to the app selector view where the user can select a different app. Only enabled if the current app was launched through VertiGIS Studio Go. Mobile only.
Argument
There are no arguments

app.refresh

Refreshes the currently loaded app so that it can download updates if available. Mobile only.
Argument
There are no arguments

app.set-persistent-data

Stores data specified by the arguments (key and scope). Mobile only.
Argument
SaveStorageDataArgs

app.unfavorite

Removes the currently loaded app from the user's Favorites collection. Mobile only.
Argument
There are no arguments

auth.sign-in

Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile.
Argument (optional)
boolean

auth.sign-out

Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile.
Argument (optional)
boolean

basemap.set

Switch to a configured basemap.
Argument
Any of:
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension[]
string

debug-console.close

Closes the Debug Console. Deprecated; use log-viewer.close instead. Mobile only.
Argument
There are no arguments

debug-console.display

Displays the Debug Console. Deprecated; use log-viewer.display instead. Mobile only.
Argument
There are no arguments

drawing.draw

Allows the user to draw on the map by capturing geometry, creating a graphic, and persisting the graphic on the map. This is a shortcut for the command chain ["sketching.capture-geometry", "drawing.create-graphics", "map.add-markup"]. Some default geometryEditorSettings are also applied. Mobile only.
Argument
CaptureGeometryArgs

drawing.set-sync

Sets a value that determines whether drawings will be synced automatically across maps.
Argument
boolean

edit.add-attachment

Create and add an attachment to a provided feature, using the given attachment data.
Argument
Any of:

edit.add-feature

Adds a feature to a particular layer. `Features` and `EditCommandArgs` are not supported on Mobile.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

edit.clear-gnss-metadata

Clears a feature's GNSS metadata. This command will clear the well known GNSS attributes, such as "esrignss_longitude" and "esrignss_latitude".
Argument
@vertigis.arcgis-extensions.data.Feature.Feature

edit.delete-attachment

Deletes attachments from feature(s).
Argument
DeleteAttachmentArgs

edit.delete-features

Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

edit.display-add-feature

Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile. **Example:** Create and allow the user to edit a new feature with an initial attributes collection. If no geometry is provided in context they will be asked to select one. _Note:_ $map1.map.extension is the output of a 'Get Map' activity run in Web by Workflow. When the map and/or layer are provided in the context of a command chain these parameters can be omitted. ``` { "editAttributes": true, "editGeometry": true, "featureAttributes": { "ASSET_ID": "WFH001234" }, "layers": "Victoria_Fire_Hydrants_8780", "maps": $map1.map.extension } ```
Argument
Any of:
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource

edit.display-add-related-feature

Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship. **Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required. _Notes:_. 1. The feature used here must come from the running viewer, and cannot be an ad-hoc feature created from a JSON object. For example, you can use the output of `results.get-active-features`, or the feature provided in a command chain context. 2. `editableExpression` and `requiredExpression` both take an arcade expression, and here the string "true" is just a simple arcade expression that always returns true. You can also use a more complex expression, or reference one from your webmap. ``` { "editAttributes": true, "editAttachments": true, "features": $runOperation1.result, "relationshipId": "1", "fieldElements": [ { "fieldName": "COMMENTS", "editableExpression": "true", "requiredExpression": "true" } ] } ```
Argument
DisplayAddRelatedFeatureArgs

edit.display-update-feature

Begin an interactive feature editing session with an existing feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature

edit.update-feature

Updates a layer feature or features. Edits to the geometry and attributes of the supplied features will be committed to their respective feature sources. `Features` and `EditCommandArgs` are not supported on Mobile.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

file.open-file

Opens a file in an app assigned to the file type. Mobile only.
Argument
Any of:
string

geolocation.apply-datum-transformation

Applies a datum transformation to the current GNSS device. Mobile only.
Argument
Any of:
number[]
string
number

geolocation.auto-recenter

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.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

geolocation.auto-recenter-and-reorient

Centers the map on the user's current location and updates the orientation of the map to face the direction of the device. Keeps the location centered as it moves around. Returns whether guiding started successfully. Mobile only.
Argument
HasMaps

geolocation.change-source

Updates the currently active GNSS receiver. Mobile only.
Argument
GnssDeviceConnectionInfo

geolocation.display-device-metadata

Displays the GNSS device metadata view. Mobile only.
Argument
There are no arguments

geolocation.display-device-selection

Displays the GNSS device selection view. Mobile only.
Argument
There are no arguments

geolocation.display-device-settings

Displays the GNSS device settings view. Mobile only.
Argument
GnssDeviceConnectionInfo

geolocation.display-location

Show the user's location while the location is in the map's extent.
Argument
There are no arguments

geolocation.get-active-source

Gets the currently active geolocation source. Mobile only.
Argument
GnssDeviceConnectionInfo

geolocation.set-location-symbol

Modifies the location display symbol. Mobile only.
Argument
SetLocationSymbolArgs

geolocation.turn-off-geolocation

Turns off geolocation.
Argument
There are no arguments

geometry-toolbar.hide

Hides the Geometry Toolbar. Mobile only.
Argument (optional)

geometry-toolbar.show

Shows the Geometry Toolbar. Mobile only.
Argument (optional)

highlights.add

Applies highlighting to one or more features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

highlights.add-focus

Adds focused-state highlighting to one or more features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

highlights.clear

Removes highlighting from all features on the given map(s). If no map is provided, features from all maps will be cleared.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

highlights.clear-focus

Removes focused-state highlighting from all features.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

highlights.hide

Hides all highlight overlays (can be undone with highlights.show). Mobile only.
Argument
HasMaps

highlights.hide-focus

Hides the focus highlight (can be undone with highlights.show-focus). Mobile only.
Argument
HasMaps

highlights.pulse

Adds a temporary focused-state highlight to one or more features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

highlights.refresh

Refreshes highlighting for one or many features. Mobile only.
Argument
HasMapsAndFeatures

highlights.remove

Removes highlighting from one or many features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

highlights.remove-focus

Removes focused-state highlighting from one or more features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

highlights.show

Shows all highlight overlays (makes not hidden). Mobile only.
Argument
HasMaps

highlights.show-focus

Shows the highlight focus (makes focus not hidden). Mobile only.
Argument
HasMaps

iwtm.open

Displays the I Want To Menu with the given ID. Mobile only.
Argument
string

layer-presets.apply

Applies a layer-preset to a map. Applying a layer-preset means that the layer visibilities, opacity, and the map's basemap are changed to match the layer-preset definition. It's a quick way for a user to toggle the state of the map to a pre-configured state. Mobile only.
Argument
LayerPresetsArgs

log-viewer.close

Closes the Log Viewer. Mobile only.
Argument
There are no arguments

log-viewer.display

Displays the Log Viewer. Mobile only.
Argument
There are no arguments

map.add-markup

Adds markup to the map(s). **Example:** Adding markup to a custom collection using `AddMarkupArgs`. ``` { "collection": "my-custom-markup", "graphics": [ { "geometry": { "x": -13733416.69, "y": 6177670.86, "spatialReference": { "wkid": 3857 }, "type": "point" }, "symbol": { "color": [76, 115, 0, 255], "size": 16, "style": "esriSMSCircle", "type": "simple-marker" } } ] } ```
Argument
Any of:
esri/Graphic
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]

map.clear-markup

Clears all markup from the map(s).
Argument (optional)

map.disable-map-click

Disables the click event handler on the map, so that if the user clicks on the map, the configured handler will not be invoked. Mobile only.
Argument
HasMaps

map.display-extent-selector

Displays a square overlay on the map that allows the user to change the map extent within the overlay. Mobile only.
Argument
DisplayExtentSelectorArgs

map.enable-map-click

Enables the click event handler on the map, so that if the user clicks on the map, the configured handler will be invoked. Mobile only.
Argument
HasMaps

map.hide-extent-selector

Hides the extent selector overlay on the map. Mobile only.
Argument
HasMaps

map.pan-to-features

Pans (without zooming) to one or many features on the targeted map(s).
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

map.pause-sketch

Pauses sketching on the map. Stores the current sketch editor and geometry for later use. Mobile only.
Argument
HasMaps

map.refresh

Refreshes / reloads the map. Mobile only.
Argument
HasMaps

map.replace

Replaces the entire current map in the MapExtension and in the map component with a different map. Mobile only.
Argument
ReplaceMapArgs

map.replace-additional-layers

Replaces the additional layers on top of an mmpk with a new set of layers, when using mmpk + WebMap. The mmpk part of the map is retained. Mobile only.
Argument
ReplaceMapArgs

map.replace-mmpk

Replaces the underlying mmpk part of the map when using mmpk + WebMap. The additional layers on top of the mmpk data are retained. Mobile only.
Argument
ReplaceMapArgs

map.resume-sketch

Resumes sketching on the map. Uses the sketch editor and geometry stored when pausing. Mobile only.
Argument
HasMaps

map.rotate-by

Rotates the map by the specified amount.
Argument
MapRotateArgs

map.rotate-to

Rotates the map to the specified angle.
Argument
MapRotateArgs

map.zoom-to-features

Zooms to one or many features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

map.zoom-to-initial-viewpoint

Zooms the map to its initial viewpoint.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

map.zoom-to-viewpoint

Go to the given viewpoint.
Argument
Any of:
@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties
esri/Viewpoint
esri.rest-api.ViewpointJson.ViewpointJson
@vertigis.arcgis-extensions.mapping.Bookmark.Bookmark

measurement.clear

Stops drawing and clears graphics from the map. Mobile only.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

measurement.set-geometry-mode

Sets the geometry mode in use. Mobile only.
Argument
GeometryModeArgs

measurement.start

Starts drawing a measurement on the map. If a drawing has previously been started and stopped it will be resumed. Mobile only.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

measurement.stop

Stops drawing a measurement on the map. Graphic remains visible and drawing can be resumed. Mobile only.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]

network.disable-web-requests

Turns on Disconnected Mode which prevents the app from making web requests independent of the device's network connectivity.
Argument
There are no arguments

network.enable-web-requests

Turns off Disconnected Mode allowing the device to make web requests if it has a network connection.
Argument
There are no arguments

offline.cancel-create-area

Cancels any create offline map area operation in progress and resets the form used to create custom offline map areas. Mobile only.
Argument
There are no arguments

offline.cancel-download

Cancels the download of the specified offline area, if it is currently in progress. Mobile only.
Argument
OfflineCommandArgs

offline.delete-area

Deletes the data stored on the device for the specified offline area. If a custom offline area is specified, and the area is not downloaded, deletes the custom area definition instead. Mobile only.
Argument
OfflineCommandArgs

offline.display-create-area

Displays a form that allows for the creation of a custom offline map area. Mobile only.
Argument
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension

panel.anchor-host-panel

Anchors the host panel so that content will open with a certain offset from the left or right side of the application (depending on if provided anchor component is on the left or right side of the app). Mobile only.
Argument
AnchorHostPanelArgs

panel.close-host-panel

Closes the host panel. If a component is specified, the panel is only closed if the specified component is currently open in the host panel. If no component is specified (input null), then the host panel will always be closed. Mobile only.
Argument
ComponentBase

panel.open-host-panel

Displays the specified component in the host panel (a view that slides out from the side of the screen). The component input parameter is required, and if you don't provide it, or pass in a component that is already hosted elsewhere in the application, you will get an exception. Mobile only.
Argument
ComponentBase

panel.snap-host-panel

Snaps the host panel to a particular position (eg. Middle, top, or hidden). For use only with the horizontal taskbar on mobile phones, where the taskbar panel content slides up from the bottom. Mobile only.
Argument
SnapHostPanelArgs

photos.display-details

Displays a photo in expanded / details view. Mobile only.
Argument
DisplayPhotoDetailsArgs

photos.hide-details

Hides the currently displayed photo details. Mobile only.
Argument
There are no arguments

printing.run

Run a print job with a given map and template/layout.
Argument
Any of:

results.add

Adds features to a currently shown set of features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
unknown

results.clear

Clear features from results list, results table, and results details. If a component model or model ID is given, then only the specified component is cleared (Web only).
Argument (optional)
Any of:
string

results.clear-details

Clears the feature details so that no feature data is shown. Mobile only.
Argument
There are no arguments

results.display

Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only).
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.display-details

Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (Web only).
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.display-new-details

Presents new feature details to the user within the feature-details component. If the feature-details component is contained within a panel, a 'back' button will be provided to navigate to the previous content; otherwise, the content of the feature-details component will be replaced.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.hide-details

Deactivates the feature details component that is displaying the given feature. Mobile only.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.intersect

Removes features from the existing results that are not present in the given list of features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
unknown

results.open-attachment

Opens an attachment and displays it. Mobile only.
Argument
OpenAttachmentArgs

results.refresh

Refreshes one or more features in the results list. Mobile only.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.remove

Removes features from a currently shown set of features.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
unknown

search.clear

Clears the search input.
Argument
There are no arguments

search.set-source

Sets the search source. Mobile only.
Argument
"addresses" | "features"

sketching.add-point

Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.
Argument
AddPointArgs

sketching.add-point-at-center

Adds a point at the center of the map while editing a geometry. Works in centerCrosshair mode only. Mobile only.
Argument
HasMaps

sketching.add-point-at-current-location

Adds a point at the user's current location while editing a geometry. Mobile only.
Argument
HasMaps

sketching.clear-constraints

Clears constraints that have been previously set. Mobile only.
Argument
ClearConstraintsArgs

sketching.delete

If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied, any active points in the session will be deleted. If there are no active points in the session, the entire geometry will be deleted.
Argument (optional)

sketching.insert-point

Inserts a point into a polygon, polyline, or multipoint at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.
Argument
InsertPointArgs

sketching.redo

Redoes the last undone edit while editing a geometry.
Argument
HasMaps

sketching.set-constraints

Sets constraints on the active sketch. Mobile only.
Argument
SetConstraintsArgs

sketching.set-geometry-mode

Sets the geometry mode of the geometry editor.
Argument
SetGeometryModeArgs

sketching.set-interaction-mode

Sets the interaction mode of the geometry editor. Mobile only.
Argument
SetInteractionModeArgs

sketching.set-point-at-current-location

Sets a point at the user's current location while editing a geometry. In this context, "set" means to either add a point at the current location, or update the currently selected point to be the user's current location, depending on what edit mode the user is in. Mobile only.
Argument
HasMaps

sketching.set-snapping-configuration

Sets the global snapping configuration.
Argument
SetSnappingConfigurationArgs

sketching.start-streaming

Starts streaming: recording your location at regular intervals and adding the collected points to the currently active geometry editor. Mobile only.
Argument
StartStreamingArgs

sketching.stop-streaming

Stops streaming. Mobile only.
Argument
HasMaps

sketching.undo

Undoes the last edit while editing a geometry.
Argument
HasMaps

studio-analytics.track-custom-event

Sends a custom event to VertiGIS Studio Analytics. If the app is not configured to use Analytics, then nothing will happen.
Argument
TrackCustomEventArgs

system.disable-background-location-updates

Disables background location updates. Mobile only.
Argument
BackgroundLocationUpdatesArgs

system.enable-background-location-updates

Enables background location updates. While enabled, the application will continue to execute code while running in the background. Note for iOS: If the user has not accepted location permissions for the app, no code will be allowed to execute in the background. Mobile only.
Argument
EnableBackgroundLocationUpdateArgs

system.haptics

Performs system haptics with a given style, if the device supports it. Uses 'taptics' when available, otherwise uses vibration. Mobile only.
Argument
"error" | "heavy" | "light" | "medium" | "success" | "warning"

system.keep-screen-on

Allows to control if the screen should be kept on. Passing true as parameter will keep the screen on, ignoring possible system settings for screen timeouts. Passing false as parameter will make the app respect system settings again. Mobile only.
Argument
boolean

system.open-url

Opens a URL, either in the system browser or whatever app is appropriate for the scheme of the URL. If {@link Features } are included as context, then the URL may contain substitution tokens in the format {FIELD_NAME} where FIELD_NAME is the name of a field in the first feature in the context. In this case, the {FIELD_NAME} is substituted with value of the FIELD_NAME field from the feature feature in the {@link Features }, e.g. https://www.google.com/search?q={NAME}, where the value of the NAME field in the first feature from the context is 'Jasper National Park' would produce the result https://www.google.com/search?q=Jasper National Park. Zero to many substitution tokens may be included. If maps are included as context, {@link LocationToken} can be used to access properties on the first map's view. In Web, if both layers and maps are included as context, then {@link LayerToken} can be used to access properties on the first layer.
Argument
Any of:
string

ui.activate

Activates a component with the given ID or model, causing it to become visible. For VertiGIS Studio Mobile, only ID is supported.
Argument
Any of:
string

ui.active-toggle

Toggles the active state on a component with the given ID. Mobile only.
Argument
string

ui.alert

Shows an alert to the user.
Argument
AlertCommandArgs

ui.await

Waits (does nothing) for the specified period. The UI will remain active during this period. This is primarily intended to be used for testing and troubleshooting. Mobile only.
Argument
number

ui.deactivate

Deactivates a component with the given ID, causing it to disappear. For VertiGIS Studio Mobile, only ID is supported.
Argument
Any of:
string

ui.display-busy-state

Displays a loading indicator and custom message to the user to indicate that the UI is busy.
Argument
DisplayBusyStateArgs

ui.display-notification

Shows a notification to the user.
Argument
DisplayNotificationArgs

ui.hide-busy-state

Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.
Argument (optional)
string

ui.hide-notification

Hides a notification previously shown to the user.
Argument (optional)

ui.make-available

Marks a component as being available. The interpretation of what effect this has is up to the component. Currently the only component that will react to this is the task-bar, which will have the effect of showing the tab/button for that component. The argument can be an id of the component, or the model for the component. Mobile only.
Argument
Any of:
string

ui.make-unavailable

Marks a component as being unavailable. The interpretation of what effect this has is up to the component. Currently the only component that will react to this is the task-bar, which will have the effect of hiding the tab/button for that component, and deactivating the component. The argument can be an id of the component, or the model for the component. Mobile only.
Argument
Any of:
string

ui.pause-notifications

Pauses display of notifications until resumed. Mobile only.
Argument
There are no arguments

ui.resume-notifications

If notifications are currently paused, resumes displaying notifications. Mobile only.
Argument
There are no arguments

ui.set-theme

Sets the color theme of the viewer. The required argument is the new theme's ID.
Argument
string

utility-network.show-trace-panel

Displays the UI panel to perform a named trace. Mobile only. Only available to VertiGIS Networks customers.
Argument
There are no arguments

viewer.log-debug

Writes the operation context object to the console or log viewer at the debug level.
Argument
unknown

viewer.publish-event

Publish an event with specified parameters "name" and "arguments". This command supports sending custom events (i.e. you use your own namespaced eventname) as well as built-in events. Mobile only.
Argument
PublishEventArgs

workflow.cancel

Cancels a workflow with the given ID. Mobile only.
Argument
string

workflow.cancel-all

Cancels all running workflows. Mobile only.
Argument
There are no arguments

workflow.refresh

Refreshes (i.e. cancels and reruns) a workflow with the specified ID (corresponding to the workflow ID as configured in app.json, not the workflow's portal item ID). Mobile only.
Argument
string

workflow.run

Runs a workflow with the given arguments. See the `workflow.evaluate` operation if you want to run a workflow and expect output values to be returned.
Argument
RunWorkflowArgs

Operations

app.get-persistent-data

Gets stored data, specified by the arguments (key and scope).
Argument
StorageDataArgs
Result
unknown

app.remove-persistent-data

Removes stored data, specified by the arguments (key and scope). Returns true if the data was removed, false otherwise. Mobile only.
Argument
StorageDataArgs
Result
boolean

auth.get-current-user

Gets the user that is currently signed into the application.
Argument
There are no arguments
Result
Principal

auth.get-existing-credential

Looks for an existing Esri credential. Does not prompt the user to sign in if credential cannot be found. Mobile only.
Argument
esriRuntimeSdk.CredentialRequestInfo
Result
esriRuntimeSdk.Credential

basemap.get-all

Gets all configured basemaps. Having argument: - Multiple maps: the union of all basemap options from each - No maps: the union of all basemap options for every map in the application.
Argument
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Result
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension[]

basemap.get-current

Gets currently selected basemap for the given map. If more than one map is specified, only the first map is used.
Argument
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Result
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension

drawing.create-graphics

Creates graphics. In Web, creates graphics out of GeometryLike or CreateGraphicsArgs, with the current symbols that are set on the DrawManager. In Mobile, creates graphics from the given CreateGraphicsArgs or CreateGraphicsArgs[] (or some GeometryLike args). Any provided symbol parameter is used, otherwise a default symbol is used.
Argument
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
Result
CreateGraphicsResult

edit.update-gnss-metadata

Automatically populates the well known GNSS attributes from the current location data. Examples of well known GNSS attributes are "esrignss_longitude" and "esrignss_latitude". The input feature argument may be null, in which case a new feature will be created. Returns the input feature, or a new feature if one was created.
Argument
@vertigis.arcgis-extensions.data.Feature.Feature
Result
@vertigis.arcgis-extensions.data.Feature.Feature

file.pick-file

Prompt the user to select a file from the file system, and return the resulting data. Mobile only.
Argument
PickFileArgs
Result
EnhancedFileData

geocode.count

Counts the number of locations corresponding to an address.
Argument
GeocodeArgs
Result
@vertigis.arcgis-extensions.tasks.CountResult.CountResult

geocode.geocode

Finds one or more locations corresponding to an address.
Argument
GeocodeArgs
Result
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

geocode.reverse-geocode

Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability.
Argument
ReverseGeocodeArgs
Result
@vertigis.arcgis-extensions.data.Feature.Feature

geocode.suggest

Suggests matching addresses to search for based on some input text. The geocoder must have the supportsSuggest capability.
Argument
SuggestArgs
Result
string[]

geolocation.get-all-sources

Gets the list of currently available geolocation sources. Includes integrated receivers, GNSS devices, and emulators. Mobile only.
Argument
boolean
Result
GnssDeviceConnectionInfo[]

geolocation.get-coordinate-transformations

Returns a list of valid coordinate transformations for given input and output spatial references. Mobile only.
Argument
GetTransformationArgs
Result
CoordinateTransformation[]

geolocation.get-current-state

Gets the current geolocate state.
Argument
There are no arguments
Result
GeolocateCurrentState

geolocation.get-location-permissions-enabled

Returns whether integrated location services have been permitted via app or browser permissions.
Argument
There are no arguments
Result
boolean

geolocation.get-position

Returns the current user position. This Operation can block while the user is prompted for permission, as such it is considered best practice not to perform this during startup.
Argument
There are no arguments
Result
esri/geometry/Point

geometry.add-part

Adds a part to a given geometry. Mobile only.
Argument
AddPartArgs
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

geometry.add-point

Adds a point to a given geometry. Mobile only.
Argument
AddPointArgs
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

geometry.calculate-point

Calculates a point relative to a given reference line. Mobile only.
Argument
CalculatePointArgs
Result
esri/geometry/Point

geometry.remove-point

Removes a point from a given geometry. Mobile only.
Argument
RemovePointArgs
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

licensing.get-license-state

Retrieve the license state for the specified account and SKU. Defaults to returning the current state.
Argument
LicenseRequestArgs
Result
string

map.export-image

Exports the currently rendered map to a png image file on disk, and also returns that image. Mobile only.
Argument
ExportMapImageArgs
Result
EnhancedFileData

map.get-coordinate-transformation

If a map extension ID is specified, returns the coordinate transformation object for that map. If no map extension ID is specified, returns the coordinate transformation object of the first available map. The coordinate transformation object contains information about the input and output spatial reference, as well as the necessary transformations to convert between those coordinate systems. Mobile only.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Result
CoordinateTransformation[]

map.get-geometry-from-selector

Returns the geometry that is contained within the square overlay of the extent selector. Mobile only.
Argument
HasMaps
Result
esri/geometry/Extent

map.get-spatial-reference

If a map extension ID is specified, returns the spatial reference for that map. If no map extension ID is specified, returns the spatial reference of the first available map.
Argument (optional)
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Result
esri/geometry/SpatialReference

map.get-view-insets

Returns the amount of the map that is currently covered by insets such as the panel component. Mobile only.
Argument
HasMaps
Result
GetViewInsetsArgs

map.get-visible-center

Returns the point at the center of the visible map area. Accounts for panels displaying overtop of the map. Mobile only.
Argument
HasMaps
Result
esri/geometry/Point

map.hide

Hides the map. Mobile only.
Argument
HideMapArgs
Result
boolean

map.show

Shows the map if it is hidden. Mobile only.
Argument
HasMaps
Result
boolean

map.start-sketch

Enables sketching on a map. Mobile only.
Argument
StartSketchArgs
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

map.stop-sketch

Stops sketching on the map. Mobile only.
Argument
HasMaps
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

network.are-web-requests-disabled

Determines if Disconnected Mode is enabled and web requests can be sent by the app.
Argument
There are no arguments
Result
boolean

network.can-reach-host

Determines if the device can reach a given host and port. Mobile only.
Argument
HostAndPortArgs
Result
boolean

network.can-reach-url

Determines if the device can reach a given url. Mobile only.
Argument
string
Result
boolean

network.get-status

Returns the network status. Mobile only.
Argument
There are no arguments
Result
"ConnectedToCarrierDataNetwork" | "ConnectedToWiFiOrEthernet" | "NoConnection" | "Restricted"

network.has-connection

Determines if the device has a network connection. Mobile only.
Argument
There are no arguments
Result
boolean

offline.activate-area

Activates the specified offline area, replacing the map on the MapView with the offline map associated with the specified offline area. Mobile only. Note that exceptions during activation will be set in the result rather than thrown.
Argument
OfflineCommandArgs
Result
OfflineOperationResult

offline.check-for-active-area

Checks whether a map area is active for the specified map, or for any map if argument is null. Mobile only.
Argument
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
Result
boolean

offline.create-area

Creates a new custom offline map area. Mobile only.
Argument
CreateOfflineAreaArgs
Result
CustomOfflineArea

offline.download-area

Downloads the data for the specified offline area. Mobile only. Note that exceptions during the download process will be set in the result rather than thrown.
Argument
OfflineCommandArgs
Result
OfflineOperationResult

offline.get-areas

Gets a list of available offline areas for the web map. Mobile only.
Argument
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
Result
OfflineAreaBase[]

offline.get-edits

Gets a list of layer edits for a given map area. Mobile only.
Argument
OfflineCommandArgs
Result
LayerEdits[]

offline.go-online

Switches from an offline map to the online map. Mobile only. Note that exceptions while switching to the online map will be set in the result rather than thrown.
Argument
OfflineCommandArgs
Result
OfflineOperationResult

offline.submit-edits

Pushes any edits to the server that have been done in the indicated offline map. Mobile only. Note that errors during the upload process will be set in the result rather than thrown.
Argument
OfflineCommandArgs
Result
OfflineOperationResult

offline.update-area

Pulls down any new map changes from the server to the indicated offline map. Mobile only. Note that errors during the update process will be set in the result rather than thrown.
Argument
OfflineCommandArgs
Result
OfflineOperationResult

results.from-graphics

Converts provided GraphicsLike to VertiGIS Studio Features using any available metadata.
Argument
FromGraphicsArgs
Result
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.to-graphics

Converts VertiGIS Studio Features to Esri graphics.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Result
esri.Graphic[]

results.upload-data-to-features

Convert the supplied upload data args to features.
Argument
UploadDataArgs[]
Result
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream[]

sketching.add-node-to-geometry

Deprecated - Mobile users should rather use "geometry.add-point"; Web users should use "sketching.add-point" or "sketching.insert-point" instead.
Argument
AddNodeToGeometryArgs
Result
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh

sketching.capture-geometry

Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.
Argument
CaptureGeometryArgs
Result
CaptureGeometryResult

sketching.edit-geometry

Allows the user to edit an existing geometry by drawing on a map. Returns the geometry that was edited, or the supplied feature with the altered geometry applied, along with the map that it was drawn on.
Argument
EditGeometryArgs
Result
EditGeometryResult

sketching.is-streaming

Checks whether streaming is active. Mobile only.
Argument
HasMaps
Result
boolean

sketching.stop

Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, the operation will return null.
Argument (optional)
Result
CaptureGeometryResult

tasks.identify

Returns features that intersect a given geometry.
Argument
IdentifyArgs
Result
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

tasks.search

Returns features that match the given search text.
Argument
SearchArgs
Result
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

ui.confirm

Gets user confirmation by way of a popup box.
Argument
ConfirmOperationArgs
Result
boolean

utility-network.feature-results-from-trace

Gets feature results args from trace results, to display in the results list for example.
Argument
TraceCompletedArgs
Result
MapsFeatureResultArgs

utility-network.get-named-traces

Returns a list of available named traces from the specified network. Mobile only. Only available to VertiGIS Networks customers.
Argument
UtilityNetworkArgs
Result
esriRuntimeSdk.UtilityNamedTraceConfiguration[]

utility-network.get-utility-elements-from-features

Gets a list of UtilityElements from a list of Features. Mobile only. Only available to VertiGIS Networks customers.
Argument
GetUtilityElementsArgs
Result
esriRuntimeSdk.UtilityElement[]

utility-network.run-trace

Runs a trace on a utility network. Mobile only. Only available to VertiGIS Networks customers.
Argument
NetworkTraceArgs
Result
TraceCompletedArgs

workflow.evaluate

Runs a workflow with the given arguments and returns the workflow's output as the result of the operation. The output in the workflow is set using the "Set Workflow Output" activity. See the "workflow.run" command if you want to run a workflow without any output values.
Argument
EvaluateWorkflowArgs
Result
unknown

Events

app-config.unloading

Raised when the app config is about to be unloaded (in order to switch to a different app config). Mobile only.
Argument
There are no arguments

app.activated

Raised when the app is started, restored from a background state, layout switched, or restored from an interrupted state. Mobile only.
Argument
There are no arguments

app.backgrounded

Raised when the app is backgrounded. Mobile only.
Argument
There are no arguments

app.custom.started

Raised when a custom app is started. Mobile only.
Argument
SpecificAppArgs

app.favorited

Raised when an app is favorited. Mobile only.
Argument
GcxAppInfo

app.generic.apps-listed

Raised when apps are listed within VertiGIS Studio Go. Mobile only.
Argument
GenericAppsListedArgs

app.generic.specific-app-started

Raised when a specific app is started within VertiGIS Studio Go. Mobile only.
Argument
SpecificAppArgs

app.generic.specific-app-starting

Raised before a specific app starts within VertiGIS Studio Go. Mobile only.
Argument
SpecificAppArgs

app.generic.started

Raised when a generic app is started. Mobile only.
Argument
There are no arguments

app.going-to-app-selector

Raised when returning to the app selector screen from a specific app in VertiGIS Studio Go. Mobile only.
Argument
There are no arguments

app.interrupted

Raised when the app is interrupted temporarily (eg. Pull down notifications, control center, or OS level prompt or alert). Mobile only.
Argument
There are no arguments

app.refreshed

Raised when an app has been refreshed. Mobile only.
Argument
SpecificAppArgs

app.refreshing

Raised when an app refresh is beginning. Mobile only.
Argument
There are no arguments

app.unfavorited

Raised when an app is unfavorited. Mobile only.
Argument
GcxAppInfo

auth.portal-sign-in-completed

Raised when the user has signed into a Portal (AGOL or Portal for ArcGIS). Mobile only.
Argument
SignInCompletedEventArgs

auth.sign-in-cancelled

Raised when the user cancels a sign-in challenge. Mobile only.
Argument
SignInEventArgs

auth.sign-in-completed

Raised when successfully signed in. Principal event type used in Web, SignInCompletedEventArgs used in Mobile.
Argument
Any of:
Principal

auth.sign-in-failed

Raised when a sign-in attempt fails.
Argument (optional)

auth.sign-in-requested

Raised when the user requests a sign-in.
Argument (optional)

auth.sign-out-completed

Raised when the user is signed out.
Argument
There are no arguments

auth.sign-out-requested

Raised when the user requests a sign-out.
Argument
There are no arguments

auth.token-refreshed

Raised when the user's token is refreshed. Will be the new token in the VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio Mobile.
Argument
string

bookmark.added

Raised when a bookmark is added. Mobile only.
Argument
BookmarkEventArgs

bookmark.deleted

Raised when a bookmark is deleted. Mobile only.
Argument
BookmarkEventArgs

bookmark.updated

Raised when a bookmark is updated. Mobile only.
Argument
BookmarkEventArgs

bookmark.viewed

Raised when a bookmark is viewed. Mobile only.
Argument
BookmarkEventArgs

device.keyboard-hidden

Raised when a virtual keyboard is hidden. Mobile only.
Argument
There are no arguments

device.keyboard-shown

Raised when a virtual keyboard is shown. Mobile only.
Argument
There are no arguments

device.orientation-changed

Raised when the device's orientation changes. Mobile only.
Argument
DeviceOrientationChangedEventArgs

display.overlap-element-translate-started

Raised when one UI element is being moved overtop of another, such that the element underneath is partially or fully obscured. Mobile only.
Argument
ElementTranslationStartedArgs

edit.attachment-added

Raised when an attachment is added to a feature. Mobile only.
Argument
AttachmentEventArgs

edit.attachment-deleted

Raised when an attachment is deleted from a feature. Mobile only.
Argument
AttachmentEventArgs

edit.attachment-updated

Raised when an attachment is updated. Mobile only.
Argument
AttachmentEventArgs

edit.feature-added

Raised when a new feature is added to a feature source.
Argument
@vertigis.arcgis-extensions.data.Feature.Feature

edit.feature-deleted

Raised when a feature is deleted from a feature source.
Argument
@vertigis.arcgis-extensions.data.Feature.Feature

edit.feature-updated

Raised when the attributes or geometry of a feature from a feature source are updated.
Argument
@vertigis.arcgis-extensions.data.Feature.Feature

geolocation.accuracy-changed

Raised when geolocation is activated and the accuracy of geolocation changes.
Argument
GeolocateAccuracyChangedEventArgs

geolocation.antenna-height-changed

Raised when the GNSS antenna height is changed. Mobile only.
Argument
GnssDeviceAntennaHeightEventArgs

geolocation.auto-recenter-and-reorient-started

Raised when the user changes the geolocation mode to recenter-and-reorient (updates map orientation to match device direction). Mobile only.
Argument
HasMaps

geolocation.auto-recenter-and-reorient-stopped

Raised when the user changes the geolocation mode to not recenter-and-reorient. Mobile only.
Argument
HasMaps

geolocation.auto-recenter-started

Raised when geolocation enters auto recenter mode. For VertiGIS Studio Web Viewer, the event will have no parameter (all maps are always affected).
Argument (optional)

geolocation.auto-recenter-stopped

Raised when geolocation leaves auto recenter mode. For VertiGIS Studio Web Viewer, the event will have no parameter (all maps are always affected).
Argument (optional)

geolocation.gnss-device-detection-started

Raised when detection of connected GNSS receivers begins. Mobile only.
Argument
There are no arguments

geolocation.gnss-device-detection-stopped

Raised when detection of connected GNSS receivers ends. Mobile only.
Argument
There are no arguments

geolocation.gnss-lock-status-changed

Raised when the lock status of an active GNSS device changes. Mobile only.
Argument
GnssLockStateEventArgs

geolocation.location-display-mode-changed

Raised when the location display mode is changed. Mobile only.
Argument
LocationDisplayModeChangedEventArgs

geolocation.metadata-changed

Raised when a GNSS receiver is active and metadata about the device or location change. Mobile only.
Argument
GeolocateMetadataChangedEventArgs

geolocation.position-acquired

Raised when geolocation is activated and a user position has been received.
Argument
GeolocationEvent

geolocation.position-changed

Raised when geolocation is activated and the user's position changes.
Argument
esri/geometry/Point

geolocation.position-lost

Raised when geolocation is disabled, either through signal loss or being turned off, and a user position is not available.
Argument
GeolocationEvent

geolocation.source-changed

Raised when the source of geolocation data is changed to a different source (e.g. a GNSS receiver). Mobile only.
Argument
GnssDeviceConnectionInfo

geolocation.status-changed

Raised when geolocation status (enabled or disabled via app permissions) changes.
Argument
GeolocationStatusChangedEventArgs

geolocation.transformation-changed

Raised when the GNSS transformation is changed. Mobile only.
Argument
GnssDeviceTransformationOverrideEventArgs

input.keyboard-shortcut-pressed

Raised when the user presses a keyboard shortcut. Mobile only.
Argument
ConsoleKeyInfoObj

input.shake

Raised when the user shakes the device. Mobile only.
Argument
There are no arguments

layers.visibility-changed

Raised when a layer's visibility changes.
Argument
LayerEventArgs

layout.displayed

Raised when a layout is finished being displayed. Mobile only.
Argument
There are no arguments

layout.loaded

Raised when a layout is loaded. Mobile only.
Argument
Page

layout.margin-changed

Raised when a layout's margin values have been updated. Mobile only.
Argument
LayoutMarginChangedArgs

layout.unloaded

Raised when a layout is unloaded (typically so that a new layout can be loaded). Mobile only.
Argument
There are no arguments

map.image-exported

Raised when a map export operation has completed. Mobile only.
Argument
ExportMapImageArgs

map.initialized

Raised when a map has completed initialization. MapEvent used in Web, MapInitializedEvent used in Mobile.
Argument
Any of:

map.initializing

Raised when a map is about to begin loading during startup. The map can be swapped with a different map at this point if you want to circumvent the map load process. For example in an app that supported offline, an offline map could be swapped in here. Mobile only.
Argument
MapEvent

map.markup-added

Raised when markup is added to the map. Mobile only.
Argument
MarkupAddedEvent

map.markup-cleared

Raised when markup is cleared from the map. Mobile only.
Argument
MapEvent

map.navigation-completed

Raised when the a map navigation (eg. Pan or zoom) is complete. Mobile only.
Argument
MapEvent

map.refreshed

Raised when a map refresh completes. Mobile only.
Argument
MapEvent

map.refreshing

Raised when a map refresh begins. Mobile only.
Argument
MapEvent

map.rotated

Raised when the Rotate operation has completed execution. Mobile only.
Argument
MapEvent

map.rotating

Raised when the Rotate operation is about to be called. Mobile only.
Argument
MapEvent

map.switched

Raised when a map is replaced with a different map. Mobile only.
Argument
MapSwitchedEvent

map.viewpoint-changed

Raised when the a map extent is changed. This event is raised in extremely high frequency - for example, every few pixels the map is repositioned during a pan.
Argument
MapEvent

network.web-requests-disabled

Raised when the user has blocked the app from making web requests. Mobile only.
Argument
There are no arguments

network.web-requests-enabled

Raised when the user has allowed the app to make web requests. Mobile only.
Argument
There are no arguments

offline.area-activated

Raised when an offline area is activated. Mobile only.
Argument
AreaActivatedEventArgs

offline.area-activating

Raised when an offline area is about to be activated. Mobile only.
Argument
OfflineAreaBase

offline.area-deleted

Raised when the data for offline map area is deleted. Mobile only.
Argument
OfflineAreaBase

offline.area-download-canceled

Raised when an offline area download is canceled by the user. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-download-failed

Raised when an offline area download fails. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-download-started

Raised when an offline area download has started. Mobile only.
Argument
OfflineAreaBase

offline.area-downloaded

Raised when an offline area download completes. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-edits-submit-failed

Raised when any error occurs during an offline map submit edits. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-edits-submit-started

Raised when an operation to submit offline area edits has started. Mobile only.
Argument
AreaEditsSubmitStartedEventArgs

offline.area-edits-submitted

Raised when offline area edits have been submitted and this operation is successfully completed. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-update-failed

Raised when an any error occurs during an offline map update. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.area-update-started

Raised when an offline area update has started. Mobile only.
Argument
OfflineAreaBase

offline.area-updated

Raised when an offline area has been updated. Mobile only.
Argument
AreaOperationEndedEventArgs

offline.custom-area-created

Raised when a new custom offline map area is created. Mobile only.
Argument
CustomOfflineArea

offline.custom-area-deleted

Raised when the definition of a custom map area is deleted. Mobile only.
Argument
CustomOfflineArea

offline.user-went-online

Raised when a map is switched to the online map. Mobile only.
Argument
UserWentOnlineEventArgs

panel.host-panel-component-changed

Raised when the component that is currently being displayed by the host panel is changed. Argument is the id of the component. Mobile only.
Argument
string

panel.host-panel-component-changing

Raised when the component that is currently being displayed by the host panel is about to change. Argument is the id of the component. Mobile only.
Argument
string

photos.details-hidden

Raised when photo details are hidden. Mobile only.
Argument
There are no arguments

portal.initialized

Raised when an ArcGIS Portal is initialized. Mobile only.
Argument
ArcGISPortalExtension

printing.print-error

Raised when an error occurs with running a print.
Argument
PrintErrorEventArgs

printing.print-finished

Raised when a print has finished running. Event arguments include the print download URL.
Argument
PrintFinishedEventArgs

printing.print-progress

Raised while a print is running to provide updates on its status.
Argument
PrintProgressEventArgs

printing.print-started

Raised when a print has started running.
Argument
PrintStartedEventArgs

results.attachment-opened

Raised when a feature attachment has been opened. Mobile only.
Argument
AttachmentEventArgs

results.details-shown

Raised when feature details are being shown. Mobile only.
Argument
FeatureDetailsEvent

results.displayed

Raised when results are displayed. Mobile only.
Argument
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]

results.related-details-shown

Raised when feature details of a related feature are being shown. Mobile only.
Argument
FeatureDetailsEvent

search.activated

Raised when a search component is activated. Mobile only.
Argument
There are no arguments

search.cleared

Raised when a search has been cleared. Mobile only.
Argument
There are no arguments

search.completed

Raised when a search completes. Mobile only.
Argument
SearchCompletedArgs

search.deactivated

Raised when a search component is deactivated. Mobile only.
Argument
There are no arguments

search.started

Raised when a search begins. Mobile only.
Argument
SearchArgs

settings.updated

Raised when application settings have been updated. Mobile only.
Argument
There are no arguments

shortcuts.shortcut-added

Raised when a shortcut was added. Mobile only.
Argument
AddShortcutArgs

shortcuts.shortcut-removed

Raised when a shortcut was removed. Mobile only.
Argument
ShortcutArgs

tasks.identified

Raised when an identify task has been executed. Mobile only.
Argument
MapsFeatureResultArgs

tasks.reverse-geocoded

Raised when a reverse geocode is performed. Mobile only.
Argument
MapsFeatureResultArgs

ui.activated

Raised when a component is activated. The argument is the component ID.
Argument
string

ui.deactivated

Raised when a component is deactivated. The argument is the component ID.
Argument
string

ui.theme-changed

Raised when the app's theme is changed. The argument is the theme id.
Argument
string

workflow.starting

Raised when a workflow is about to start. Mobile only.
Argument
WorkflowStartingEventArgs

workflow.workflow-error

Raised when an error occurs while running a workflow.
Argument
WorkflowErrorEventArgs

workflow.workflow-finished

Raised when a workflow finishes running.
Argument
WorkflowFinishedEventArgs

Argument Definitions

@vertigis.arcgis-extensions.data._TableExtension.TableReference

Matches an existing table in a map.
Properties
id
string
The table's ID.
title
string
The table's title.

@vertigis.arcgis-extensions.data.convert.CellData

Data for a cell in a table.
Properties
formatted
string
The formatted value of the cell.
rawRequired
Any of:
string
string
number
boolean
The raw value of the cell.

@vertigis.arcgis-extensions.data.Feature.FeatureProperties

Properties that can be passed into the constructor for {@link data /Feature!Feature}.
Properties
attributes
Any of:
unknown
Map
The feature's attributes, keyed by field name.
failureMode
"error" | "ignore" | "warn"
See {@link support /InitializableBase!InitializableBase.failureMode}.
geometry
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
The feature's geometry.
id
string
The unique ID to assign to the entity. If not specified, one will be generated.
schema
@vertigis.arcgis-extensions.data.Schema.SchemaProperties
Metadata about the feature, such as fields, domains, geometry type, etc.
settings
@vertigis.arcgis-extensions.data.FeatureSettings.FeatureSettingsProperties
Settings for this feature.
source
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource
The source of the feature.

@vertigis.arcgis-extensions.data.FeatureSettings.FeatureSettingsProperties

Properties that can be passed into the constructor for {@link data /FeatureSettings!FeatureSettings}.
Properties
formatSettings
@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties
Settings affecting how feature attributes are formatted.
hyperlinkTemplates
@vertigis.arcgis-extensions.Hyperlink.Hyperlink[]
Templates that define hyperlinks associated with the feature. Each template's properties can contain field tokens enclosed in `{}`, which will be replaced by actual field values. If not explicitly set, these will be inherited from the associated layer extension if there is one.
maxAllowableOffset
number
See {@link data /FeatureSettings!FeatureSettings.maxAllowableOffset}.
outFields
string[]
See {@link data /FeatureSettings!FeatureSettings.outFields}.
outSpatialReference
esri/geometry/SpatialReference
See {@link data /FeatureSettings!FeatureSettings.outSpatialReference}.
popupContentExtensions
@vertigis.arcgis-extensions.data.PopupContentExtension.PopupContentExtension[]
See {@link data /FeatureSettings!FeatureSettings.popupContentExtensions}.
popupTemplate
Any of:
esri.rest-api.PopupInfoJson.PopupInfoJson
esri/PopupTemplate
The template for displaying content in a pop-up when the feature is selected. If not explicitly set, it will be inherited from the associated layer extension if there is one.
returnGeometry
boolean
See {@link data /FeatureSettings!FeatureSettings.returnGeometry}.
showRelatedRecordsWhenUnconfigured
boolean
See {@link data /FeatureSettings!FeatureSettings.showRelatedRecordsWhenUnconfigured}.
zoomFactor
number
See {@link data /FeatureSettings!FeatureSettings.zoomFactor}.
zoomScale
number
See {@link data /FeatureSettings!FeatureSettings.zoomScale}.

@vertigis.arcgis-extensions.data.FieldExtension.FieldExtensionProperties

Properties that can be passed into the constructor for {@link data /FieldExtension!FieldExtension}.
Properties
failureMode
"error" | "ignore" | "warn"
See {@link support /InitializableBase!InitializableBase.failureMode}.
field
Any of:
esri/layers/support/Field
string
The Esri Field object being extended.
format
string
The field format specifier. This is a standard .NET-style format string containing a `{0}` placeholder that will be replaced by the actual field value.
formatSettings
@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties
Settings that affect how values are formatted. Depending on the type of field, some or all of these settings may not be applicable.
id
string
The unique ID to assign to the entity. If not specified, one will be generated.
searchable
boolean
Whether the field is searchable or not.

@vertigis.arcgis-extensions.data.FieldExtension.FieldProperties

Properties that extend the ArcGis portal representation of a Field.
Properties
$ref
string
A field name referring to an existing field in a schema. The field extension will attempt to find an existing field in its parent schema.
alias
string
The field alias (human-readable name).
domain
Any of:
esri.rest-api.DomainJson.CodedValueDomainJson
esri.rest-api.DomainJson.InheritedDomainJson
esri.rest-api.DomainJson.RangeDomainJson
A domain object that provides the attribute domain information for the field, if a domain exists.
editable
boolean
Whether this field is editable.
exactMatch
boolean
A Boolean defining whether or not the field is an exact match.
length
number
A number defining how many characters are allowed in a string field.
name
string
A string defining the field name.
nullable
boolean
Whether this field can have a null value.
type
FieldJsonType
Type of the Field. See {@link FieldJsonType}.
visible
boolean
<not in spec>.

@vertigis.arcgis-extensions.data.PopupContentExtension.ContentProperties

Properties that extend the ArcGis portal representation of a PopupContent.
Properties
$ref
@vertigis.arcgis-extensions.data.PopupContentExtension.ContentRef
A popupContent name referring to an existing popupContent in a featureSettings. The popupContent extension will attempt to find an existing popupContent in its parent featureSettings.
attributes
unknown
A dictionary of key value pairs representing attributes to be used instead of fields and their values. This property is only used when the element is of type expression and should be returned as part of the arcade expression itself. This property allows passing arcade derived attribute values into fields or media elements.
description
string
An optional string value describing the element in detail. This property does not apply when the type is text or expression.
displayCount
number
This property applies to elements of type relationship. An integer that indicates the maximum number of records to display.
displayType
string
This property applies to elements of type attachments and relationship. A string value indicating how to display the attachment. Possible values are, 'preview', and 'list' for attachments types, and 'list' for relationship types. If list is specified, attachments show as links.
expressionInfo
esri.rest-api.PopupInfoJson.PopupExpressionInfoJson
This property applies to elements of type expression. An Arcade expression that defines the pop-up element content.
fieldInfos
esri.rest-api.PopupInfoJson.FieldInfoJson[]
This property applies to elements of type fields. It is an array of popupInfo.fieldInfo objects representing a field/value pair displayed as a table within the popupElement. If the fieldInfos property is not provided, the popupElement will display whatever is specified directly in the popupInfo.fieldInfos property.
mediaInfos
esri.rest-api.PopupInfoJson.MediaInfoJson[]
This property applies to elements of type media. An array of popupInfo.mediaInfo objects representing an image or chart for display. If no mediaInfos property is provided, the popupElement will display whatever is specified in the popupInfo.mediaInfo property.
orderByFields
esri.rest-api.PopupInfoJson.OrderByFieldsJson[]
This property applies to elements of type relationship. Array of orderByFields objects indicating the field display order for the related records and whether they should be sorted in ascending 'asc' or descending 'desc' order.
relationshipId
number
This property applies to elements of type relationship. The id of the relationship as defined in the feature layer definition.
text
string
This property applies to elements of type text. This is string value indicating the text to be displayed within the popupElement. If no text property is provided, the popupElement will display whatever is specified in the popupInfo.description property.
title
string
An optional string value indicating what the element represents. This property does not apply when the type is text or expression.
type
"attachments" | "expression" | "fields" | "media" | "relationship" | "text"
String value indicating which element to use.

@vertigis.arcgis-extensions.data.PopupContentExtension.PopupContentExtensionProperties

Properties that can be passed into the constructor for {@link PopupContentExtension}.
Properties
content
Any of:
esri/popup/content/AttachmentsContent
The ESRI Content instance to be extended.
failureMode
"error" | "ignore" | "warn"
See {@link support /InitializableBase!InitializableBase.failureMode}.
id
string
The unique ID to assign to the entity. If not specified, one will be generated.
summaryHiddenFields
string[]
Names of fields that will be hidden when displayed in the a summary view. This property is only applied to "fields" Content types.
visibleInSummary
boolean
Whether the Content is visible when being displayed in a summary view.

@vertigis.arcgis-extensions.data.Schema.SchemaProperties

Properties that can be passed into the constructor for {@link data /Schema!Schema}.
Properties
displayField
string
See {@link data /Schema!Schema.displayField}.
fieldExtensions
@vertigis.arcgis-extensions.data.FieldExtension.FieldExtension[]
See {@link data /Schema!Schema.fieldExtensions}.
fields
esri/layers/support/Field[]
esri.rest-api.FieldJson.FieldJson[]
See {@link data /Schema!Schema.fields}.
geometryType
esri.rest-api.GeometryJson.GeometryJsonType
See {@link data /Schema!Schema.geometryType}.
primaryKeyField
string
See {@link data /Schema!Schema.primaryKeyField}.
spatialReference
esri/geometry/SpatialReference
See {@link data /Schema!Schema.spatialReference}.
timeZone
string
See {@link data /Schema!Schema.timeZone}.
typeIdField
string
See {@link data /Schema!Schema.typeIdField}.
types
esri/layers/support/FeatureType[]
esri.rest-api.TypeJson.TypeJson[]
See {@link data /Schema!Schema.types}.

@vertigis.arcgis-extensions.Entity.EntityProperties

Serializable properties for {@link Entity}.
Properties
id
string
The unique ID to assign to the entity. If not specified, one will be generated.

@vertigis.arcgis-extensions.Hyperlink.HyperlinkProperties

A hyperlink associated with a feature or layer.
Properties
iconUrl
string
See {@link Hyperlink.iconUrl}.
target
string
See {@link Hyperlink.target}.
textRequired
string
See {@link Hyperlink.text}.
tooltip
string
See {@link Hyperlink.tooltip}.
urlRequired
string
See {@link Hyperlink.url}.

@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference

Matches an existing layer.
Properties
id
string
The layer's ID.
path
string
The path to the geodatabase used by an MMAP layer. Mobile only.
subtype
string
The Layer's type, used for Layer types with multiple possible layer extension mappings.
title
string
The layer's title.
url
string
The layer's url.

@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties

Properties that can be passed into the constructor for {@link FormatSettings}.
Properties
currency
string
The 3-letter ISO 4217 currency code (e.g "USD", "CAD"). Required when formatting a number using NumberFormat.CURRENCY or NumberFormat.ACCOUNTING.
dateFormat
string
The default format for date values. Either a {@link utilities /format/formats!DateFormat} constant, or a custom date format string.
fractionalDigits
number
The number of digits to show after the decimal point. If unspecified, an appropriate value is determined based on the locale and currency.
locale
string
The locale to use when formatting values.
numberFormat
string
The default format for number values. Either a {@link utilities /format/formats!NumberFormat} constant, or a custom number format string.
timeFormat
string
The default format for time values. Either a {@link utilities /format/formats!DateFormat} constant, or a custom time format string.
timeZone
string
The time zone to display date/time data in. The default will be the user's local time zone.
useFieldInfo
boolean
Whether to use formatting from the field info if it is specified.

@vertigis.arcgis-extensions.tasks.CountResult.CountResult

A count result for services.
Properties
countRequired
number
The number of features that match the search criteria.
sourceRequired
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource
The input feature source.

@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.GeocodeOptions

Options that can be passed into geocode operations.
Properties
cancelToken
@vertigis.arcgis-extensions.support.Cancellable.CancelToken
An optional cancel token from a {@link support /Cancellable!Cancellable} that can be used to cancel the geocode operation.
maxResults
number
The maximum number of results to return. This cannot exceed the maximum supported by the geocoder (see {@link tasks /geocoding/Geocoder!Geocoder.capabilities}).
outFields
string[]
Fields that should be returned for each feature.
outSpatialReference
esri/geometry/SpatialReference
The spatial reference of the results.
searchArea
esri/geometry/Geometry
If specified, results will be limited to those that intersect the given geometry. No effect for reverse geocoding.
searchPoint
esri/geometry/Point
If specified, results will be weighted for the specified point. No effect for reverse geocoding.

ActivationArgs

Arguments for the "ui.activate" and "ui.deactivate" commands.
Properties
componentRequired
Any of:
string
The component to activate or deactivate. Can be identified by its ID or model.
validateState
boolean
Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.

AddAttachmentArgs

Arguments for the "edit.add-attachment" command. Supported by both Web and Mobile.
Properties
contentTypeRequired
string
The MIME content type of the attachment.
dataRequired
number[]
The binary data for the attachment.
featuresRequired
@vertigis.arcgis-extensions.data.Feature.Feature[]
The feature(s) to add the attachment to.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map.
nameRequired
string
The name of the attachment.

AddMarkupArgs

Arguments for the "map.add-markup" command.
Properties
collection
string
The named collection of markup to operate on. If not specified, the default markup collection will be used. Note that collections with names prefixed by "vgs" are reserved for internal system use and should not be referenced directly. Web only.
graphics
Any of:
esri/Graphic
esri.Graphic[]
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
The markup to add to the map. `GraphicsLike` is only available in Web.
level
"custom1" | "custom2" | "custom3" | "default" | "labels" | "ui"
The level (z-order) to assign the markup to. If not specified uses the same level as default markup. Web only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

AddNodeToGeometryArgs

Deprecated - Mobile users should rather use "geometry.add-point"; Web users should use "sketching.add-point" with {@link AddPointArgs} or "sketching.insert-point" with {@link InsertPointArgs} instead.
Properties
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The initial geometry to add the point to. Can be null.
geometryTypeRequired
string
The type of geometry to create if the initial geometry is null. In VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In VertiGIS Studio Web, this value may also be null if the point being added is intended to be added to the active sketch.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
nodeRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
A point geometry to add to the initial geometry. In VertiGIS Studio Web, this value may be null if the intention is to add a point at the position of the active point of an active sketch.
nodeOrder
"add-after-active" | "add-before-active"
Indicates whether the new point should be added before or after the active point in the sketch. Not supported by VertiGIS Studio Mobile.

AddPartArgs

Arguments for the geometry.add-part operation.
Properties
geometryRequired
Any of:
esri/geometry/Polygon
esri/geometry/Polyline
The starting geometry.
partRequired
esri.Point[]
The new part to be added to 'geometry'.

AddPointArgs

Arguments for the geometry.add-point operation.
Properties
geometryRequired
Any of:
esri/geometry/Polygon
esri/geometry/Polyline
The starting geometry.
newPointRequired
esri/geometry/Point
The new point to be added to 'geometry'. The spatial reference must match 'geometry' or an error will be thrown.
partIndex
number
The index of the part to which the point will be added. If null, the last part will be used.
pointIndex
number
The index at which the point will be added. If null, the point will be added as the last point.

AddShortcutArgs

The arguments for the "shortcut.added" event.
Properties
keyRequired
ConsoleKeyInfo
The key combination this shortcut uses.
operationRequired
Message
The command or operation assigned to the corresponding shortcut.
requiresMapFocusRequired
boolean
Indicates whether the map must be focused for the message to be executed.

AlertCommandArgs

Arguments for the 'ui.alert' command.
Properties
buttonText
string
The text to display on the dismiss button.
initialPosition
MessageBoxPosition
Where the dialog appears in the app when it is created. Defaults to center position. Web only.
isDraggable
boolean
Whether the dialog is draggable or not. Defaults to true. Web only.
message
string
The message to be displayed in the dialog.
title
string
The title of the dialog.

AnchorHostPanelArgs

Arguments for the "panel.anchor-host-panel" command.
Properties
anchorComponentRequired
ComponentBase
The component to anchor to.
offsetHeightRequired
number
The offset from the top or bottom of the screen.
offsetWidthRequired
number
The offset from the side of the screen.

ArcGISPortalIdentity

Properties
This object doesn't currently contain any properties.

AreaActivatedEventArgs

Arguments for the "offline.area-activated" event.
Properties
activeAreaRequired
OfflineAreaBase
The area that is now active.
previouslyActiveAreaRequired
OfflineAreaBase
The area that was previously active. Can be null if there was no previously active offline area.

AreaEditsSubmitStartedEventArgs

Arguments for the "offline.area-edits-submit-started" event.
Properties
addsRequired
number
The number of add edits that are being submitted.
deletesRequired
number
The number of delete edits that are being submitted.
offlineAreaRequired
OfflineAreaBase
The offline area that is related to this event.
updatesRequired
number
The number of update edits that are being submitted.

AreaOperationEndedEventArgs

Arguments for events that signify the end of an offline area operation.
Properties
offlineAreaRequired
OfflineAreaBase
The offline area that is related to this event.
offlineAreaStatusRequired
OfflineAreaStatus
The status of the offline area related to this event.

AttachmentEventArgs

Event args for attachment events.
Properties
attachmentRequired
@vertigis.arcgis-extensions.data.Attachment.Attachment
The attachment this event relates to.
featureRequired
@vertigis.arcgis-extensions.data.Feature.Feature
The feature to which the attachment belongs.

BackgroundLocationUpdatesArgs

Arguments for the system.disable-background-location-updates command.
Properties
taskId
string
The task ID for enabling and disabling background location updates. Once enabled using a certain task ID, background location updates can only be stopped once they are disabled with that same task ID. Cannot be set to null, but if this argument is not provided, a preset default value will be used.

BookmarkEventArgs

Arguments for the bookmark events.
Properties
isEditableRequired
boolean
Indicates whether the bookmark is editable.
nameRequired
string
The name of the bookmark.

CalculatePointArgs

Arguments for the geometry.calculate-point operation.
Properties
angle
number
The angle, relative to the angle of the reference line, that will be used to calculate the new point. Positive angles are calculated clockwise from the angle of the reference line, negative angles are calculated counter-clockwise. Exactly one of 'offset' and 'angle' must be set.
distanceRequired
number
The distance that will be used to calculate the new point. If using 'offset', this indicates the distance along the reference line. If using 'angle', this indicates the distance directly from the new point to the start point of the reference line. Cannot be negative.
geodetic
boolean
Whether the distance calculations will be geodetic or planar. Defaults to true.
geodeticCurveTypeRequired
"geodesic" | "great-elliptic" | "loxodrome" | "normal-section"
The geodetic curve type used when calculating the new point. Only applies when 'geodetic' is true. Defaults to 'geodesic'.
offset
number
The offset that will be used to calculate the new point. The 'offset' corresponds to the distance perpendicularly away from the reference line. Positive values will result in a point to the right of the reference line, negative values will be to the left. Exactly one of 'offset' and 'angle' must be set.
referenceLineRequired
ReferenceLine
The reference line that will be used to calculate the new point.
unitsRequired
"centimeters" | "cm" | "feet" | "ft" | "in" | "inches" | "kilometers" | "km" | "m" | "meters" | "mi" | "miles" | "millimeters" | "mm" | "nautical-miles" | "nm" | "yards" | "yd"
The units to be used for 'distance' and 'offset'. Defaults to the default units of the map.

CaptureGeometryArgs

Arguments for the "sketching.capture-geometry" operation.
Properties
disableFreehand
boolean
Disables freehand sketching during the draw session. Web only.
editorSettings
GeometryEditorSettings
The settings to be applied to the sketch. Mobile only.
geometryTypeRequired
Any of:
SketchTool[]
"circle" | "extent" | "line" | "multipoint" | "point" | "polygon" | "polyline" | "square"
The geometry/shape to use for sketching. * Multiple sketch tools are only supported by VertiGIS Studio Web. When multiple sketch tools are provided, the sketch will begin with the first one in the list. If "point" is the first of multiple options in the list, click actions will create points while click-and-drag actions will automatically begin the freehand variation of the next included geometry type. The types "point", "line" and "square" are supported only in Web.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The maps to activate drawing on. By default it will be all maps.
maxSegments
number
The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.
pluginSettings
unknown
Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is "snapping". A boolean value can also be assigned to completely disable, or enable with default settings.
symbol
Any of:
esri.rest-api.SymbolJson.CIMSymbolJson
esri.rest-api.SymbolJson.CIMSymbolReferenceJson
esri.rest-api.SymbolJson.PictureFillSymbolJson
esri.rest-api.SymbolJson.PictureMarkerSymbolJson
esri.rest-api.SymbolJson.SimpleFillSymbolJson
esri.rest-api.SymbolJson.SimpleLineSymbolJson
esri.rest-api.SymbolJson.SimpleMarkerSymbolJson
esri.rest-api.SymbolJson.TextSymbolJson
esri.rest-api.SymbolJson.LabelSymbol3DJson
esri.rest-api.SymbolJson.LineSymbol3DJson
esri.rest-api.SymbolJson.MeshSymbol3DJson
esri.rest-api.SymbolJson.PointSymbol3DJson
esri.rest-api.SymbolJson.PolygonSymbol3DJson
esri.rest-api.SymbolJson.StyleSymbolReferenceJson
An optional symbol to use. SymbolSets are not supported by VertiGIS Studio Mobile.

CaptureGeometryResult

Result of the "sketching.capture-geometry" operation.
Properties
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry that was captured.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map that the user sketched the geometry on. Unavailable in VertiGIS Studio Mobile.
symbol
Any of:
esri/symbols/PictureFillSymbol
esri/symbols/PictureMarkerSymbol
esri/symbols/SimpleFillSymbol
esri/symbols/SimpleLineSymbol
esri/symbols/SimpleMarkerSymbol
esri/symbols/TextSymbol
esri/symbols/CIMSymbol
esri.LabelSymbol3D
esri/symbols/LineSymbol3D
esri/symbols/MeshSymbol3D
esri/symbols/PointSymbol3D
esri/symbols/PolygonSymbol3D
esri.WebStyleSymbol
The symbol that was used. Unavailable in VertiGIS Studio Web.

ClearConstraintsArgs

Arguments for the "sketching.clear-constraints" command.
Properties
clearAngleConstraint
boolean
Indicates whether the angle constraint should be cleared. Defaults to true if not specified.
clearLengthConstraint
boolean
Indicates whether the length constraint should be cleared. Defaults to true if not specified.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

ClearMarkupArgs

Arguments for the "map.clear-markup" command.
Properties
collection
string
The named collection of markup to operate on. If not specified, the default markup collection will be used. Note that collections with names prefixed by "vgs" are reserved for internal system use and should not be referenced directly. Web only.
graphics
Any of:
esri/Graphic
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
The markup to clear. If not specified will clear all markup in the selected collection.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

CoincidentEditingGraphicResult

The result of a Graphic being coincidentally edited as a part of a editing session with topological editing enabled. Web Only.
Properties
graphicRequired
esri/Graphic
The coincident graphic that was included in an editing session with topological editing enabled.
originalGeometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
A copy of the original geometry of the Graphic, before it was edited.

ConfirmOperationArgs

Arguments for the 'ui.confirm' operation.
Properties
cancelButtonText
string
The text to display on the cancel button.
initialPosition
MessageBoxPosition
Where the dialog appears in the app when it is created. Defaults to center position. Web only.
isDraggable
boolean
Whether the dialog is draggable or not. Defaults to true. Web only.
message
string
The message to be displayed in the dialog.
okButtonText
string
The text to display on the ok button.
title
string
The title of the dialog.

CoordinateOptionProperties

Options for configuring the display of map coordinates.
Properties
formatRequired
"lat-long-dd" | "lat-long-ddm" | "lat-long-dms" | "mgrs" | "usng" | "utm" | "xy"
The format to display map coordinates in.
idRequired
string
The unique ID of the Coordinate Option.
precision
number
For LAT_LONG and XY coordinate formats, this property depicts the number of decimal places displayed. For MGRS and USNG coordinate formats, this property depicts the precision of the coordinates using an integer between 0 and 8 (inclusive). This Value is ignored by UTM coordinate formats. The default values for coordinate formats are as follows: LAT_LONG=4, XY=2, MGRS=5, and USNG=5.
spatialReference
esri.rest-api.SpatialReferenceJson.SpatialReferenceJson
The spatial reference to display map coordinates in. If this property is not defined, the spatial reference of the map will be used.
titleRequired
string
The display name of the CoordinateOption.

CoordinateTransformation

Result of the "map.get-coordinate-transformation" operation.
Properties
inputSpatialReferenceRequired
esri/geometry/SpatialReference
The initial coordinate system of the data.
outputSpatialReferenceRequired
esri/geometry/SpatialReference
The coordinate system to project the data into.
transformationRequired
esri.supportGeographicTransformation
The geographic transformation used to project data between the input coordinate system and the output coordinate system.

CreateGraphicsArgs

Arguments for the "drawing.create-graphics" operation. `GeometryLike`, `FeaturesLike` and `SymbolLike` are only available in Web.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features containing geometry to create graphics from. Web only.
geometryRequired
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
esri/geometry/Geometry
The geometry that was captured.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
symbol
Any of:
esri/symbols/PictureFillSymbol
esri/symbols/PictureMarkerSymbol
esri/symbols/SimpleFillSymbol
esri/symbols/SimpleLineSymbol
esri/symbols/SimpleMarkerSymbol
esri/symbols/TextSymbol
esri/symbols/CIMSymbol
esri.LabelSymbol3D
esri/symbols/LineSymbol3D
esri/symbols/MeshSymbol3D
esri/symbols/PointSymbol3D
esri/symbols/PolygonSymbol3D
esri.WebStyleSymbol
esri.rest-api.SymbolJson.CIMSymbolReferenceJson
esri.rest-api.SymbolJson.PictureFillSymbolJson
esri.rest-api.SymbolJson.PictureMarkerSymbolJson
esri.rest-api.SymbolJson.SimpleFillSymbolJson
esri.rest-api.SymbolJson.SimpleLineSymbolJson
esri.rest-api.SymbolJson.SimpleMarkerSymbolJson
esri.rest-api.SymbolJson.TextSymbolJson
esri.rest-api.SymbolJson.LineSymbol3DJson
esri.rest-api.SymbolJson.PointSymbol3DJson
esri.rest-api.SymbolJson.PolygonSymbol3DJson
The symbol that should be used to create the graphic. If null, a default is provided.

CreateGraphicsResult

Result of the "drawing.create-graphics" and "measurement.create-graphics" operations.
Properties
graphicsRequired
esri.Graphic[]
The resulting graphics.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map that the graphics were created on. Only available in Web.

CreateOfflineAreaArgs

Arguments for the "offline.create-area" operation.
Properties
areaDetailsRequired
CustomOfflineAreaDetails
The map area details that will be used to create the offline map area.
mapExtensionRequired
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The map that the custom offline map area is being created for.
titleRequired
string
The title of the custom offline map area.

CustomOfflineAreaDetails

Defines the details for the creation of a custom offline map area.
Properties
areaOfInterestRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry defining this map area.
basemapTilePackage
string
The name of a tile package to use as a basemap.
includeAttachments
boolean
Whether to include feature attachments when downloading this map area. Defaults to false.
isDefinitionExpressionFilterEnabled
boolean
Whether feature layer definition expressions are used when taking feature layers and tables offline. Defaults to false.
maxScaleRequired
number
The maximum scale for the map.
minScaleRequired
number
The minimum scale for the map.

DeleteAttachmentArgs

Arguments for the "edit.delete-attachment" command.
Properties
attachments
string[]
The attachment(s) to remove from the feature(s). This property can be populated with the title(s) or ID(s) of the attachments(s). Any and all matching attachments found on the input features will be deleted. Web only.
featuresRequired
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
The feature(s) to remove the attachment(s) from.
gcxAttachment
@vertigis.arcgis-extensions.data.Attachment.Attachment
The attachment to remove from the feature(s). Mobile only.

DeleteGeometryArgs

Arguments for the "sketching.delete" command.
Properties
geometry
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry to remove a point from. If this property is not specified, any active vertices will be deleted.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
partIndex
number
The index of the part of the geometry that the point should be removed from. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.
point
esri/geometry/Point
The point to remove from the geometry. If this property is defined, the 'pointIndex' and 'partIndex' properties are ignored. If no point nor pointIndex/partIndex are specified, any active points will be deleted. If there are no active points, the entire geometry will be deleted.
pointIndex
number
The index of the point that should be removed from the geometry. If this property is defined, the geometry property must also be defined.

DeviceOrientationChangedEventArgs

Arguments for the "device.orientation-changed" event.
Properties
This object doesn't currently contain any properties.

DisplayAddFeatureArgs

Arguments for the "edit.display-add-feature" command. Web only.
Properties
editAttachments
boolean
Whether to allow editing of feature attachments.
editAttributes
boolean
Whether to allow editing of feature attributes.
editGeometry
boolean
Whether to allow editing of feature geometry.
editGeometryOptions
EditGeometryOptions
Options for the geometry editing session.
featureAttributes
unknown
A collection of attributes to apply to the new feature.
fieldElements
__type[]
A collection of configuration overrides for the editable fields. Web only.
formUITarget
HasUITarget
Arguments for the display of the attribute editing form. Web only.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometry to use for the command/operation.
layers
Any of:
esri/layers/Layer
@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension
esri.SublayerLike
@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension
@vertigis.arcgis-extensions.data._TableExtension.TableExtension
LayerLike[]
string
Layer(s) to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
orientation
"horizontal" | "vertical"
The orientation of the template picker. Defaults to "vertical".
pluginSettings
unknown
Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is "snapping". A boolean value can also be assigned to completely disable, or enable with default settings.
showNotifications
boolean
Whether to show UI notifications. Defaults to `true`.
showTitles
boolean
Whether to show titles on the template picker. Defaults to `true`.
templateName
string
The template to use as a starting point for this feature. Requires a layer. The default or first template will be used if not set.
templateUITarget
HasUITarget
Arguments for the display of the template picker. Web only.
typeId
string
A type id to use as a starting point for this feature. This may return one or more templates and requires a layer with types defined.

DisplayAddRelatedFeatureArgs

Arguments for the "edit.display-add-related-feature" command. A feature and a relationship ID are supplied as inputs instead of a layer.
Properties
editAttachments
boolean
Whether to allow editing of feature attachments.
editAttributes
boolean
Whether to allow editing of feature attributes.
editGeometry
boolean
Whether to allow editing of feature geometry.
editGeometryOptions
EditGeometryOptions
Options for the geometry editing session.
featureAttributes
unknown
A collection of attributes to apply to the new feature.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
fieldElements
__type[]
A collection of configuration overrides for the editable fields. Web only.
formUITarget
HasUITarget
Arguments for the display of the attribute editing form. Web only.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometry to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
orientation
"horizontal" | "vertical"
The orientation of the template picker. Defaults to "vertical".
pluginSettings
unknown
Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is "snapping". A boolean value can also be assigned to completely disable, or enable with default settings.
relatedFeatureSourceRequired
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource
The feature source for the related feature to create. Mobile only.
relationshipIdRequired
string
The ID of the relationship to add a feature to.
showNotifications
boolean
Whether to show UI notifications. Defaults to `true`.
showTitles
boolean
Whether to show titles on the template picker. Defaults to `true`.
templateName
string
The template to use as a starting point for this feature. Requires a layer. The default or first template will be used if not set.
templateUITarget
HasUITarget
Arguments for the display of the template picker. Web only.
typeId
string
A type id to use as a starting point for this feature. This may return one or more templates and requires a layer with types defined.

DisplayBusyStateArgs

Arguments for the "ui.display-busy-state" args.
Properties
id
string
The ID used to link a busy state to its caller. Web only.
maximumDisplayDurationMs
number
The maximum number of milliseconds the busy state will be displayed. Web only.
message
string
The message to display.
messageDelayMs
number
The number of milliseconds to wait before displaying the message. Default is 3000. Web only.
minimumDisplayDurationMs
number
The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.
title
string
The title to display. Mobile only.

DisplayExtentSelectorArgs

Arguments for the "map.display-extent-selector" command.
Properties
continueCommandRequired
Any of:
string
The command to execute when the extent selector's Continue button is selected by the user.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to display the selector on.
selectorHelpTextRequired
string
Help text to display above the extent selector overlay to give context to what the user is expected to do.

DisplayNotificationArgs

The arguments for the `ui.display-notification` command.
Properties
autoClose
boolean
Indicates if the notification should auto-close after a time duration. Defaults to true. Mobile only.
category
"error" | "info" | "success" | "warning"
The category of notification, i.e. "error" (default is "info").
disableTimeouts
boolean
Disable notification timeouts. Timeouts only apply to "info" and "success" categories. Web only.
id
string
Optional identifier that can be used to hide a particular notification (see `ui.hide-notification`) Web only.
messageRequired
Any of:
string
The message to be displayed in the notification. Mobile only supports a string for this property.
notificationGroup
string
Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.
onClose
__type
Invoked when the notification is closed, either explicitly or due to timeout. Web only.
position
"bottom" | "left" | "right" | "top"
The position of the notification on the screen. Web only.
title
string
The notification title - only shown for system notifications. Mobile only.
type
"auto" | "app" | "system"
The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.

DisplayPhotoDetailsArgs

Arguments for the "photos.display-details" command.
Properties
photosRequired
Photo[]
The photo(s) to display.
senderRequired
VisualElement
The sender UI element to use as an anchor point for animation when opening the attachment.
startIndexRequired
number
The index of the photo to start at.

DisplayUpdateFeatureArgs

Arguments for the "edit.display-update-features" operation. Web only.
Properties
attributes
unknown
Optional layout XML attributes to be used for the transient UI container.
editAttachments
boolean
Whether to allow editing of feature attachments.
editAttributes
boolean
Whether to allow editing of feature attributes.
editGeometry
boolean
Whether to allow editing of feature geometry.
editGeometryOptions
EditGeometryOptions
Options for the geometry editing session.
featureAttributes
unknown
A collection of attributes to automatically apply to the updated feature.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
fieldElements
__type[]
A collection of configuration overrides for the editable fields.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometry to use for the command/operation.
icon
string
Optional icon that may be used by the transient UI container.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
orientation
"horizontal" | "vertical"
The orientation of the template picker. Defaults to "vertical".
parent
Any of:
string
The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.
pluginSettings
unknown
Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is "snapping". A boolean value can also be assigned to completely disable, or enable with default settings.
showNotifications
boolean
Whether to show UI notifications. Will default to `true`.
showTitles
boolean
Whether to show titles on the template picker. Defaults to `true`.

EditCommandArgs

Arguments for the "edit.add-features", "edit.update-features" and "edit.delete-features" commands. Web only.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
showNotifications
boolean
Whether to show UI notifications. Will default to `true`.

EditGeometryArgs

Arguments for the "sketching.edit-geometry" operation.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
The features containing geometries to edit. The features will pass through and be assigned the altered geometries. Not supported in Mobile.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometries to edit.
graphics
Any of:
esri/Graphic
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
The graphics containing geometries to edit. The graphics will pass through and be assigned the altered geometries. Not supported in Mobile.
isMeasurement
boolean
Flag all inputs as measured geometries. Geometry operations will show measurements for in progress operations. Not supported in Mobile.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The maps to activate editing on. By default it will be all maps.
options
EditGeometryOptions
The options for this edit operation. Not supported in Mobile. Web only.
pluginSettings
unknown
Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is "snapping". A boolean value can also be assigned to completely disable, or enable with default settings.
symbol
Any of:
esri/symbols/PictureFillSymbol
esri/symbols/PictureMarkerSymbol
esri/symbols/SimpleFillSymbol
esri/symbols/SimpleLineSymbol
esri/symbols/SimpleMarkerSymbol
esri/symbols/TextSymbol
Symbol
An optional symbol to use while editing.

EditGeometryOptions

Options for the "sketching.edit-geometry operation.
Properties
anchor
"center" | "opposite"
Where to anchor the geometry when performing a free scale operation. Defaults to "center".
enableDelete
boolean
Whether to allow deletion of the edited geometry. Defaults to false.
enableMoving
boolean
Whether to allow moving of the edited geometry. Defaults to true. Not applicable when editing in 3D.
enableRotation
boolean
Whether to allow rotation of the edited geometry. Defaults to true.
enableScaleModeToggle
boolean
Whether to allow the user to toggle to the non-default scale mode. Defaults to true.
enableScaling
boolean
Whether to allow scaling of the edited geometry. Defaults to true.
enableVertexEditing
boolean
Whether to allow the user to add, move, and remove vertices from a geometry. Defaults to true.
scaleMode
"free" | "preserve-aspect-ratio"
Setting "free" allows independent scaling on the x and y axis, "preserve-aspect-ratio" constrains scaling to the original aspect ratio. Defaults to "preserve-aspect-ratio".
validateGeometry
boolean
Whether the resulting geometry is validated before it's returned from the operation. If the geometry is invalid upon completion, an error is thrown. Defaults to true.

EditGeometryResult

Result of the "sketching.edit-geometry" operation.
Properties
coincidentFeatures
@vertigis.arcgis-extensions.data.Feature.Feature[]
Any coincident Features that were included in the geometry editing session, if topological editing was enabled. Web only.
coincidentGraphics
CoincidentEditingGraphicResult[]
Any coincident Graphics that were included in the geometry editing session, if topological editing was enabled. Web only.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
The features containing geometries to edit. The features will pass through and be assigned the altered geometries. Not supported in Mobile.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometries to edit.
graphics
Any of:
esri/Graphic
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
The graphics containing geometries to edit. The graphics will pass through and be assigned the altered geometries. Not supported in Mobile.
isMeasurement
boolean
Flag all inputs as measured geometries. Geometry operations will show measurements for in progress operations. Not supported in Mobile.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The maps to activate editing on. By default it will be all maps.
symbol
Any of:
esri/symbols/PictureFillSymbol
esri/symbols/PictureMarkerSymbol
esri/symbols/SimpleFillSymbol
esri/symbols/SimpleLineSymbol
esri/symbols/SimpleMarkerSymbol
esri/symbols/TextSymbol
Symbol
An optional symbol to use while editing.

ElementTranslationStartedArgs

Arguments for the "display.overlap-element-translate-started" event.
Properties
This object doesn't currently contain any properties.

EnableBackgroundLocationUpdateArgs

Arguments for the system.enable-background-location-updates command.
Properties
androidNotificationMessage
string
The message used in the sticky notification on Android.
androidNotificationTitle
string
The title used in the sticky notification on Android. If null or an empty string, a default title will be used.
taskId
string
The task ID for enabling and disabling background location updates. Once enabled using a certain task ID, background location updates can only be stopped once they are disabled with that same task ID. Cannot be set to null, but if this argument is not provided, a preset default value will be used.

Error

Properties
cause
unknown
messageRequired
string
nameRequired
string
stack
string

EvaluateWorkflowArgs

Arguments for the workflow.evaluate command.
Properties
commandArgumentInput
string
The workflow input that the command's context will map to.
icon
string
An icon to display for the workflow.
idRequired
string
The ID of the workflow item in app config.
inputs
__type
The inputs to be passed into the workflow.
instanceId
string
A unique Id to identify an instance of this workflow running.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to target, if omitted Web will attempt to choose the best map for you. Web only.
target
string
The layout ID of the workflow component to use for any workflow forms, or the ID of a container component like taskbar, panel, stack, etc. In the latter case, a new workflow component will be created dynamically as a child of the targeted container, and removed when the workflow finishes running.
title
string
The title of the workflow.

ExportMapImageArgs

Arguments for the "map.export-image" operation.
Properties
fileName
string
The name of the file to export to.
keepFile
boolean
If true, then the file will be stored permanently in a user accessible directory. If false, a temporary file will be created.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to export. If more than one map is specified, the first will be used. If no maps are specified, a default will be used.

FeatureDetailsEvent

Event args for feature detail events.
Properties
featureRequired
@vertigis.arcgis-extensions.data.Feature.Feature
The feature.

FromGraphicsArgs

Arguments for the "results.from-graphics" operation.
Properties
featureSettings
@vertigis.arcgis-extensions.data.FeatureSettings.FeatureSettingsProperties
FeatureSettings to use for feature metadata if the layer is not provided or can't be found.
fetchAttachments
boolean
Whether to fetch attachments for the returned features. Defaults to false. Mobile only.
fetchRelatedFeatures
boolean
Whether to fetch related features for the returned features. Defaults to false. Mobile only.
graphicsRequired
Any of:
esri/Graphic
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
A selection of graphics to be converted to features.
layer
Any of:
esri/layers/Layer
string
The layer the graphics originate from, or the ID of that layer. Used as the source for created features.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The maps to search for the given layer.
schema
@vertigis.arcgis-extensions.data.Schema.SchemaProperties
The schema to be associated with the returned features. This property is only necessary when no layer nor sublayer are present.
sublayer
Any of:
esri/layers/support/Sublayer
number
The sublayer the graphics originate from, or the ID of that sublayer. Used as the source for created features. Will not be used unless layer parameter is also provided.
title
string
The feature source title to use if no layer or sublayer is associated with the features.
workflowItemId
string
The feature source ID to use if the results are associated with a workflow.

GenericAppsListedArgs

Arguments for the app.generic.apps-listed event. Only available in VertiGIS Studio Mobile.
Properties
devAppsRequired
number
The number of dev apps available.
productionAppsRequired
number
The number of production apps available.
stagingAppsRequired
number
The number of staging apps available.
testAppsRequired
number
The number of test apps available.
totalAppsRequired
number
The total number of apps available.

GeocodeArgs

Arguments for the "geocode.geocode" and "geocode.count" operations.
Properties
addressRequired
Any of:
unknown
@vertigis.arcgis-extensions.data.Feature.Feature
string
The address to look up.
optionsRequired
@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.GeocodeOptions
Options that affect geocode results.

GeolocateAccuracyChangedEventArgs

Arguments for the "geolocation.accuracy-changed" event.
Properties
accuracyRequired
number
The current geolocation accuracy, in meters.

GeolocateCurrentState

Result for the "geolocation.get-current-state" operation.
Properties
accuracyRequired
number
The current accuracy in meters.
isGeolocationAvailableRequired
boolean
Whether or not a position is actively being reported and received.
isGeolocationEnabledRequired
boolean
Whether or not the app has been permitted to use geolocation according to the OS level settings.
positionRequired
esri/geometry/Point
The current position.

GeolocateMetadataChangedEventArgs

Arguments for the "geolocation.metadata-changed" event.
Properties
nmeaPropertiesRequired
NmeaProperties
The GNSS position metadata.

GeolocationEvent

Arguments for geolocation events such as "geolocation.position-acquired" and "geolocation.position-lost".
Properties
gnssDeviceConnectionInfo
GnssDeviceConnectionInfo
The GNSS source associated with the raised geolocation event. Mobile only.

GeolocationStatusChangedEventArgs

Arguments for the "geolocation.status-changed" event.
Properties
isEnabledRequired
boolean
Indicates whether the geolocation is now enabled.

GeometryEditorSettings

Settings for a sketch.
Properties
editorGeometryMode
"area" | "line"
The editor geometry mode.
editorInteractionMode
"centerCrosshairMode" | "pointerMode"
The editor interaction mode.
finishIfInterrupted
boolean
Whether the sketch should commit its geometry if another sketch is activated.
finishOnDoubleClick
boolean
Whether the sketch should stop when double clicking.
freehand
boolean
Whether the sketch is using freehand or segment sketching.
showBearings
boolean
Whether bearing labels should be shown on the map.
snappingEnabled
boolean
Whether snapping should be enabled.

GeometryModeArgs

Arguments for the measurement events. Only available in VertiGIS Studio Mobile.
Properties
geometryModeRequired
"area" | "line"
The geometry mode that is used to perform operations.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

GeometryToolbarArgs

Arguments for the Geometry Toolbar show command. Only available in VertiGIS Studio Mobile.
Properties
isAreaToggleableRequired
boolean
Whether the toolbar will allow users to toggle between area and line drawing modes. Defaults to true.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

GetTransformationArgs

Arguments for getting a list of geographic transformations.
Properties
area
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The area of interest. If provided, this will be used to order the list of valid transformations in order of best-fit.
inputSpatialReference
esri.rest-api.SpatialReferenceJson.SpatialReferenceJson
The input spatial reference to transform. For example, the spatial reference of a GNSS receiver. If unspecified, defaults to WGS84.
outputSpatialReference
esri.rest-api.SpatialReferenceJson.SpatialReferenceJson
The desired output spatial reference of the transformations. For example, the spatial reference of the map. If unspecified, the spatial reference of the first available map will be used.

GetUtilityElementsArgs

Arguments for the getUtilityElementsFromFeatures operation.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
utilityNetworkRequired
esriRuntimeSdk.UtilityNetwork
The utility network involved in the operation.

GetViewInsetsArgs

Result of the "map.get-view-insets" operation.
Properties
bottomRequired
number
The width covering the map from below.
leftRequired
number
The width covering the map on the left.
rightRequired
number
The width covering the map on the right.
topRequired
number
The width covering the map from above.

GnssDeviceAntennaHeightEventArgs

Event args for the geolocation.gnss-antenna-height-changed event.
Properties
heightRequired
number
The antenna height.

GnssDeviceConnectionInfo

A geolocation source.
Properties
deviceFullNameRequired
string
Full name of the GNSS device.
deviceNameRequired
string
Name of the GNSS device.
deviceTypeRequired
"bluetooth" | "emulator" | "integrated" | "usb"
The type of the device. Options are Integrated, Bluetooth, USB, and Emulator.
settingsRequired
GnssDeviceSettings
The device settings, including the correction service's spatial reference, the desired datum transformation, and the device's antenna height.

GnssDeviceTransformationOverrideEventArgs

Event args for the geolocation.gnss-transformation-changed event.
Properties
nameRequired
string
The data transformation name.
wkidRequired
number
The WKID of the transformation.

GnssFixMode

The GNSS fix mode.
Properties
displayTextRequired
string
The display text.
modeRequired
"Fix2D" | "Fix3" | "NotAvailable"
The GPGSA fix mode.

GnssLockStateEventArgs

Event args for the geolocation.gnss-lock-status-changed event.
Properties
lockStatusRequired
number
The lock status.

HasMaps

Defines an object that has a `maps` property.
Properties
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

HasMapsAndFeatures

Defines an object that has a `maps` property and a `features` property.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

HasUITarget

An object with arguments for a command or operation that can display temporary UI.
Properties
attributes
unknown
Optional layout XML attributes to be used for the transient UI container.
icon
string
Optional icon that may be used by the transient UI container.
parent
Any of:
string
The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.

HideMapArgs

Arguments for the "map.hide" operation.
Properties
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to hide.
showSpinnerRequired
boolean
Whether or not to show a spinner while the map is hidden.

HideNotificationArgs

The arguments for the `ui.hide-notification` command.
Properties
id
string
Optional identifier that can be used to hide a particular notification. Web only.

HostAndPortArgs

Arguments for the network.can-reach-host operation.
Properties
hostRequired
string
The host to connect to.
portRequired
number
The port number to connect to. Must be an integer.

IdentifyArgs

Arguments for the tasks.identify operation.
Properties
geometryRequired
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometry to identify by.
layersInScaleRangeOnly
boolean
When "map" is specified, this determines whether to include only layers that are in visible scale range. The default is false. Not supported in VertiGIS Studio Mobile.
layersWithPopupEnabledOnly
boolean
When "map" is specified, this determines whether to include only layers that have the `popupEnabled` layer property set to true. The default is false. Not supported in VertiGIS Studio Mobile.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to identify. Can be used instead of or in addition to "sources". Layers on the map will be used as sources according to the "layersInScaleRangeOnly", "layersWithPopupEnabledOnly", and "visibleLayersOnly" flags.
maxAllowableOffset
number
The maximum allowable offset used for generalizing returned geometries. Not supported in VertiGIS Studio Mobile.
maxResults
number
The maximum number of results to return per source. Not supported in VertiGIS Studio Mobile.
outFields
string[]
List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.
outSpatialReference
esri/geometry/SpatialReference
The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile.
pointTolerance
number
A tolerance value to use for point identify operations. All features falling within a buffer of this many logical pixels around the point will be returned by the identify operation. The default is 10. Not supported in VertiGIS Studio Mobile.
polyTolerance
number
A tolerance value to use for polyline and polygon identify operations. All features falling within a buffer of this many logical pixels around the geometry will be returned by the identify operation. The default is 2. Not supported in VertiGIS Studio Mobile.
returnGeometry
boolean
Whether geometry for features should be returned. Not supported in VertiGIS Studio Mobile.
sources
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource[]
The feature sources to identify. Can be used instead of or in addition to "maps". Not supported in VertiGIS Studio Mobile (use "maps").
visibleLayersOnly
boolean
When "map" is specified, this determines whether to include only visible layers. The default is true. Not supported in VertiGIS Studio Mobile.

InsertPointArgs

Arguments for the "sketching.insert-point" command.
Properties
geometry
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
newPointRequired
esri/geometry/Point
The new point to be added.
partIndex
number
The index of the part to which the point will be added. If null, the last part will be used.
pointIndex
number
The index at which the point will be added. If null, the point will be added as the last point.

JobParameters

A set of parameters used to run a job.
Properties
This object doesn't currently contain any properties.

LayerEventArgs

Arguments for the "layers.visibility-changed" event.
Properties
layerContent
ILayerContent
The layer whose visibility was changed. Mobile only.
layers
Any of:
esri/layers/Layer
@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension
esri.SublayerLike
@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension
@vertigis.arcgis-extensions.data._TableExtension.TableExtension
LayerLike[]
string
The layer whose visibility was changed. Web only.

LayerPresetsArgs

Arguments for the 'layer-presets.apply' command.
Properties
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The associated map to apply the preset to.
presetRequired
@vertigis.arcgis-extensions.layer-preset.LayerPreset.LayerPreset
The LayerPreset to apply to the map.

LayoutMarginChangedArgs

Arguments for the "layout.margin-changed" event.
Properties
marginRequired
Thickness
The new margin thickness.

LicenseRequestArgs

Properties
accountId
string
The accountId (orgId) that we want to check licensing.
applicationName
string
The human readable application name, used for any licensing related ui. Web only.
sku
string
Overwrite the SKU for license check.

LocationDisplayModeChangedEventArgs

Arguments for the "geolocation.display-mode-changed" event.
Properties
locationDisplayModeRequired
"Disabled" | "Enabled" | "Recentering" | "RecenteringAndReorienting"
The location display mode.

MapEvent

Arguments for the various map events.
Properties
mapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map from which the event was generated. Web only.

MapInitializedEvent

Event args for the map.initialized event.
Properties
loadTimeRequired
TimeSpan
The amount of time that the map took to load. Mobile only.
mapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map from which the event was generated. Web only.

MapsFeatureResultArgs

Event args for any events that contain results that were obtained for from a map operation.
Properties
durationRequired
TimeSpan
The amount of time that it took to perform the operation.
errorRequired
Error
The error associated with these results if there is one.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry associated with the event. This may be an alteration of the original geometry (eg. Buffered).
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
originalGeometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The original geometry associated with the event. The original geometry pertains to the original input geometry that was passed into the operation before the event was generated.
sourceOperationRequired
"Add" | "Geocode" | "Identify" | "Search" | "Unknown" | "Workflow"
The type of operation that created these results.
sourcesRequired
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource[]
The feature sources that were used to produce the result.

MapSwitchedEvent

Event args for the map.switched event.
Properties
mapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map from which the event was generated. Web only.
oldMapRequired
esri/Map
The previous map.

MarkupAddedEvent

Event args for the map.markup-added event.
Properties
mapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map from which the event was generated. Web only.
markupTypeRequired
"Composite" | "Multi" | "PictureFill" | "PictureMarker" | "Polygon" | "Polyline" | "Text" | "Unknown"
The markup type of the added markup.

Model

A model belonging to a component.
Properties
idRequired
string
The unique ID for this entity.
itemTypeRequired
string
The item type for this entity when it participates in an App.

NetworkTraceArgs

Arguments for the runTrace operation.
Properties
barriers
esriRuntimeSdk.UtilityElement[]
The barriers to use for the trace (optional).
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
startPointsRequired
esriRuntimeSdk.UtilityElement[]
The start point(s) to use for the trace.
traceConfigurationRequired
esriRuntimeSdk.UtilityNamedTraceConfiguration
The configuration to use for the trace.
utilityNetworkRequired
esriRuntimeSdk.UtilityNetwork
The utility network involved in the operation.

NmeaProperties

Properties
altitude
number
correctionAge
TimeSpan
course
number
estimatedHorizontalAccuracy
number
estimatedVerticalAccuracy
number
fixMethod
string
fixMode
GnssFixMode
fixQuality
"DgpsFix" | "Estimated" | "FloatRtk" | "GpsFix" | "Invalid" | "ManualInput" | "PpsFix" | "Rtk" | "Simulation"
fixTimeUtc
Date
heightOfGeoid
number
horizontalDilutionOfPrecision
number
latitude
number
longitude
number
magneticVariation
number
positionDilutionOfPrecision
number
preciseHorizontalAccuracy
number
preciseVerticalAccuracy
number
satelliteIds
number[]
satellitesInUse
number
satellitesInView
number
speed
number
stationId
number
verticalDilutionOfPrecision
number

OfflineCommandArgs

Arguments for various offline commands.
Properties
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The associated map for the offline command/operation.
offlineAreaRequired
OfflineAreaBase
The offline area to use.
updatePreplannedAreaOnDownloadRequired
boolean
Whether a preplanned map area should update after download. Defaults to false.

OfflineOperationResult

Represents a result from an offline operation.
Properties
downloadLayerErrorsRequired
System.Collections.Generic.IDictionary
A collection of layer errors that occurred while downloading a map area.
downloadTableErrorsRequired
System.Collections.Generic.IDictionary_1
A dictionary of table errors that occurred while downloading a map area.
errorRequired
System.Exception
The Exception that occurred during the operation, or null if no Exception occurred.
errorCodeRequired
number
An `OfflineErrorCode` value indicating the type of error that occurred, or null if successful.
errorCodeStringRequired
string
Gets a string representation of the ErrorCode enum; or null if successful. Useful for consumption in VertiGIS Studio Workflow, instead of having to deal with an integer value for the ErrorCode.
errorMessageRequired
string
A localized, end-user presentable error message, or null if the operation was successful.
nextResultRequired
OfflineOperationResult
An OfflineOperationResult. Can be used to capture multiple results from a chain of offline operations.
successRequired
boolean
Whether or not the operation was successful.
syncLayerErrorsRequired
System.Collections.Generic.IDictionary_4
A dictionary of layer errors that occurred during a sync (submit edits or update) operation.
syncLayerResultsRequired
System.Collections.Generic.IDictionary_2
A dictionary of layer sync results that occurred while submitting edits on or updating a map area.
syncTableErrorsRequired
System.Collections.Generic.IDictionary_1
A dictionary of table errors that occurred during a sync (submit edits or update) operation.
syncTableResultsRequired
System.Collections.Generic.IDictionary_3
A dictionary of table sync results that occurred while submitting edits on or updating a map area.
warningsRequired
string[]
A collection of warnings that occurred during the operation that do not necessarily mean that the operation was failed.

OpenAttachmentArgs

Arguments for the "results.open-attachment" command.
Properties
attachmentsRequired
@vertigis.arcgis-extensions.data.Attachment.Attachment[]
The attachment to open.
senderRequired
VisualElement
The sender UI element to use as an anchor point for animation when opening the attachment.
startIndexRequired
number
The index of the photo to start at.

OpenFileArgs

Arguments to open a file.
Properties
fileNameRequired
string
Name of the file to open. Mobile only.

OpenUrlArgs

Arguments for the system.open-url command.
Properties
context
unknown
An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context.
coordinateOption
Any of:
string
The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item.
numberFormatterLocale
string
The locale to use for number token substitution. Accepts a valid locale code (example: "en", "fr" or "de-AT"), or "device" or "invariant" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.
urlRequired
string
The URL to open.

PickFileArgs

Arguments to pick a file.
Properties
allowedFileTypesRequired
string[]
Allowed types of file used to pick a file. Mobile only.
attachmentTypeRequired
AttachmentType
Type of the attachment used to pick a file. Mobile only.

PrintErrorEventArgs

Arguments for the printing.print-error event.
Properties
downloadLogUrl
string
The URL from which to download the print log created by the engine.
errorCode
number
The HTTP status code associated with the error, if it's a HTTP error.
instanceIdRequired
string
A unique ID to track the running of this print.
messageRequired
string
The error message.
printTemplateIdRequired
string
The ID of the print template being used.

PrintFinishedEventArgs

Arguments for the printing.print-finished event.
Properties
downloadLogUrl
string
The URL from which to download the print log created by the engine.
downloadUrlRequired
string
The URL from which to download the print.
instanceIdRequired
string
A unique ID to track the running of this print.
printTemplateIdRequired
string
The ID of the print template being used.

PrintOutputDimensions

Represents the print output dimensions for a MAP ONLY print.
Properties
heightRequired
number
The height of the map image in pixels.
widthRequired
number
The height of the map image in pixels.

PrintProgressEventArgs

Arguments for the printing.print-progress event.
Properties
instanceIdRequired
string
A unique ID to track the running of this print.
printTemplateIdRequired
string
The ID of the print template being used.

PrintStartedEventArgs

Arguments for the printing.print-started event.
Properties
instanceIdRequired
string
A unique ID to track the running of this print.
printTemplateIdRequired
string
The ID of the print template being used.
title
string
The title of the print.

PublishEventArgs

Arguments for the 'viewer.publish-event' command.
Properties
argumentsRequired
@vertigis.arcgis-extensions.Entity.EntityProperties
The event arguments to be used when publishing the event.
nameRequired
string
The name of the event to be published.

ReferenceLine

A reference line used by the geometry.get-point operation.
Properties
geometryRequired
Any of:
esri/geometry/Polygon
esri/geometry/Polyline
The geometry that contains the reference line.
partIndex
number
The index of the part in 'geometry' that contains the reference line. If null, the last part will be used.
segmentIndex
number
The index of the segment that will be used as the reference line. If null, the last segment will be used.

RemovePointArgs

Arguments for the geometry.remove-point operation.
Properties
geometryRequired
Any of:
esri/geometry/Polygon
esri/geometry/Polyline
The starting geometry.
partIndex
number
The index of the part from which the point will be removed. If null, the last part will be used.
pointIndex
number
The index of the point to be removed. If null, the last point wil be removed.

ReplaceMapArgs

Arguments for the "map.replace*" operations.
Properties
mapExtensionRequired
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
The MapExtension in which to replace the map.
replacementMapRequired
esri/Map
The map with which to replace the current map.

Results

Feature results from an operation.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

ReverseGeocodeArgs

Arguments for the "geocode.reverse-geocode" operation.
Properties
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The location to look up.
optionsRequired
@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.GeocodeOptions
Options that affect geocode results.

RunLayoutPrintArgs

The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing gen2).
Properties
dpi
number
The DPI with which to print.
extent
esri/geometry/Extent
The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions.
id
string
The ID of the layout item to print with. Deprecated; use portalItem instead.
instanceId
string
A unique ID used to track a print job.
layoutId
string
The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map(s) to print.
outputDimensions
PrintOutputDimensions
The print output dimensions for a MAP ONLY print.
outputFormat
"AIX" | "BMP" | "EMF" | "EPS" | "GIF" | "JPG" | "PDF" | "PNG" | "PNG32" | "SVG" | "SVGZ" | "TGA" | "TIFF"
The print output format. Defaults to PDF if undefined or if layout package print is performed.
parameters
JobParameters
Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields.
portalItem
Any of:
esri/portal/PortalItem
esri.rest-api.ItemJson.ItemJson
@vertigis.arcgis-extensions.PortalUri.PortalUri
@vertigis.arcgis-extensions.utilities.uri.Uri
string
The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed.
scaleRequired
number
The print scale.
title
string
The title of the print.

RunPrintArgs

The arguments required by the printing.run command when printing with templates (printing gen1).
Properties
dpi
number
The DPI with which to print.
extent
esri/geometry/Extent
The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used.
grid
esri/geometry/SpatialReference
The WKID of the spatial reference used to draw a grid on the map(s).
id
string
The ID of the report item.
instanceId
string
A unique ID used to track a print job.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map(s) to print.
parameters
JobParameters
Additional parameters used in the print template, specified as key-value pairs.
portalItem
Any of:
esri/portal/PortalItem
esri.rest-api.ItemJson.ItemJson
@vertigis.arcgis-extensions.PortalUri.PortalUri
@vertigis.arcgis-extensions.utilities.uri.Uri
string
The portal item where the print template is located.
rotation
number
The rotation of the map(s). Defaults to the map's current rotation.
scale
number
The scale of the map(s). Defaults to the map's current scale.
title
string
The title of the print.
viewpoint
esri/Viewpoint
The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint.

RunWorkflowArgs

Arguments for the workflow.run command.
Properties
async
boolean
Whether or not the workflow should be executed asynchronously. If this property is true, the workflow will be executed but the command will not wait for it to finish. Defaults to false. Web only.
commandArgumentInput
string
The workflow input that the command's context will map to.
icon
string
An icon to display for the workflow.
idRequired
string
The ID of the workflow item in app config.
inputs
__type
The inputs to be passed into the workflow.
instanceId
string
A unique Id to identify an instance of this workflow running.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to target, if omitted Web will attempt to choose the best map for you. Web only.
target
string
The layout ID of the workflow component to use for any workflow forms, or the ID of a container component like taskbar, panel, stack, etc. In the latter case, a new workflow component will be created dynamically as a child of the targeted container, and removed when the workflow finishes running.
title
string
The title of the workflow.

SaveStorageDataArgs

Arguments for the app.set-persistent-data operations. Only available in VertiGIS Studio Mobile.
Properties
dataRequired
unknown
The data to be stored.
keyRequired
string
The key of the data to store.
scope
"app" | "global" | "memory"
The scope the data is stored in. Defaults to

SearchArgs

Arguments for search operations.
Properties
disableSearchAreaExpansion
boolean
By default the search area will be expanded to try and return the specified maxResults. Set to true to disable this behavior. Not supported in VertiGIS Studio Mobile.
mapViewpoint
esri/Viewpoint
The map Viewpoint at the time of the search. Mobile only.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map(s) to search. Can be used instead of or in addition to "sources". This property is required in VertiGIS Studio Mobile.
maxQueryResults
number
The maximum number of results to query per source, the results per source will still be limited by maxResults.
maxResults
number
The maximum number of results to return per source.
near
esri/geometry/Point
If specified, this will influence the score of spatial features based on their proximity to this point. Most commonly this would be the user's current location, but can be any point of interest. This option requires searchArea to also be specified. Not supported in VertiGIS Studio Mobile.
outSpatialReference
esri/geometry/SpatialReference
The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile.
searchArea
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
If specified, results are limited to features that intersect the geometry. This property is required in VertiGIS Studio Mobile.
searchTextRequired
string
The text to search for. Required.
sourceId
string
Id of source to filter for.
sources
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource[]
The feature sources to search. Can be used instead of or in addition to "maps". Not supported in VertiGIS Studio Mobile (use "maps").

SearchCompletedArgs

Arguments for the search.completed event.
Properties
durationRequired
TimeSpan
The amount of time that it took to perform the operation.
errorRequired
Error
The error associated with these results if there is one.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry associated with the event. This may be an alteration of the original geometry (eg. Buffered).
mapViewpointRequired
esri/Viewpoint
The map viewpoint at the time of the search.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
maxResultsRequired
number
The maximum number of search results that could be returned.
originalGeometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The original geometry associated with the event. The original geometry pertains to the original input geometry that was passed into the operation before the event was generated.
searchTextRequired
string
The text used in the search.
sourceOperationRequired
"Add" | "Geocode" | "Identify" | "Search" | "Unknown" | "Workflow"
The type of operation that created these results.
sourcesRequired
@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource[]
The feature sources that were used to produce the result.

SetBasemapWithTargetMapArg

Argument used in case when we have more than 1 map in the app, and we need to pass the target map from outside (eg basemap picker in VertiGIS Studio Web).
Properties
basemapRequired
Any of:
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension
@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension[]
string
Basemap to be set.
mapRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Target map.

SetConstraintsArgs

Arguments for the "sketching.set-constraints" command.
Properties
angle
number
The constraint for the angle of the line between the selected vertex and the new point, relative to the reference line. Remains unchanged until set to a different value, or cleared.
autoClear
boolean
Indicates whether constraints will be automatically cleared after a vertex is added or updated. If not set (value is null), then the value will remain unchanged with this operation. If the value has never been set, the default is false. Remains unchanged until set to a different value.
geodetic
boolean
Indicates whether the distance calculations will be geodetic or planar. Default is true.
geodeticCurveType
"geodesic" | "great-elliptic" | "loxodrome" | "normal-section"
The geodetic curve type used when calculating the new point. Only applies when geodetic is set to true. Defaults to geodesic.
length
number
The constraint for the length of the line between the selected vertex and the new point.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
referenceLine
ReferenceLine
A reference line that the angle will be relative to. Defaults to 'north'. Remains unchanged until set again.
units
"centimeters" | "cm" | "feet" | "ft" | "in" | "inches" | "kilometers" | "km" | "m" | "meters" | "mi" | "miles" | "millimeters" | "mm" | "nautical-miles" | "nm" | "yards" | "yd"
The units to be used for length. If not specified, the units of the map's spatial reference will be used.

SetGeometryModeArgs

Arguments for the "sketching.set-geometry-mode" command.
Properties
editorGeometryModeRequired
"area" | "circle" | "extent" | "line" | "multipoint" | "point" | "polygon" | "polyline" | "square"
The geometry mode to switch to. VertiGIS Studio Mobile only supports "line" and "area".
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

SetInteractionModeArgs

Arguments for the "sketching.set-interaction-mode" command.
Properties
editorInteractionModeRequired
"centerCrosshairMode" | "pointerMode"
The interaction mode to switch to.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

SetLocationSymbolArgs

Arguments for the geolocation.set-location-symbol command.
Properties
color
Any of:
esri/Color
esri.rest-api.SymbolJson.ColorJson
string
The color to use for the location marker's fill and the accuracy circle's outline.
default
boolean
If true, all other properties will be ignored and the location symbol will be reset to the default symbol.
outline
esri/symbols/SimpleLineSymbol
The symbol to use for the outline of the location marker.
size
number
The size to use for the location marker.
style
string
The style to use for the location marker. Valid values are: circle, cross, diamond, square, triangle and X.

SetSnappingConfigurationArgs

Arguments for the "sketching.set-snapping-configuration" command.
Properties
configRequired
SnappingProperties
The snapping properties to set.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
mode
"merge" | "replace"
Whether the config should be replace, or merged. Defaults to "merge".

ShortcutArgs

The arguments for keyboard shortcut events.
Properties
keyRequired
ConsoleKeyInfo
The key combination this shortcut uses.

SignInCompletedEventArgs

Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed events. Only available in VertiGIS Studio Mobile.
Properties
identityRequired
ArcGISPortalIdentity
The identity that was obtained from the sign in.

SignInEventArgs

Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.
Properties
authenticationTypeRequired
"Network" | "OAuth2" | "Token" | "Unknown"
The authentication method used for the sign in process. Not available in VertiGIS Studio Web.
portalTypeRequired
"AGOL" | "ArcGISEnterprise"
The type of Portal: AGOL or Enterprise.
requestInfoRequired
unknown
Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile.

SignInFailedEventArgs

Arguments for the auth.sign-in-failed event. Only available in the VertiGIS Studio Mobile Viewer.
Properties
authenticationTypeRequired
"Network" | "OAuth2" | "Token" | "Unknown"
The authentication method used for the sign in process. Not available in VertiGIS Studio Web.
exceptionRequired
unknown
The exception that occurred during the sign in. Not available in VertiGIS Studio Web.
portalTypeRequired
"AGOL" | "ArcGISEnterprise"
The type of Portal: AGOL or Enterprise.
requestInfoRequired
unknown
Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile.

SnapHostPanelArgs

Arguments for the "panel.snap-host-panel" command.
Properties
snapPosition
"collapsed" | "hidden" | "middle" | "top"
The position to snap to.
userSet
boolean
Snap to the last position set by the user.

SnappingConnections

Well known connection points for Snapping.
Properties
edge
boolean
Enable connections to an edge, defaults to true.
vertices
boolean
Enable connections to vertices, defaults to allow all connections.

SnappingDestinationProperties

Configuration for snapping destinations.
Properties
destinationRequired
Any of:
@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension
@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension
The destination layer or sublayer extension.
sqlQuery
string
Optional SQL92 formatted query for filtering features to be considered for snapping.

SnappingProperties

Global configuration for snapping.
Properties
enableTooltips
boolean
Enable a tooltip that shows the name of the layer that has been snapped to and the type of the snap target, i.e. vertex or edge. Defaults to true.
enableUtilityNetworkRules
boolean
Enable the automatic application of feature class based rules if any utility networks are included in the web map.
maxSearchRadius
number
The radius in screen units in which to search for things to snap to (these are displayed as guides). Should be larger than snappingRadius. Defaults to 150.
maxSnappingGuides
number
Indicates the maximum number of snapping guides to be displayed at any time. Defaults to 4.
respectLayerVisibility
boolean
Indicates that snapping should respect the layer's visibility in the layer list, i.e. if a layer is not checked here it will not be considered for snapping. Defaults to true.
snappingRadius
number
The radius in screen units in which the user will be automatically snapped. Defaults to 25.
sourceMappings
SnappingSourceMapping[]
Configuration for snapping sources.

SnappingSourceMapping

Maps snapping source layers to destination layers to be considered.
Properties
connections
SnappingConnections
Types of snapping connections to be considered for this source.
destinations
SnappingDestinationProperties[]
The snapping destinations, if not provided all destinations will be considered.
guideColor
esri/Color
The color to use for snapping guides generated by this source.
required
"all-points" | "initial-points" | "off"
Turns on validation of snapping. "initial-points" requires the first point to snap (in draw mode) or pre-existing snapped points to snap (in edit mode). Defaults to "off".
source
Any of:
@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension
@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension
The snapping source. If omitted the configuration will be applied to all existing sources.

SpecificAppArgs

Arguments for the app started events. Only available in VertiGIS Studio Mobile.
Properties
loadTimeRequired
TimeSpan
The amount of time that the app took to load.
uniqueKeyRequired
string
A unique identifier for the app.

StartSketchArgs

Arguments for the "map.start-sketch" operation.
Properties
bufferSizeRequired
number
The size of the buffer to be created around the geometry. If null or a negative value, no buffer will be created. This is currently only supported for line geometry types.
editorSettingsRequired
GeometryEditorSettings
The settings to be applied to the sketch.
geometryRequired
Any of:
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
The geometry to edit.
geometryTypeRequired
esri.rest-api.GeometryJson.GeometryJsonType
The type of geometry to edit.
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map to sketch on.
maxSegments
number
The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.
resumeIdRequired
string
Gets a resume ID for the sketch. Cannot be set.
retainEditorSettingsRequired
boolean
Whether the previous geometry editor settings should be restored after this sketch is stopped.
symbol
esri.rest-api.SymbolJson.SymbolJson
An optional symbol to use.

StartStreamingArgs

Arguments for the "sketching.start-streaming" command.
Properties
interval
number
An optional value indicating, in seconds, how often points should be recorded.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.

StopGeometryEditArgs

Arguments for the "sketching.stop" operation.
Properties
mapsRequired
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The maps on which to stop editing geometry.
validateGeometry
boolean
Whether to validate the geometry before returning it. Defaults to true if not set.

StorageDataArgs

Arguments for the reading app.*-persistent-data operations. Only available in VertiGIS Studio Mobile.
Properties
keyRequired
string
The key of the data to store.
scope
"app" | "global" | "memory"
The scope the data is stored in. Defaults to

SuggestArgs

Arguments for the "geocode.suggest" operation.
Properties
optionsRequired
@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.GeocodeOptions
Options that affect geocode results.
searchTextRequired
string
The search text entered by the user.

SymbolSet

A set of symbols that can be used to sketch geometries.
Properties
lineSymbol
Any of:
esri/symbols/SimpleLineSymbol
esri.rest-api.SymbolJson.SimpleLineSymbolJson
The symbol used to draw lines.
lineSymbol3D
Any of:
esri/symbols/LineSymbol3D
esri.rest-api.SymbolJson.LineSymbol3DJson
The symbol used to draw 3D lines.
pointSymbol
Any of:
esri/symbols/PictureMarkerSymbol
esri/symbols/SimpleMarkerSymbol
esri.rest-api.SymbolJson.PictureMarkerSymbolJson
esri.rest-api.SymbolJson.SimpleMarkerSymbolJson
The symbol used to draw points.
pointSymbol3D
Any of:
esri/symbols/PointSymbol3D
esri.rest-api.SymbolJson.PointSymbol3DJson
The symbol used to draw 3D points.
polygonSymbol
Any of:
esri/symbols/PictureFillSymbol
esri/symbols/SimpleFillSymbol
esri.rest-api.SymbolJson.PictureFillSymbolJson
esri.rest-api.SymbolJson.SimpleFillSymbolJson
The symbol used to draw polygons.
polygonSymbol3D
Any of:
esri/symbols/PolygonSymbol3D
esri.rest-api.SymbolJson.PolygonSymbol3DJson
The symbol used to draw 3D polygons.

TargetsResultsSetArgs

Arguments for various commands that target a result set of features.
Properties
resultsSetId
string
If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results. Web only.

TimeSpan

Properties
This object doesn't currently contain any properties.

TraceCompletedArgs

Results from a completed trace.
Properties
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
traceConfigurationRequired
esriRuntimeSdk.UtilityNamedTraceConfiguration
The configuration that was used to get these results.
traceResultsRequired
esriRuntimeSdk.UtilityTraceResult[]
Results from the trace.
utilityNetworkRequired
esriRuntimeSdk.UtilityNetwork
The utility network involved in the operation.

TrackCustomEventArgs

Arguments for the 'studio-analytics.track-custom-event' command.
Properties
nameRequired
string
The name of the event. The event name should be in kebab-case, present tense, and follow a `{noun phrase}-{verb}` pattern, where `{verb}` is a single word without hyphens. Example: "parcel-boundary-move".
payload
string
Optional. Additional event-specific data of interest.

TranslateOptions

The available options for the Locale Service translate function.
Properties
args
[]
The values to substitute into the format string if it contains substitution placeholders (see utilities/string/format in ArcGIS Extensions API).
currency
string
The default unit of currency to use when formatting currency. See {@link utilities /format/number!NumberSettings.currency}.
dateFormat
string
The default format to use when formatting dates. See {@link utilities /format/date!DateFormatter.format}.
defaultValue
string
An optional default value to fallback to when a language resource key does not exist. Web only.
fractionalDigits
number
The default number of digits to show after the decimal point when formatting numbers. See {@link utilities /format/number!NumberSettings.fractionalDigits}.
locale
string
The locale to use for translation. If not specified, the current locale will be used.
numberFormat
string
The default format to use when formatting numbers. See {@link utilities /format/number!NumberFormatter.format}.
textRequired
string
The string to translate. If the text is a language resource key, then a localized version of that resource will be used if one exists, otherwise the original text is returned.
timeFormat
string
The default format to use when formatting times. See {@link utilities /format/time!TimeFormatter.format}.
timeZone
string
The time zone of a date being formatted. See {@link utilities /format/date!DateFormatter.timeZone}.

UpdateResultsFeaturesArgs

Arguments for various commands that affect a result component's features.
Properties
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
results
Any of:
string
The result component to update, referenced by results model or its ID. Web only.
resultsSetId
string
If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results. Web only.

UploadDataArgs

Arguments for the "results.upload-data-args-to-feature" operation.
Properties
dataRequired
array[]
The cells in the table.
dateFormat
string
The format for dates. The default is DateFormat.ROUND_TRIP. This can be a defined DateFormat string, the "timestamp" pseudo-format, or a custom format string.
displayField
string
Typically a string field with text formatted for display.
escapeFormulaChars
boolean
Whether to a prefix values that start with typical formula triggering chars (=,-,+,@).
generatePrimaryKey
boolean
Indicates if a primary key should be generated if not found, defaults to true.
geometryFields
string[]
The names of the geometry field(s).
geometryFormat
@vertigis.arcgis-extensions.data.convert.GeometryFormat
The format of the geometry in this table.
inSpatialReference
esri/geometry/SpatialReference
The spatial reference of the geometry in this table.
includeHeaderRow
boolean
The header row contains column names.
locale
string
The locale to use for formatting values. Accepts a valid locale code (example: "inv", "fr" or "de-AT"). Default is "inv" or invariant culture.
numberFormat
string
The format for numbers. The default is NumberFormat.ROUND_TRIP.
outFields
string[]
A list of fields to include. Defaults to the FeatureSources PopupTemplate outfields if available, otherwise "*" meaning all fields.
outSpatialReference
esri/geometry/SpatialReference
The output spatial reference of the converted table.
primaryKeyField
string
Optionally the primary key field.
timeFormat
string
The format for time-only fields. The default is TimeFormat.ROUND_TRIP. This can be a defined TimeFormat string, or a custom format string.
title
string
A title for this dataset.
useFormattedValues
boolean
If true, the configured formatters will be run on the raw values in the supplied data and these values will be output with type information if possible. If false, the formatted or presentable values already present in the supplied data will be taken 'as-is'. Field types configured on the input will be ignored and all values will be output as strings.

UserWentOnlineEventArgs

Arguments for the "offline.user-went-online" event.
Properties
previouslyActiveAreaRequired
OfflineAreaBase
The area that was previously active.

UtilityNetworkArgs

Arguments relating to a utility network.
Properties
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
utilityNetworkRequired
esriRuntimeSdk.UtilityNetwork
The utility network involved in the operation.

viewer-spec.ActionObject

Properties
nameRequired
string
The name of a command or operation.
argumentsRequired
unknown
The arguments for the command or operation.

WebAddAttachmentArgs

VertiGIS Studio Web's arguments for the "edit.add-attachment" command. Not supported by Mobile.
Properties
blobsRequired
Any of:
File
File[]
The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachment will be added to the feature(s).
featuresRequired
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
The feature(s) to add the attachment(s) to. If multiple features are specified, the attachment(s) will be added to all features.

WebOpenUrlArgs

VertiGIS Studio Web's arguments for the system.open-url command.
Properties
coordinateOption
Any of:
string
The coordinate option to use when formatting coordinate tokens. Valid options must support latitude and longitude. Can be a reference to an existing 'coordinate-option' item, or inline JSON defining a coordinate option item.
features
Any of:
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
Features to use for the command/operation.
geometry
Any of:
esri/Graphic
@vertigis.arcgis-extensions.data.Feature.Feature
@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet
@vertigis.arcgis-extensions.data.FeatureList.FeatureList
@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream
@vertigis.arcgis-extensions.data.Feature.Feature[]
esri/geometry/Extent
esri/geometry/Multipoint
esri/geometry/Point
esri/geometry/Polygon
esri/geometry/Polyline
esri/geometry/Mesh
esri.rest-api.FeatureJson.FeatureJson
esri/rest/support/FeatureSet
esri/Graphic[]
esri.rest-api.FeatureJson.FeatureJson[]
esri.rest-api.GeometryJson.PointJson
esri.rest-api.GeometryJson.MultipointJson
esri.rest-api.GeometryJson.PolylineJson
esri.rest-api.GeometryJson.PolygonJson
esri.rest-api.GeometryJson.ExtentJson
esri/geometry/Extent[]
esri/geometry/Multipoint[]
esri/geometry/Point[]
esri/geometry/Polygon[]
esri/geometry/Polyline[]
esri/geometry/Mesh[]
esri.rest-api.GeometryJson.PointJson[]
esri.rest-api.GeometryJson.MultipointJson[]
esri.rest-api.GeometryJson.PolylineJson[]
esri.rest-api.GeometryJson.PolygonJson[]
esri.rest-api.GeometryJson.ExtentJson[]
The geometry to use for the command/operation.
layers
Any of:
esri/layers/Layer
@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension
esri.SublayerLike
@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension
@vertigis.arcgis-extensions.data._TableExtension.TableExtension
LayerLike[]
string
Layer(s) to use for the command/operation.
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
Map(s) to use for the command/operation.
numberFormatterLocale
string
The locale to use for number token substitution. Accepts a valid locale code (example: "en", "fr" or "de-AT"), or "device" or "invariant" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.
urlRequired
string
The URL to open.

WorkflowErrorEventArgs

Arguments for the "workflow.workflow-error" event.
Properties
errorMessage
string
The human readable error message.
exception
Error
The Error object containing detailed information about the error.
workflowRequired
WorkflowModel
The workflow pertaining to the event.

WorkflowFinishedEventArgs

Arguments for the "workflow.workflow-finished" event.
Properties
workflowRequired
WorkflowModel
The workflow pertaining to the event.

WorkflowStartingEventArgs

Arguments for the "workflow.workflow-starting" event.
Properties
workflowRequired
WorkflowModel
The workflow pertaining to the event.

ZoomToViewpointArgs

Arguments for the map.zoom-to-viewpoint command.
Properties
maps
Any of:
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension
@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[]
The map(s) to zoom. If omitted, all maps will be zoomed.
viewpointRequired
Any of:
@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties
esri/Viewpoint
esri.rest-api.ViewpointJson.ViewpointJson
@vertigis.arcgis-extensions.mapping.Bookmark.Bookmark
string
The viewpoint to zoom to.
Edit this page