@vertigis/viewer-spec

{ "$ref": "#/definitions/viewer-spec.Event", "definitions": { "@arcgis.core.unionTypes.GeometryUnion": { "anyOf": [ { "$ref": "#/definitions/esri.Extent" }, { "$ref": "#/definitions/esri.Multipoint" }, { "$ref": "#/definitions/esri.Point" }, { "$ref": "#/definitions/esri.Polygon" }, { "$ref": "#/definitions/esri.Polyline" }, { "$ref": "#/definitions/esri.Mesh" } ], "description": "Union of all geometries.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-unionTypes.html#GeometryUnion Read more...}" }, "@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.Extent" }, { "$ref": "#/definitions/esri.Multipoint" }, { "$ref": "#/definitions/esri.Point" }, { "$ref": "#/definitions/esri.Polygon" }, { "$ref": "#/definitions/esri.Polyline" }, { "$ref": "#/definitions/esri.Mesh" }, { "$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/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": "FieldJsonType", "description": "Type of the Field. See {@link FieldJsonType}." }, "visible": { "description": "<not in spec>.", "type": "boolean" } }, "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": "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" }, "AdditionalExportWebMap": { "additionalProperties": false, "description": "Represents an additional export web map.", "properties": { "Map_As_JSON": { "$ref": "#/definitions/ExportWebMap", "description": "The export web map properties." }, "name": { "description": "Name of the additional map frame in the layout. Well-known additional map frame names are 'OVERVIEW' for the overview map and 'WEBMAP_MAP_FRAME_PAGE_OVERVIEW' for the overview page map. For a custom additional web frame name use the map frame name as defined in the layout. For fetching the available map frames for layouts or layout packages use the 'Get Layout Template Info Task'.", "type": "string" } }, "required": [ "Map_As_JSON", "name" ], "type": "object" }, "AdditionalSettings": { "additionalProperties": false, "description": "Represents the additional settings.", "properties": { "attributeTables": { "description": "Attribute tables settings.", "items": { "$ref": "#/definitions/AttributeTable" }, "type": "array" }, "authentication": { "$ref": "#/definitions/PortalAuthentication", "description": "Authentication for layout or layout package portal item access." }, "dynamicElements": { "description": "Dynamic elements additionally to the dynamic text elements in the ExportWebMap:LayoutOptions:customTextElement. These elements take precedence over the elements in ExportWebMap:LayoutOptions:customTextElement, if they have the same type and name.", "items": { "$ref": "#/definitions/DynamicElement" }, "type": "array" }, "geoTransforms": { "description": "Geo transformations for prints with layout or layout packages. Geo transformations used for maps to avoid spatial displacement between operational layers and basemap layers if they have incompatible underlying geographic coordinate systems. These geo transformations are added to all maps in the request. They are ignored if no geo transformation is necessary. Also see: https://developers.arcgis.com/rest/services-reference/enterprise/pdf/gtf_pdf_11.1.pdf.", "items": { "$ref": "#/definitions/GeoTransformation" }, "type": "array" }, "pageCover": { "$ref": "PageCover", "description": "Cover page settings for prints with layout packages." }, "pageLegend": { "$ref": "PageLegend", "description": "Legend page settings for prints with layout packages." }, "pageOverview": { "$ref": "PageOverview", "description": "Overview page settings for prints with layout packages." }, "pages": { "description": "Default series pages settings for prints with layout or layout packages. Mandatory for unprojected or projected spatial series pages prints.", "items": { "$ref": "Page" }, "type": "array" }, "rangeSeries": { "$ref": "#/definitions/RangeSeries", "description": "Series range settings for range/z-aware layers." }, "seamless": { "$ref": "PageSeamless", "description": "Default seamless page settings for prints with layout or layout packages. Mandatory for a seamless page print." }, "security": { "$ref": "__type", "description": "Security settings." }, "selection": { "$ref": "#/definitions/Selection", "description": "Layer objects selections." }, "timeSeries": { "$ref": "#/definitions/TimeSeries", "description": "Series time settings for time-aware layers." } }, "type": "object" }, "ArcGISPortalIdentity": { "additionalProperties": false, "type": "object" }, "AttributeTable": { "additionalProperties": false, "description": "Represents the attribute table settings.", "properties": { "fields": { "description": "List of table fields to show in the table.", "items": { "type": "string" }, "type": "array" }, "layerId": { "description": "ID of the map layer used as data source.", "type": "string" }, "mode": { "$ref": "#/definitions/DataSelectionMode", "description": "Data selection mode." }, "name": { "description": "Name of attribute table.", "type": "string" } }, "required": [ "fields", "layerId", "mode", "name" ], "type": "object" }, "AuthenticationType": { "description": "A type of authentication.", "enum": [ "Network", "OAuth2", "Token", "Unknown" ], "type": "string" }, "BasemapLayerJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.ImageServiceLayerJson.ImageServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.ImageServiceVectorLayerJson.ImageServiceVectorLayerJson" }, { "$ref": "#/definitions/esri.rest-api.MapServiceLayerJson.MapServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.TiledImageServiceLayerJson.TiledImageServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.TiledMapServiceLayerJson.TiledMapServiceLayerJson" }, { "$ref": "#/definitions/esri.rest-api.VectorTileLayerJson.VectorTileLayerJson" }, { "$ref": "#/definitions/esri.rest-api.WebTileLayerJson.WebTileLayerJson" }, { "$ref": "#/definitions/esri.rest-api.WMSLayerJson.WMSLayerJson" }, { "$ref": "#/definitions/esri.rest-api.BingLayerJson.BingLayerJson" }, { "$ref": "#/definitions/esri.rest-api.OpenStreetMapLayerJson.OpenStreetMapLayerJson" } ], "description": "A base map layer in a web map/scene." }, "BulkAttributeCompleteEventArgs": { "additionalProperties": false, "description": "Arguments for bulk attribute completion event. Web only.", "properties": { "error": { "description": "Optional error message if the update failed.", "type": "string" }, "features": { "$ref": "#/definitions/FeaturesLike", "description": "Features to use for the command/operation." }, "success": { "description": "Whether the bulk attribute update was successful.", "type": "boolean" } }, "required": [ "success" ], "type": "object" }, "BulkAttributePreValidationEventArgs": { "additionalProperties": false, "description": "Arguments for bulk attribute pre-validation event. Web only.", "properties": { "attributes": { "description": "The attributes that will be applied to the features." }, "features": { "$ref": "#/definitions/FeaturesLike", "description": "Features to use for the command/operation." } }, "required": [ "attributes" ], "type": "object" }, "BulkAttributeValidationEventArgs": { "additionalProperties": false, "description": "Arguments for bulk attribute validation events. Web only.", "properties": { "features": { "$ref": "#/definitions/FeaturesLike", "description": "Features to use for the command/operation." }, "validationResults": { "description": "Array of validation results from different validators. The bulk edit operation is considered valid only if all results are valid.", "items": { "$ref": "#/definitions/ValidationResult" }, "type": "array" } }, "required": [ "validationResults" ], "type": "object" }, "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" }, "DataSelectionMode": { "description": "Represents the table data selection mode.", "enum": [ "All", "InExtent", "SelectedAll", "SelectedInExtent" ], "type": "string" }, "DataSourceJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.JoinTableDataSourceJson" }, { "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.QueryTableDataSourceJson" }, { "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.RasterDataSourceJson" }, { "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.TableDataSourceJson" } ], "description": "This object applies if the layerDefinition source is set to DynamicDataLayer. See {@link https://developers.arcgis.com/web-map-specification/objects/dataSource/} {@link https://developers.arcgis.com/web-scene-specification/objects/dataSource/}." }, "DomainJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.DomainJson.CodedValueDomainJson" }, { "$ref": "#/definitions/esri.rest-api.DomainJson.InheritedDomainJson" }, { "$ref": "#/definitions/esri.rest-api.DomainJson.RangeDomainJson" } ], "description": "A domain specifies the set of valid values for a field.\n\nSee {@link https://developers.arcgis.com/web-map-specification/objects/domain/} {@link https://developers.arcgis.com/web-scene-specification/objects/domain/}." }, "DynamicElement": { "additionalProperties": false, "description": "Represents a dynamic element. A dynamic element can be a custom text element (type: string) or a custom image element (type: image).", "properties": { "name": { "description": "Name.", "type": "string" }, "type": { "$ref": "#/definitions/DynamicElementType", "description": "Type." }, "value": { "description": "Value.", "type": "string" } }, "required": [ "name", "type", "value" ], "type": "object" }, "DynamicElementType": { "description": "Represents the dynamic element type.", "enum": [ "image", "string" ], "type": "string" }, "EdgesJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.SymbolJson.SketchEdgesJson" }, { "$ref": "#/definitions/esri.rest-api.SymbolJson.SolidEdgesJson" } ], "description": "Edges describe additional styles applied to visually important edges of 3D objects." }, "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." }, "EffectJson": { "anyOf": [ { "items": { "$ref": "#/definitions/esri.rest-api.LayerJson.ScaleDependentEffectJson" }, "type": "array" }, { "items": { "$ref": "#/definitions/EffectFunctionJson" }, "type": "array" } ], "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work." }, "ElevationLayerJson": { "anyOf": [ { "$ref": "#/definitions/esri.rest-api.RasterDataElevationLayerJson.RasterDataElevationLayerJson" }, { "$ref": "#/definitions/esri.rest-api.TiledElevationServiceLayerJson.TiledElevationServiceLayerJson" } ], "description": "Elevation layers that can be used in a web scene's ground." }, "Error": { "additionalProperties": false, "properties": { "cause": {}, "message": { "type": "string" }, "name": { "type": "string" }, "stack": { "type": "string" } }, "required": [ "message", "name" ], "type": "object" }, "ExportOptions": { "additionalProperties": false, "description": "Represents the export options.", "properties": { "dpi": { "description": "The resolution in dots per inch. The default is 96 dpi.", "type": "number" }, "outputSize": { "description": "Size of the map in pixels. The size must be defined when an empty string or MAP_ONLY (without quotation marks) is passed in as a value to the layout_template parameter. If layout_template is not specified as MAP_ONLY or an empty string, the map frame with the name WEBMAP_MAP_FRAME of the referenced DEFAULT layout portal item in layout_template print parameter takes precedence over outputSize.", "items": { "type": "number" }, "type": "array" } }, "type": "object" }, "ExportWebMap": { "additionalProperties": false, "description": "Represents the export web map as defined by ESRI in https://enterprise.arcgis.com/en/server/latest/publish-services/windows/exportwebmap-specification.htm.", "properties": { "baseMap": { "$ref": "#/definitions/esri.rest-api.BasemapJson.BasemapJson", "description": "The map contains one baseMap, which has a title, and a baseMapLayers property that contains an ordered list of baseMapLayers. Each baseMapLayer must be in the same spatial reference and tiling scheme. When there is a baseMap, it defines the map's spatial reference." }, "exportOptions": { "$ref": "#/definitions/ExportOptions", "description": "This object specifies settings for the output map." }, "layoutOptions": { "$ref": "#/definitions/LayoutOptions", "description": "This defines settings for different available page layout elements and is only needed when an available layout template is chosen. Page layout elements include well-known VertiGIS Studios function fields and custom text elements." }, "mapOptions": { "$ref": "MapOptions", "description": "The object mapOptions is required and defines map display properties." }, "operationalLayers": { "description": "The operationalLayers list contains all the operational layers to be displayed in the map. The order of the array defines the order of the layers in the map. The type of each layer is defined by the URL resource response. If the resource cannot be determined from the URL, the type property defines the type. For example, a WMS layer requires that you specify \"type\": \"wms\". There are some properties common to all types of operational layers, while others are specific to each type of operational layer.\n\nIn case of secured layers, specify the token in a layer definition. A user name and password are not supported as part of the URL.", "items": { "$ref": "#/definitions/OperationalLayerJson" }, "type": "array" } }, "required": [ "mapOptions" ], "type": "object" }, "FeatureReductionJson": { "anyOf": [ { "$ref": "#/definitio