@vertigis/viewer-spec

{ "$ref": "#/definitions/viewer-spec.Action", "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...}" }, "@arcgis.core.unionTypes.SymbolUnion": { "anyOf": [ { "$ref": "#/definitions/esri.PictureFillSymbol" }, { "$ref": "#/definitions/esri.PictureMarkerSymbol" }, { "$ref": "#/definitions/esri.SimpleFillSymbol" }, { "$ref": "#/definitions/esri.SimpleLineSymbol" }, { "$ref": "#/definitions/esri.SimpleMarkerSymbol" }, { "$ref": "#/definitions/esri.TextSymbol" }, { "$ref": "#/definitions/esri.CIMSymbol" }, { "$ref": "esri.LabelSymbol3D" }, { "$ref": "#/definitions/esri.LineSymbol3D" }, { "$ref": "#/definitions/esri.MeshSymbol3D" }, { "$ref": "#/definitions/esri.PointSymbol3D" }, { "$ref": "#/definitions/esri.PolygonSymbol3D" }, { "$ref": "esri.WebStyleSymbol" } ], "description": "Union of symbols.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-unionTypes.html#SymbolUnion 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.TaskSettings.TaskSettingsProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link data /TaskSettings!TaskSettings}.", "properties": { "enableAdd": { "description": "See {@link data /TaskSettings!TaskSettings.enableAdd}.", "type": "boolean" }, "enableDelete": { "description": "See {@link data /TaskSettings!TaskSettings.enableDelete}.", "type": "boolean" }, "enableEditing": { "description": "See {@link data /TaskSettings!TaskSettings.enableEditing}.", "type": "boolean" }, "enableExport": { "description": "See {@link data /TaskSettings!TaskSettings.enableExport}.", "type": "boolean" }, "enableIdentify": { "description": "See {@link data /TaskSettings!TaskSettings.enableIdentify}.", "type": "boolean" }, "enableQuery": { "description": "See {@link data /TaskSettings!TaskSettings.enableQuery}.", "type": "boolean" }, "enableSearch": { "description": "See {@link data /TaskSettings!TaskSettings.enableSearch}.", "type": "boolean" }, "enableUpdate": { "description": "See {@link data /TaskSettings!TaskSettings.enableUpdate}.", "type": "boolean" }, "studioSearchSubindexId": { "description": "See {@link data /TaskSettings!TaskSettings.studioSearchSubindexId}.", "type": "string" } }, "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.data.convert.CellData": { "additionalProperties": false, "description": "Data for a cell in a table.", "properties": { "formatted": { "description": "The formatted value of the cell.", "type": "string" }, "raw": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": [ "string", "number", "boolean" ] } ], "description": "The raw value of the cell." } }, "required": [ "raw" ], "type": "object" }, "@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties": { "additionalProperties": false, "description": "Properties that can be passed into the constructor for {@link mapping /Bookmark!Bookmark}.", "properties": { "id": { "description": "The unique ID to assign to the entity. If not specified, one will be generated.", "type": "string" }, "source": { "$ref": "@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkSource", "description": "See {@link mapping /Bookmark!Bookmark.source}." }, "title": { "description": "See {@link mapping /Bookmark!Bookmark.title}.", "type": "string" }, "viewpoint": { "anyOf": [ { "$ref": "#/definitions/esri.Viewpoint" }, { "$ref": "#/definitions/esri.rest-api.ViewpointJson.ViewpointJson" } ], "description": "See {@link mapping /Bookmark!Bookmark.viewpoint}." } }, "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.Action.Action": { "$ref": "#/definitions/viewer-spec.Action" }, "@vertigis.arcgis-extensions.support.Action.BoundAction": { "additionalProperties": false, "description": "An action that is bound to arguments.", "properties": { "arguments": { "description": "Arguments for the action. Can either be a primitive value (string, number, boolean), or a plain JSON object containing named arguments." }, "name": { "description": "Determines which action to perform. It is up to the calling application how it transforms an action name into actual executable code.", "type": "string" } }, "required": [ "arguments", "name" ], "type": "object" }, "@vertigis.arcgis-extensions.support.Action.CompositeAction": { "description": "A composite action that is made up of a sequence of one or more actions. The intent is that the application should execute these in the given order. If any of the actions produces an output, that should be used as the input arguments for all subsequent actions.", "items": { "$ref": "#/definitions/SimpleAction" }, "type": "array" }, "@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" }, "@vertigis.arcgis-extensions.tasks.CountResult.CountResult": { "additionalProperties": false, "description": "A count result for services.", "properties": { "count": { "description": "The number of features that match the search criteria.", "type": "number" }, "source": { "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource", "description": "The input feature source." } }, "required": [ "count", "source" ], "type": "object" }, "@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.AddressLike": { "anyOf": [ {}, { "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature" }, { "type": "string" } ], "description": "A type that can be a string, feature or JSON object representing an address." }, "@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.GeocodeOptions": { "additionalProperties": false, "description": "Options that can be passed into geocode operations.", "properties": { "cancelToken": { "$ref": "@vertigis.arcgis-extensions.support.Cancellable.CancelToken", "description": "An optional cancel token from a {@link support /Cancellable!Cancellable} that can be used to cancel the geocode operation." }, "maxResults": { "description": "The maximum number of results to return. This cannot exceed the maximum supported by the geocoder (see {@link tasks /geocoding/Geocoder!Geocoder.capabilities}).", "type": "number" }, "outFields": { "description": "Fields that should be returned for each feature.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "$ref": "#/definitions/esri.SpatialReference", "description": "The spatial reference of the results." }, "searchArea": { "$ref": "#/definitions/esri.Geometry", "description": "If specified, results will be limited to those that intersect the given geometry. No effect for reverse geocoding." }, "searchPoint": { "$ref": "#/definitions/esri.Point", "description": "If specified, results will be weighted for the specified point. No effect for reverse geocoding." } }, "type": "object" }, "@vertigis.arcgis-extensions.tasks.identify.IdentifyOptions.IdentifyOptions": { "additionalProperties": false, "description": "Options that can be passed into {@link tasks /identify/IdentifyService!IdentifyService.identify}.", "properties": { "cancelToken": { "$ref": "@vertigis.arcgis-extensions.support.Cancellable.CancelToken", "description": "An optional cancel token from a {@link support /Cancellable!Cancellable} that can be used to cancel the search." }, "maxAllowableOffset": { "description": "The maximum allowable offset used for generalizing geometries returned by the query operation.", "type": "number" }, "maxResults": { "description": "The maximum number of results to return.", "type": "number" }, "onSourceComplete": { "$ref": "__type", "description": "An optional callback that will be invoked with additional information about the tasks's result for each source." }, "outFields": { "description": "List of fields that should be returned that overrides the default out fields.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "$ref": "#/definitions/esri.SpatialReference", "description": "The spatial reference for the returned geometry." }, "returnGeometry": { "description": "Whether geometry for features should be returned.", "type": "boolean" }, "tolerance": { "description": "The distance in meters to buffer any geometries used in 2D identify operations.", "type": "number" } }, "type": "object" }, "@vertigis.arcgis-extensions.tasks.query.QueryOptions.QueryOptions": { "additionalProperties": false, "description": "Options that can be passed into {@link tasks /query/QueryService!QueryService.query}.", "properties": { "cancelToken": { "$ref": "@vertigis.arcgis-extensions.support.Cancellable.CancelToken", "description": "An optional cancel token from a {@link support /Cancellable!Cancellable} that can be used to cancel the query." }, "maxAllowableOffset": { "description": "The maximum allowable offset used for generalizing geometries returned by the query operation.", "type": "number" }, "maxResults": { "description": "The maximum number of results to return.", "type": "number" }, "outFields": { "description": "Fields that should be returned for each feature.", "items": { "type": "string" }, "type": "array" }, "outSpatialReference": { "$ref": "#/definitions/esri.SpatialReference", "description": "The spatial reference for the returned geometry." }, "returnGeometry": { "description": "Whether geometry for features should be returned.", "type": "boolean" }, "spatialFilter": { "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion", "description": "Spatial filter used to filter search results. If specified, results are limited to features that intersect the geometry." } }, "type": "object" }, "@vertigis.arcgis-extensions.utilities.portal.PortalItemLike": { "anyOf": [ { "$ref": "#/definitions/esri.PortalItem" }, { "$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson" }, { "$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri" }, { "$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri" }, { "type": "string" } ], "description": "A reference to a portal item." }, "ActivateArgs": { "anyOf": [ { "$ref": "#/definitions/Model" }, { "$ref": "#/definitions/ActivationArgs" }, { "type": "string" } ], "description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments." }, "ActivateResultGroupArgs": { "additionalProperties": false, "description": "Arguments for the \"results.activate-group\" command.", "properties": { "layers": { "$ref": "#/definitions/Layers", "description": "The layer to activate the corresponding group for in the results component. If more than one layer is included, only the first item in the array will be used. One of `sources` or `layers` is required. If both are specified, `sources` will take precedence. Web only." }, "results": { "$ref": "#/definitions/ModelRef", "description": "The result component to update, referenced by results model or its ID. Web only." }, "sources": { "description": "An array of sources to activate the corresponding group for in the results component. Only the first item in the array will be used. One of `sources` or `layers` is required. If both are specified, `sources` will take precedence. Web only.", "items": { "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource" }, "type": "array" } }, "type": "object" }, "ActivationArgs": { "additionalProperties": false, "description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.", "properties": { "component": { "anyOf": [ { "$ref": "#/definitions/Model" }, { "type": "string" } ], "description": "The component to activate or deactivate. Can be identified by its ID or model." }, "validateState": { "description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.", "type": "boolean" } }, "required": [ "component" ], "type": "object" }, "AddAttachmentArgs": { "additionalProperties": false, "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.", "properties": { "contentType": { "description": "The MIME content type of the attachment.", "type": "string" }, "data": { "description": "The binary data for the attachment.", "items": { "type": "number" }, "type": "array" }, "features": { "description": "The feature(s) to add the attachment to.", "items": { "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature" }, "type": "array" }, "maps": { "$ref": "MapsLike", "description": "The map." }, "name": { "description": "The name of the attachment.", "type": "string" } }, "required": [ "contentType", "data", "features", "maps", "name" ], "type": "object" }, "AddLayersArgs": { "additionalProperties": false, "description": "Arguments for the map.add-layers command.", "properties": { "layers": { "anyOf": [ { "$ref": "#/definitions/esri.PortalItem" }, { "$ref": "#/definitions/esri.rest-api.ItemJson.ItemJson" }, { "$ref": "@vertigis.arcgis-extensions.PortalUri.PortalUri" }, { "$ref": "@vertigis.arcgis-extensions.utilities.uri.Uri" }, { "$ref": "#/definitions/esri.Layer" }, { "$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" }, {