@vertigis/viewer-spec

{ "$ref": "#/definitions/viewer-spec.Event", "definitions": { "@vertigis.arcgis-extensions.FailureMode.FailureMode": { "description": "Possible modes of failure when there is an error resolving or initializing an item.", "enum": [ "error", "ignore", "warn" ], "type": "string" }, "@vertigis.arcgis-extensions.Hyperlink.HyperlinkProperties": { "additionalProperties": false, "description": "A hyperlink associated with a feature or layer.", "properties": { "iconUrl": { "description": "See {@link Hyperlink.iconUrl}.", "type": "string" }, "target": { "description": "See {@link Hyperlink.target}.", "type": "string" }, "text": { "description": "See {@link Hyperlink.text}.", "type": "string" }, "tooltip": { "description": "See {@link Hyperlink.tooltip}.", "type": "string" }, "url": { "description": "See {@link Hyperlink.url}.", "type": "string" } }, "required": [ "text", "url" ], "type": "object" }, "@vertigis.arcgis-extensions.data.Feature.FeatureProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link data /Feature!Feature}.", "properties": { "attributes": { "anyOf": [ {}, { "$ref": "Map" } ], "description": "The feature's attributes, keyed by field name." }, "failureMode": { "$ref": "#/definitions/@vertigis.arcgis-extensions.FailureMode.FailureMode", "description": "See {@link support /InitializableBase!InitializableBase.failureMode}." }, "geometry": { "anyOf": [ { "$ref": "#/definitions/esri.Geometry" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.MultipointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolylineJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolygonJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson" } ], "description": "The feature's geometry." }, "id": { "description": "The unique ID to assign to the entity. If not specified, one will be generated.", "type": "string" }, "schema": { "$ref": "#/definitions/@vertigis.arcgis-extensions.data.Schema.SchemaProperties", "description": "Metadata about the feature, such as fields, domains, geometry type, etc." }, "settings": { "$ref": "#/definitions/@vertigis.arcgis-extensions.data.FeatureSettings.FeatureSettingsProperties", "description": "Settings for this feature." }, "source": { "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource", "description": "The source of the feature." } }, "type": "object" }, "@vertigis.arcgis-extensions.data.FeatureSettings.FeatureSettingsProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link data /FeatureSettings!FeatureSettings}.", "properties": { "formatSettings": { "$ref": "#/definitions/@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties", "description": "Settings affecting how feature attributes are formatted." }, "hyperlinkTemplates": { "description": "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.", "items": { "anyOf": [ { "$ref": "@vertigis.arcgis-extensions.Hyperlink.HyperlinkProperties" }, { "$ref": "@vertigis.arcgis-extensions.Hyperlink.Hyperlink" } ] }, "type": "array" }, "maxAllowableOffset": { "description": "See {@link data /FeatureSettings!FeatureSettings.maxAllowableOffset}.", "type": "number" }, "outFields": { "description": "See {@link data /FeatureSettings!FeatureSettings.outFields}.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "$ref": "#/definitions/esri.SpatialReference", "description": "See {@link data /FeatureSettings!FeatureSettings.outSpatialReference}." }, "popupContentExtensions": { "description": "See {@link data /FeatureSettings!FeatureSettings.popupContentExtensions}.", "items": { "anyOf": [ { "$ref": "@vertigis.arcgis-extensions.data.PopupContentExtension.PopupContentExtensionProperties" }, { "$ref": "@vertigis.arcgis-extensions.data.PopupContentExtension.PopupContentExtension" } ] }, "type": "array" }, "popupTemplate": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson" }, { "$ref": "#/definitions/esri.PopupTemplate" } ], "description": "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": { "description": "See {@link data /FeatureSettings!FeatureSettings.returnGeometry}.", "type": "boolean" }, "showRelatedRecordsWhenUnconfigured": { "description": "See {@link data /FeatureSettings!FeatureSettings.showRelatedRecordsWhenUnconfigured}.", "type": "boolean" }, "zoomFactor": { "description": "See {@link data /FeatureSettings!FeatureSettings.zoomFactor}.", "type": "number" }, "zoomScale": { "description": "See {@link data /FeatureSettings!FeatureSettings.zoomScale}.", "type": "number" } }, "type": "object" }, "@vertigis.arcgis-extensions.data.FieldExtension.FieldExtensionProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link data /FieldExtension!FieldExtension}.", "properties": { "failureMode": { "$ref": "#/definitions/@vertigis.arcgis-extensions.FailureMode.FailureMode", "description": "See {@link support /InitializableBase!InitializableBase.failureMode}." }, "field": { "anyOf": [ { "$ref": "#/definitions/esri.Field" }, { "$ref": "#/definitions/@vertigis.arcgis-extensions.data.FieldExtension.FieldProperties" }, { "type": "string" } ], "description": "The Esri Field object being extended." }, "format": { "description": "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.", "type": "string" }, "formatSettings": { "$ref": "#/definitions/@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties", "description": "Settings that affect how values are formatted. Depending on the type of field, some or all of these settings may not be applicable." }, "id": { "description": "The unique ID to assign to the entity. If not specified, one will be generated.", "type": "string" }, "searchable": { "description": "Whether the field is searchable or not.", "type": "boolean" } }, "type": "object" }, "@vertigis.arcgis-extensions.data.FieldExtension.FieldProperties": { "additionalProperties": false, "description": "Properties that extend the ArcGis portal representation of a Field.", "properties": { "$ref": { "description": "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.", "type": "string" }, "alias": { "description": "The field alias (human-readable name).", "type": "string" }, "domain": { "$ref": "#/definitions/esri.rest-api.DomainJson.DomainJson", "description": "A domain object that provides the attribute domain information for the field, if a domain exists." }, "editable": { "description": "Whether this field is editable.", "type": "boolean" }, "exactMatch": { "description": "A Boolean defining whether or not the field is an exact match.", "type": "boolean" }, "length": { "description": "A number defining how many characters are allowed in a string field.", "type": "number" }, "name": { "description": "A string defining the field name.", "type": "string" }, "nullable": { "description": "Whether this field can have a null value.", "type": "boolean" }, "type": { "$ref": "#/definitions/esri.rest-api.FieldJson.FieldJsonType", "description": "Type of the Field. See {@link FieldJsonType}." } }, "type": "object" }, "@vertigis.arcgis-extensions.data.PopupContentExtension.ContentProperties": { "additionalProperties": false, "description": "Properties that extend the ArcGis portal representation of a PopupContent.", "properties": { "$ref": { "$ref": "@vertigis.arcgis-extensions.data.PopupContentExtension.ContentRef", "description": "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": { "description": "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": { "description": "An optional string value describing the element in detail. This property does not apply when the type is text or expression.", "type": "string" }, "displayCount": { "description": "This property applies to elements of type relationship. An integer that indicates the maximum number of records to display.", "type": "number" }, "displayType": { "description": "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.", "type": "string" }, "expressionInfo": { "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupExpressionInfoJson", "description": "This property applies to elements of type expression. An Arcade expression that defines the pop-up element content." }, "fieldInfos": { "description": "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.", "items": { "$ref": "#/definitions/esri.rest-api.PopupInfoJson.FieldInfoJson" }, "type": "array" }, "mediaInfos": { "description": "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.", "items": { "$ref": "#/definitions/esri.rest-api.PopupInfoJson.MediaInfoJson" }, "type": "array" }, "orderByFields": { "description": "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.", "items": { "$ref": "#/definitions/esri.rest-api.PopupInfoJson.OrderByFieldsJson" }, "type": "array" }, "relationshipId": { "description": "This property applies to elements of type relationship. The id of the relationship as defined in the feature layer definition.", "type": "number" }, "text": { "description": "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.", "type": "string" }, "title": { "description": "An optional string value indicating what the element represents. This property does not apply when the type is text or expression.", "type": "string" }, "type": { "description": "String value indicating which element to use.", "enum": [ "attachments", "expression", "fields", "media", "relationship", "text" ], "type": "string" } }, "type": "object" }, "@vertigis.arcgis-extensions.data.PopupContentExtension.PopupContentExtensionProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link PopupContentExtension}.", "properties": { "content": { "anyOf": [ { "$ref": "#/definitions/esri.Content" }, { "$ref": "#/definitions/@vertigis.arcgis-extensions.data.PopupContentExtension.ContentProperties" } ], "description": "The ESRI Content instance to be extended." }, "failureMode": { "$ref": "#/definitions/@vertigis.arcgis-extensions.FailureMode.FailureMode", "description": "See {@link support /InitializableBase!InitializableBase.failureMode}." }, "id": { "description": "The unique ID to assign to the entity. If not specified, one will be generated.", "type": "string" }, "summaryHiddenFields": { "description": "Names of fields that will be hidden when displayed in the a summary view. This property is only applied to \"fields\" Content types.", "items": { "type": "string" }, "type": "array" }, "visibleInSummary": { "description": "Whether the Content is visible when being displayed in a summary view.", "type": "boolean" } }, "type": "object" }, "@vertigis.arcgis-extensions.data.Schema.SchemaProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link data /Schema!Schema}.", "properties": { "displayField": { "description": "See {@link data /Schema!Schema.displayField}.", "type": "string" }, "fieldExtensions": { "description": "See {@link data /Schema!Schema.fieldExtensions}.", "items": { "anyOf": [ { "$ref": "@vertigis.arcgis-extensions.data.FieldExtension.FieldExtensionProperties" }, { "$ref": "@vertigis.arcgis-extensions.data.FieldExtension.FieldExtension" } ] }, "type": "array" }, "fields": { "description": "See {@link data /Schema!Schema.fields}.", "items": { "anyOf": [ { "$ref": "#/definitions/esri.Field" }, { "$ref": "#/definitions/esri.rest-api.FieldJson.FieldJson" } ] }, "type": "array" }, "geometryType": { "$ref": "#/definitions/esri.rest-api.GeometryJson.GeometryJsonType", "description": "See {@link data /Schema!Schema.geometryType}." }, "primaryKeyField": { "description": "See {@link data /Schema!Schema.primaryKeyField}.", "type": "string" }, "spatialReference": { "$ref": "#/definitions/esri.SpatialReference", "description": "See {@link data /Schema!Schema.spatialReference}." }, "timeZone": { "description": "See {@link data /Schema!Schema.timeZone}.", "type": "string" }, "typeIdField": { "description": "See {@link data /Schema!Schema.typeIdField}.", "type": "string" }, "types": { "description": "See {@link data /Schema!Schema.types}.", "items": { "anyOf": [ { "$ref": "#/definitions/esri.FeatureType" }, { "$ref": "#/definitions/esri.rest-api.TypeJson.TypeJson" } ] }, "type": "array" } }, "type": "object" }, "@vertigis.arcgis-extensions.data._TableExtension.TableReference": { "additionalProperties": false, "description": "Matches an existing table in a map.", "properties": { "id": { "description": "The table's ID.", "type": "string" }, "title": { "description": "The table's title.", "type": "string" } }, "type": "object" }, "@vertigis.arcgis-extensions.mapping.MapExtension.ViewMode": { "description": "Viewing mode for a map (2D map or 3D scene).", "enum": [ "map", "scene" ], "type": "string" }, "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": { "additionalProperties": false, "description": "Matches an existing layer.", "properties": { "id": { "description": "The layer's ID.", "type": "string" }, "path": { "description": "The path to the geodatabase used by an MMAP layer. Mobile only.", "type": "string" }, "subtype": { "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.", "type": "string" }, "title": { "description": "The layer's title.", "type": "string" }, "url": { "description": "The layer's url.", "type": "string" } }, "type": "object" }, "@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link FormatSettings}.", "properties": { "currency": { "description": "The 3-letter ISO 4217 currency code (e.g \"USD\", \"CAD\"). Required when formatting a number using NumberFormat.CURRENCY or NumberFormat.ACCOUNTING.", "type": "string" }, "dateFormat": { "description": "The default format for date values. Either a {@link utilities /format/formats!DateFormat} constant, or a custom date format string.", "type": "string" }, "fractionalDigits": { "description": "The number of digits to show after the decimal point. If unspecified, an appropriate value is determined based on the locale and currency.", "type": "number" }, "locale": { "description": "The locale to use when formatting values.", "type": "string" }, "numberFormat": { "description": "The default format for number values. Either a {@link utilities /format/formats!NumberFormat} constant, or a custom number format string.", "type": "string" }, "timeFormat": { "description": "The default format for time values. Either a {@link utilities /format/formats!DateFormat} constant, or a custom time format string.", "type": "string" }, "timeZone": { "description": "The time zone to display date/time data in. The default will be the user's local time zone.", "type": "string" }, "useFieldInfo": { "description": "Whether to use formatting from the field info if it is specified.", "type": "boolean" } }, "type": "object" }, "ArcGISPortalIdentity": { "additionalProperties": false, "type": "object" }, "AuthenticationType": { "description": "A type of authentication.", "enum": [ "Network", "OAuth2", "Token", "Unknown" ], "type": "string" }, "ComponentId": { "description": "A component's ID in the layout.", "type": "string" }, "CreateGraphicsResult": { "additionalProperties": false, "description": "Result of the \"drawing.create-graphics\" and \"measurement.create-graphics\" operations.", "properties": { "graphics": { "description": "The resulting graphics.", "items": { "$ref": "#/definitions/esri.Graphic" }, "type": "array" }, "maps": { "$ref": "MapsLike", "description": "The map that the graphics were created on. Only available in Web." } }, "required": [ "graphics", "maps" ], "type": "object" }, "EffectFunctionJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.LayerJson.HueRotateEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.BlurEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.DropShadowEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.BloomEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.BrightnessEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.ContrastEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.GrayscaleEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.InvertEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.OpacityEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.SaturateEffectFunctionJson" }, { "$ref": "#/definitions/esri.rest-api.LayerJson.SepiaEffectFunctionJson" } ], "description": "Effect functions that can be combined to build a layer effect." }, "Error": { "additionalProperties": false, "properties": { "cause": {}, "message": { "type": "string" }, "name": { "type": "string" }, "stack": { "type": "string" } }, "required": [ "message", "name" ], "type": "object" }, "GeolocateAccuracyChangedEventArgs": { "additionalProperties": false, "description": "Arguments for the \"geolocation.accuracy-changed\" event.", "properties": { "accuracy": { "description": "The current geolocation accuracy, in meters.", "type": "number" } }, "required": [ "accuracy" ], "type": "object" }, "GeolocationEvent": { "additionalProperties": false, "description": "Arguments for geolocation events such as \"geolocation.position-acquired\" and \"geolocation.position-lost\".", "properties": { "gnssDeviceConnectionInfo": { "$ref": "#/definitions/GnssDeviceConnectionInfo", "description": "The GNSS source associated with the raised geolocation event. Mobile only." } }, "type": "object" }, "GeolocationStatusChangedEventArgs": { "additionalProperties": false, "description": "Arguments for the \"geolocation.status-changed\" event.", "properties": { "isEnabled": { "description": "Indicates whether the geolocation is now enabled.", "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object" }, "GeometryLike": { "anyOf": [ { "$ref": "#/definitions/CreateGraphicsResult" }, { "$ref": "#/definitions/esri.Graphic" }, { "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature" }, { "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet" }, { "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList" }, { "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream" }, { "items": { "anyOf": [ { "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties" }, { "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature" } ] }, "type": "array" }, { "$ref": "#/definitions/esri.Geometry" }, { "$ref": "#/definitions/esri.rest-api.FeatureJson.FeatureJson" }, { "$ref": "#/definitions/esri.FeatureSet" }, { "items": { "anyOf": [ { "$ref": "#/definitions/esri.Graphic" }, { "$ref": "#/definitions/esri.rest-api.FeatureJson.FeatureJson" } ] }, "type": "array" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.MultipointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolylineJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolygonJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson" }, { "items": { "anyOf": [ { "$ref": "#/definitions/esri.Geometry" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.MultipointJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolylineJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.PolygonJson" }, { "$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson" } ] }, "type": "array" } ], "description": "An object that is convertible to one or more geometries." }, "GnssDeviceConnectionInfo": { "additionalProperties": false, "description": "A geolocation source.", "properties": { "deviceFullName": { "description": "Full name of the GNSS device.", "type": "string" }, "deviceName": { "description": "Name of the GNSS device.", "type": "string" }, "deviceType": { "$ref": "#/definitions/GnssDeviceType", "description": "The type of the device. Options are Integrated, Bluetooth, USB, and Emulator." }, "settings": { "$ref": "GnssDeviceSettings", "description": "The device settings, including the correction service's spatial reference, the desired datum transformation, and the device's antenna height." } }, "required": [ "deviceFullName", "deviceName", "deviceType", "settings" ], "type": "object" }, "GnssDeviceType": { "enum": [ "bluetooth", "emulator", "integrated", "usb" ], "type": "string" }, "HasMaps": { "additionalProperties": false, "description": "Defines an object that has a `maps` property.", "properties": { "maps": { "$ref": "MapsLike", "description": "Map(s) to use for the command/operation." } }, "type": "object" }, "LayerEventArgs": { "additionalProperties": false, "description": "Arguments for the \"layer.visibility-changed\" event.", "properties": { "layerContent": { "$ref": "ILayerContent", "description": "The layer whose visibility was changed. Mobile only." }, "layers": { "$ref": "#/definitions/LayersLike", "description": "The layer whose visibility was changed. Web only." } }, "required": [ "layerContent" ], "type": "object" }, "LayerLike": { "anyOf": [ { "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference" }, { "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference" }, { "$ref": "#/definitions/esri.Layer" }, { "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension" }, { "$ref": "esri.SublayerLike" }, { "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension" }, { "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension" }, { "type": "string" } ], "description": "A (sub)layer extension, or an object that is convertible to one." }, "LayersLike": { "anyOf": [ { "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference" }, { "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference" }, { "$ref": "#/definitions/esri.Layer" }, { "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension" }, { "$ref": "esri.SublayerLike" }, { "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension" }, { "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension" }, { "items": { "$ref": "#/definitions/LayerLike" }, "type": "array" }, { "type": "string" } ], "description": "One or more objects that are convertible to layer extensions." }, "LocationMarkerEvent": { "additionalProperties": false, "description": "Arguments for the various location marker events.", "properties": { "color": { "anyOf": [ { "$ref": "#/definitions/esri.Color" }, { "$ref": "#/definitions/esri.rest-api.SymbolJson.ColorJson", "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null. See {@link https://developers.arcgis.com/web-map-specification/objects/color/} {@link https://developers.arcgis.com/web-scene-specification/objects/color/}." } ], "description": "Indicates the color for the Marker. This property is only used if the symbol is a well-known ID." }, "fov": { "description": "Indicates the horizontal field of view in degrees for the marker. Ranges from 0 to 360. This property is currently only supported by the \"dot\" symbol.", "type": "number" }, "geometry": { "$ref": "#/definitions/esri.Geometry", "description": "The location of the Marker." }, "heading": { "description": "The clockwise rotation of the symbol in the horizontal plane in degrees.", "type": "number" }, "id": { "description": "The ID of the Marker.", "type": "string" }, "maps": { "$ref": "MapsLike", "description": "The map for the Marker." }, "scale": { "description": "The scale of the Marker, defaults to 1.", "type": "number" }, "symbol": { "anyOf": [ { "items": { "$ref": "#/definitions/MarkerSymbolConfig" }, "type": "array" }, { "type": "string" } ], "description": "The symbol used to display the marker. The symbol can be an array of Symbols or one of the following well-known IDs: \"dot\", \"callout\", or \"exclamation\". Defaults to \"dot\"." }, "tilt": { "description": "In 3D, the tilt angle of the location marker symbol. Ranges from 0 (straight down) to 180 (straight up) degrees. Defaults to 90 (straight ahead).", "type": "number" }, "userDraggable": { "description": "Sets whether the Marker should be user draggable.", "type": "boolean" } }, "required": [ "color", "fov", "geometry", "heading", "id", "maps", "scale", "symbol", "userDraggable" ], "type": "object" }, "MapEvent": { "additionalProperties": false, "description": "Arguments for the various map events.", "properties": { "mapExtension": { "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension", "description": "The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only." }, "maps": { "$ref": "MapsLike", "description": "The map from which the event was generated. Web only." } }, "type": "object" }, "MapInitializedEvent": { "additionalProperties": false, "description": "Event args for the map.initialized event.", "properties": { "loadTime": { "$ref": "#/definitions/TimeSpan", "description": "The amount of time that the map took to load. Mobile only." }, "mapExtension": { "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension", "description": "The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only." }, "maps": { "$ref": "MapsLike", "description": "The map from which the event was generated. Web only." } }, "required": [ "loadTime" ], "type": "object" }, "MapsLike": { "anyOf": [ { "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension" }, { "items": { "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension" }, "type": "array" } ], "description": "One or map extensions." }, "MarkerSymbolConfig": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson" }, { "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson" }, { "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson" }, { "$ref": "#/definitions/esri.SimpleMarkerSymbol" }, { "$ref": "#/definitions/esri.PictureMarkerSymbol" }, { "$ref": "#/definitions/esri.TextSymbol" } ], "description": "Symbols that can be used for location markers." }, "MeasurementSystem": { "description": "A system used to determine what units should be used for measurement values.", "enum": [ "imperial", "metric" ], "type": "string" }, "OperationalLayerJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.AnnotationLayerJson.AnnotationLayerJson" }, { "$ref": "#/definitions/esri.rest-api.BuildingSceneLayerJson.BuildingSceneLayerJson" }, { "$ref": "#/definitions/esri.rest-api.CSVLayerJson.CSVLayerJson" }, { "$ref": "#/definitions/esri.rest-api.FeatureLayerJson.FeatureLayerJson" }, { "$ref": "#/definitions/esri.rest-api.GeoJSONLayerJson.GeoJSONLayerJson" }, { "$ref": "#/definitions/esri.rest-api.GeoRSSLayerJson.GeoRSSLayerJson" }, { "$ref": "#/definitions/esri.rest-api.GroupLayerJson.GroupLayerJson" }, { "$ref": "#/definitions/esri.rest-api.ImageServiceLayerJson.ImageServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.ImageServiceVectorLayerJson.ImageServiceVectorLayerJson" }, { "$ref": "#/definitions/esri.rest-api.IntegratedMeshLayerJson.IntegratedMeshLayerJson" }, { "$ref": "#/definitions/esri.rest-api.KMLLayerJson.KMLLayerJson" }, { "$ref": "#/definitions/esri.rest-api.MapServiceLayerJson.MapServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.PointCloudLayerJson.PointCloudLayerJson" }, { "$ref": "#/definitions/esri.rest-api.SceneLayerJson.SceneLayerJson" }, { "$ref": "#/definitions/esri.rest-api.StreamLayerJson.StreamLayerJson" }, { "$ref": "#/definitions/esri.rest-api.SubtypeGroupLayerJson.SubtypeGroupLayerJson" }, { "$ref": "#/definitions/esri.rest-api.TiledImageServiceLayerJson.TiledImageSe