From b0f1c3ad71ca02192e8ddf3a6f0ef650cea520c5 Mon Sep 17 00:00:00 2001 From: Anton Halim Date: Sun, 14 Oct 2018 21:55:18 -0700 Subject: [PATCH] Fix typo of paramter --- types/animejs/index.d.ts | 12 +- types/arcgis-js-api/index.d.ts | 20930 +++---- types/chrome-apps/index.d.ts | 2 +- types/commangular/commangular-mock.d.ts | 25 +- types/dojo/dijit.d.ts | 51998 ++++++++-------- types/dojo/dojox.widget.d.ts | 10 +- types/durandal/index.d.ts | 2 +- types/dwt/index.d.ts | 14 +- types/dwt/v12/index.d.ts | 2 +- types/fabric/fabric-impl.d.ts | 3 +- types/gapi.client.dfareporting/index.d.ts | 2 +- .../v0/index.d.ts | 2 +- types/node/index.d.ts | 2 +- types/node/v0/index.d.ts | 2 +- types/node/v4/index.d.ts | 2 +- types/node/v6/index.d.ts | 2 +- types/node/v7/index.d.ts | 2 +- types/node/v8/index.d.ts | 2 +- types/node/v9/index.d.ts | 2 +- types/p5/lib/addons/p5.sound.d.ts | 6 +- types/restify-plugins/index.d.ts | 2 +- types/restify/index.d.ts | 2 +- types/restify/v5/index.d.ts | 2 +- types/scroll-into-view/index.d.ts | 4 +- types/tough-cookie/index.d.ts | 2 +- types/universal-router/index.d.ts | 2 +- types/webidl2/index.d.ts | 2 +- 27 files changed, 36518 insertions(+), 36520 deletions(-) diff --git a/types/animejs/index.d.ts b/types/animejs/index.d.ts index a975f59513..069187b15e 100644 --- a/types/animejs/index.d.ts +++ b/types/animejs/index.d.ts @@ -4,7 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.4 -type FunctionBasedParamter = (element: HTMLElement, index: number, length: number) => number; +type FunctionBasedParameter = (element: HTMLElement, index: number, length: number) => number; type AnimeCallbackFunction = (anim: anime.AnimeInstance) => void; // Allowing null is necessary because DOM queries may not return anything. type AnimeTarget = string | object | HTMLElement | SVGElement | NodeList | null; @@ -55,10 +55,10 @@ declare namespace anime { interface AnimeAnimParams { targets: AnimeTarget | ReadonlyArray; - duration?: number | FunctionBasedParamter; - delay?: number | FunctionBasedParamter; - elasticity?: number | FunctionBasedParamter; - round?: number | boolean | FunctionBasedParamter; + duration?: number | FunctionBasedParameter; + delay?: number | FunctionBasedParameter; + elasticity?: number | FunctionBasedParameter; + round?: number | boolean | FunctionBasedParameter; easing?: EasingOptions | string | ReadonlyArray; @@ -106,7 +106,7 @@ declare namespace anime { } interface AnimeTimelineAnimParams extends AnimeAnimParams { - offset: number | string | FunctionBasedParamter; + offset: number | string | FunctionBasedParameter; } interface AnimeTimelineInstance extends AnimeInstance { diff --git a/types/arcgis-js-api/index.d.ts b/types/arcgis-js-api/index.d.ts index 28e51384c9..76472bb4e7 100644 --- a/types/arcgis-js-api/index.d.ts +++ b/types/arcgis-js-api/index.d.ts @@ -70,7 +70,7 @@ declare namespace __esri { set?(props: HashMap): this; watch?(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle; } - + export type ItemCallback = (item: T, index: number) => void; @@ -249,63 +249,63 @@ declare namespace __esri { interface Basemap extends Accessor, Loadable, JSONSupport { /** * A collection of tile layers that make up the basemap's features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) */ baseLayers: Collection; /** * An identifier used to refer to the basemap when referencing it elsewhere. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#id) */ id: string; /** * Indicates whether the basemap instance has loaded. When `true`, all the properties of the object can be accessed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#portalItem) */ portalItem: PortalItem; /** * A collection of tiled reference layers for displaying labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) */ referenceLayers: Collection; /** * The URL pointing to an image that represents the basemap. When using a custom basemap in the [BasemapToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html) widget, the image specified here will display in the widget. When the user clicks the image, the map's basemap will update to the basemap associated with the image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#thumbnailUrl) */ thumbnailUrl: string; /** * The title of the basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#title) */ title: string; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#clone) - * - * + * + * */ clone(): Basemap; /** * Loads all the externally loadable resources associated with the basemap. For the basemap this will load all the base layers and reference layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#loadAll) - * - * + * + * */ loadAll(): IPromise; } @@ -313,7 +313,7 @@ declare namespace __esri { interface BasemapConstructor { /** * Creates a new basemap object. Basemaps can be created from a [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html), from a well known [basemap ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#fromId), or can be used for creating custom basemaps. These basemaps may be created from tiled services you publish to your own server, or from tiled services published by third parties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) */ @@ -322,11 +322,11 @@ declare namespace __esri { /** * Creates a new basemap instance from a [well known basemap ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). See [Map.basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) for a list of possible values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#fromId) - * + * * @param id The basemap ID. - * + * */ fromId(id: string): Basemap; @@ -338,37 +338,37 @@ declare namespace __esri { interface BasemapProperties extends LoadableProperties { /** * A collection of tile layers that make up the basemap's features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) */ baseLayers?: CollectionProperties; /** * An identifier used to refer to the basemap when referencing it elsewhere. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#id) */ id?: string; /** * The portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#portalItem) */ portalItem?: PortalItemProperties; /** * A collection of tiled reference layers for displaying labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) */ referenceLayers?: CollectionProperties; /** * The URL pointing to an image that represents the basemap. When using a custom basemap in the [BasemapToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html) widget, the image specified here will display in the widget. When the user clicks the image, the map's basemap will update to the basemap associated with the image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#thumbnailUrl) */ thumbnailUrl?: string; /** * The title of the basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#title) */ title?: string; @@ -377,42 +377,42 @@ declare namespace __esri { interface Camera extends Accessor, JSONSupport { /** * The field of view of the camera in degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov) - * + * * @default 55 */ fov: number; /** * The compass heading of the camera in degrees. Heading is zero when north is the top of the screen. It increases as the view rotates clockwise. The angles are always normalized between 0 and 360 degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) - * + * * @default 0 */ heading: number; /** - * The position of the camera defined by a map point. + * The position of the camera defined by a map point. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) */ position: Point; /** * The tilt of the camera in degrees with respect to the surface as projected down from the camera position. Tilt is zero when looking straight down at the surface and 90 degrees when the camera is looking parallel to the surface. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt) - * + * * @default 0 */ tilt: number; /** * Creates a deep clone of the camera object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#clone) - * - * + * + * */ clone(): Camera; } @@ -420,7 +420,7 @@ declare namespace __esri { interface CameraConstructor { /** * The camera defines the [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position), [tilt](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt), and [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) of the point from which the [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) visible extent is observed. It is not associated with device hardware. This class only applies to 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) */ @@ -434,32 +434,32 @@ declare namespace __esri { interface CameraProperties { /** * The field of view of the camera in degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov) - * + * * @default 55 */ fov?: number; /** * The compass heading of the camera in degrees. Heading is zero when north is the top of the screen. It increases as the view rotates clockwise. The angles are always normalized between 0 and 360 degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) - * + * * @default 0 */ heading?: number; /** - * The position of the camera defined by a map point. + * The position of the camera defined by a map point. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) */ position?: PointProperties; /** * The tilt of the camera in degrees with respect to the surface as projected down from the camera position. Tilt is zero when looking straight down at the surface and 90 degrees when the camera is looking parallel to the surface. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt) - * + * * @default 0 */ tilt?: number; @@ -468,85 +468,85 @@ declare namespace __esri { interface Color { /** * The alpha value. This value can be any number between `0` and `1` and represents the opacity of the Color. `0` indicates the color is fully transparent and `1` indicates it is fully opaque. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#a) */ a: number; /** * The blue value. This value can range between `0` and `255`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#b) */ b: number; /** * The green value. This value can range between `0` and `255`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#g) */ g: number; /** * The red value. This value can range between `0` and `255`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#r) */ r: number; /** * Creates a deep clone of the Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#clone) - * - * + * + * */ clone(): Color; /** * Takes a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or another Color object and sets this color instance to the input value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#setColor) - * + * * @param color The new color value. This parameter can be a string representing a named color or a hex value; an array of three or four numbers representing r, g, b, a values; or an object with r, g, b, a properties. - * + * */ setColor(color: string | number[] | any): Color; /** * Returns a CSS color string in rgba form representing the Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toCss) - * + * * @param includeAlpha If `true`, the alpha value will be included in the result. - * + * */ toCss(includeAlpha?: boolean): string; /** * Returns a CSS color string in hexadecimal form that represents the Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toHex) - * - * + * + * */ toHex(): string; /** * Returns a JSON object with all the values from a Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toJSON) - * - * + * + * */ toJSON(): any; /** * Returns a 3-component array of rgb values that represent the Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toRgb) - * - * + * + * */ toRgb(): number[]; /** * Returns a 4-component array of rgba values that represent the Color instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#toRgba) - * - * + * + * */ toRgba(): number[]; } @@ -554,72 +554,72 @@ declare namespace __esri { interface ColorConstructor { /** * Creates a new color object by passing either a hex, rgba, or named color value. This class inherits all attributes from **dojo/_base/Color** to provide functions for setting colors. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) */ /** * Creates a Color instance by blending two colors using a weight factor. Optionally accepts a Color object to update and return instead of creating a new object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#blendColors) - * + * * @param start The start color. * @param end The end color. * @param weight The weight value is a number from 0 to 1, with 0.5 being a 50/50 blend. * @param obj A previously allocated Color object to reuse for the result. - * + * */ blendColors(start: Color, end: Color, weight: number, obj?: Color): Color; new(color: string | number[] | any): Color; /** * Creates a Color instance using a 3 or 4 element array, mapping each element in sequence to the rgb(a) values of the color. Optionally accepts a Color object to update with the color value and return instead of creating a new object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromArray) - * + * * @param a The input array. * @param obj A previously allocated Color object to reuse for the result. - * + * */ fromArray(a: number[], obj?: Color): Color; /** * Creates a Color instance from a hex string with a '#' prefix. Supports 12-bit #rgb shorthand. Optionally accepts a Color object to update with the parsed value and return instead of creating a new object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromHex) - * + * * @param color The input color in a hex string. * @param obj A previously allocated Color object to reuse for the result. - * + * */ fromHex(color: string, obj?: Color): Color; /** * Creates a new Color instance, and initializes it with values from a JSON object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromJSON) - * + * * @param json A JSON representation of the instance. - * + * */ fromJSON(json: any): Color; /** * Creates a Color instance from a string of the form "rgb()" or "rgba()". Optionally accepts a Color object to update with the parsed value and return instead of creating a new object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromRgb) - * + * * @param color The input color in a string of the form "rgb()" or "rgba()". * @param obj A previously allocated Color object to reuse for the result. - * + * */ fromRgb(color: string, obj?: Color): Color; /** * Creates a Color instance by parsing a generic string. Accepts hex, rgb, and rgba style color values. Optionally accepts a Color object to update with the parsed value and return instead of creating a new object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html#fromString) - * + * * @param str The input value. * @param obj A previously allocated Color object to reuse for the result. - * + * */ fromString(str: string, obj?: Color): Color; } @@ -628,59 +628,59 @@ declare namespace __esri { /** * Configure global properties of the library. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html) */ interface config { /** * The URL for font resources used by the [Font](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) class in [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) labels. To use your own hosted fonts, you must follow the kebab-case naming convention (e.g. "arial-unicode-ms-bold"). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#fontsUrl) - * + * * @default "https://static.arcgis.com/fonts" */ fontsUrl: string; /** * The default [GeometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html) used by widgets and other operations, such as on-the-fly projections. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#geometryServiceUrl) - * + * * @default "https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer" */ geometryServiceUrl: string; /** * The URL for the utility service used by [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html) to convert GeoRSS documents. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#geoRSSServiceUrl) - * + * * @default "https://utility.arcgis.com/sharing/rss" */ geoRSSServiceUrl: string; /** * The URL for the utility service used by [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to convert KML documents. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#kmlServiceUrl) - * + * * @default "https://utility.arcgis.com/sharing/kml" */ kmlServiceUrl: string; /** * The URL of the portal instance. If using an on-premise portal, this value should be set to the portal instance, for example: `https://www.example.com/arcgis` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) - * + * * @default "https://www.arcgis.com" */ portalUrl: string; /** * An object with properties that control various aspects of communication between the library and web servers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ request: configRequest; /** * The AMD loader's configuration object, which is loaded with each worker. Modify the configuration to specify locations of packages to be loaded with [the workers framework](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html) or to define a feature detection. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ workers: configWorkers; @@ -698,7 +698,7 @@ declare namespace __esri { * List of domain suffixes known to support https. This will automatically upgrade requests made to such domains to use https instead of http when the application is not running on http. Note that port numbers should not be included in the domain suffix to be matched. If no `httpsDomains` list exists , the API redirects all calls using https. If the list exists and a domain of a required http resource is not listed, the API sends the URL as it is specified within the code. Likewise, if the list exists and the domain of a required http resource is listed in it, the API sends an https request to that resource. The list includes the following domain suffixes by default: * * `arcgis.com` * * `arcgisonline.com` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ httpsDomains?: string[]; @@ -706,7 +706,7 @@ declare namespace __esri { * Allows developers to modify requests before or after they are sent. The first interceptor that matches the request URL will be used. Example: * ```js * const featureLayerUrl = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0"; - * + * * esriConfig.request.interceptors.push({ * // set the `urls` property to the URL of the FeatureLayer so that this * // interceptor only applies to requests made to the FeatureLayer URL @@ -729,59 +729,59 @@ declare namespace __esri { * } * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ interceptors?: RequestInterceptor[]; /** * Maximum number of characters allowed in the URL for HTTP GET requests made by [request](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html). If this limit is exceeded, HTTP POST method will be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) - * + * * @default 2000 */ maxUrlLength?: number; /** * A proxy rule defines a proxy for a set of resources with an identical URL prefix. When using [esriRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html), if a target URL matches a rule, then the request will be sent to the specified proxy. Rather than populating this array directly, use the urlUtils.addProxyRule() method. Rule objects have the following properties: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyRules?: configRequestProxyRules[]; /** - * Resource proxy for your application. It is used by the library when communicating with a web server hosted on a domain that is different from the domain where your application is hosted. The library may or may not use the proxy depending on the type of request made, whether the server support CORS, whether the application is being run on older versions of browsers etc. To keep it simple, it is recommended that you always configure a resource proxy for your application. You can download the resource proxy from this [GitHub repo](https://github.com/Esri/resource-proxy). + * Resource proxy for your application. It is used by the library when communicating with a web server hosted on a domain that is different from the domain where your application is hosted. The library may or may not use the proxy depending on the type of request made, whether the server support CORS, whether the application is being run on older versions of browsers etc. To keep it simple, it is recommended that you always configure a resource proxy for your application. You can download the resource proxy from this [GitHub repo](https://github.com/Esri/resource-proxy). * ```js * require(["esri/config"], function(esriConfig) { * esriConfig.request.proxyUrl = "/resource-proxy/Java/proxy.jsp"; * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyUrl?: string; /** * Number of milliseconds [request](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html) will wait for response from a server. If a server fails to respond before this time expires, then the request is considered to have encountered an error. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) - * + * * @default 60000 */ timeout?: number; /** - * **Since:** 4.9 Indicates whether cross origin requests made to the associated server should include credentials such as cookies and authorization headers. + * **Since:** 4.9 Indicates whether cross origin requests made to the associated server should include credentials such as cookies and authorization headers. * ```js * require(["esri/config"], function(esriConfig) { * esriConfig.request.trustedServers.push("[//].[:]"); * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ trustedServers?: string[]; /** * **Since:** 4.5 Indicates whether `esri/request` will request a credential from `IdentityManager`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) - * + * * @default true */ useIdentity?: boolean; @@ -791,13 +791,13 @@ declare namespace __esri { export interface configRequestProxyRules extends Object { /** * The URL of the proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ proxyUrl?: string; /** * URL prefix for resources that need to be accessed through a specific proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request) */ urlPrefix?: string; @@ -807,13 +807,13 @@ declare namespace __esri { export interface configWorkers extends Object { /** * The absolute url to the AMD loader used in the worker. The default url points to the AMD loader used by the API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ loaderUrl?: any; /** * The configuration parameters for [the workers framework](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ loaderConfig?: configWorkersLoaderConfig; @@ -823,31 +823,31 @@ declare namespace __esri { export interface configWorkersLoaderConfig extends Object { /** * The AMD loader loads all code relative to the baseUrl. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ baseUrl?: string; /** * Determines if the specified feature capabilities are supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ has?: any; /** * Map of module id fragments to file paths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ paths?: any; /** * Map paths in module identifiers to different paths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ map?: any; /** * An array of objects which provide the package name and its location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#workers) */ packages?: any[]; @@ -855,43 +855,43 @@ declare namespace __esri { /** * Specifies the object used for intercepting and modifying requests made via [esriRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ export interface RequestInterceptor extends Object { /** * Makes changes to the response after the request is sent, but before it's returned to the caller. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ after?: AfterInterceptorCallback; /** * Make changes to the request URL or options before the request is sent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ before?: BeforeInterceptorCallback; /** * Sets or adds headers into `requestOptions.headers`. See also: [requestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ headers?: any; /** * Sets or adds query parameters into `requestOptions.query`. See also: [requestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ query?: any; /** * Hardcodes the [response](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse). The request will not be sent. This is resolved as the response `data`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ responseData?: any; /** * Specifies the URL(s) to apply to the interceptors. If the value is type `String`, then it matches if the request URL starts with that string. If null or undefined, the interceptor will apply to all relevant requests. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#RequestInterceptor) */ urls?: string | RegExp | (string | RegExp)[]; @@ -903,16 +903,16 @@ declare namespace __esri { /** * Represents a watch created when an object invokes [watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#watch). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#WatchHandle) */ export interface WatchHandle extends Object { /** * Removes the watch handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#WatchHandle) - * - * + * + * */ remove(): void; } @@ -921,46 +921,46 @@ declare namespace __esri { interface decorators { /** * A property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#aliasOf) - * + * * @param propertyName The aliased property name. - * + * */ aliasOf(propertyName: string): Function; /** * This method decorator is used to define the method that will cast a property from a class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#cast) - * + * * @param propertyName The property name the function will cast. - * + * */ cast(propertyName: string): Function; /** * This parameter decorator is used to define the function or class for a parameter of a method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#cast) - * + * * @param classFunction The function or class to cast the parameter - * + * */ cast(classFunction: Function): Function; /** * A function that can be used as a class. It extends [expression](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-1-6.html#extending-expressions) and is used in conjunction with the `@subclass` decorator to create a class compatible to [dojo.declare](https://dojotoolkit.org/reference-guide/1.10/dojo/declare.html). Please refer to the `subclass` documentation for further information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#declared) - * + * * @param baseClass The class to extend. * @param mixinClasses The mixin classes used to extend the base class. - * + * */ declared(baseClass: T, ...mixinClasses: any[]): T; /** * This convenience decorator is used to define an [Accessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html) property. Any property defined with this decorator can now be `get` and `set`. In addition, you can [watch for any property changes](https://developers.arcgis.com/javascript/latest/guide/working-with-props/index.html). Many times this decorator is used in conjunction with the [@renderable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#renderable) decorator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) - * + * * @param propertyMetadata An object describing the property. * @param propertyMetadata.dependsOn Property names of dependencies. * @param propertyMetadata.type The constructor used to [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html) the property. @@ -969,16 +969,16 @@ declare namespace __esri { * @param propertyMetadata.constructOnly Indicates whether the property can be set during construction but is otherwise read-only. * @param propertyMetadata.aliasOf The property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members. * @param propertyMetadata.value The default value for the property. - * + * */ property(propertyMetadata?: decoratorsPropertyPropertyMetadata): Function; /** * A class decorator that must be used together with the `declared` function to create a class compatible to [dojo.declare](https://dojotoolkit.org/reference-guide/1.10/dojo/declare.html). It supports both single and multiple inheritance and can be considered the underlying functionality needed when creating 4.x classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#subclass) - * + * * @param declaredClass The subclass name. - * + * */ subclass(declaredClass?: string): Function; } @@ -989,47 +989,47 @@ declare namespace __esri { export interface decoratorsPropertyPropertyMetadata extends Object { /** * Property names of dependencies. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ dependsOn?: string[]; /** * The constructor used to [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html) the property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ type?: Function; /** * The function to use to [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html) the property. Alternative to define the `type`. The function is called with the value set by the user and should return the cast value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ cast?: Function; /** * Indicates whether the property is read-only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) - * + * * @default false */ readOnly?: boolean; /** * Indicates whether the property can be set during construction but is otherwise read-only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) - * + * * @default false */ constructOnly?: boolean; /** * The property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ aliasOf?: string; /** * The default value for the property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html#property) */ value?: any; @@ -1051,19 +1051,19 @@ declare namespace __esri { interface Error { /** * The details object provides additional details specific to the error, giving more information about why the error was raised. For example, the details object for esriRequest includes additional information to help the developer diagnose issues with a problematic request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#details) */ details: any; /** * A message describing the details of the error. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#message) */ message: string; /** * A unique error name. This can be used to map to a localized error message to present to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#name) */ name: string; @@ -1074,31 +1074,31 @@ declare namespace __esri { interface Evented { /** * Emits an event on the instance. This method should only be used when creating subclasses of this class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#emit) - * + * * @param type The name of the event. * @param event The event payload. - * + * */ emit(type: string, event: any): void; /** * Indicates whether there is an event listener on the instance that matches the provided event name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#hasEventListener) - * + * * @param type The name of the event. - * + * */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. Call this method to hook an event with a listener. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Evented.html#on) - * + * * @param type The name of event to listen for. * @param listener The function to call when the event is fired. - * + * */ on(type: string, listener: EventHandler): IHandle; } @@ -1116,7 +1116,7 @@ declare namespace __esri { interface HandleOwner extends Accessor { /** * Handle registry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html#handles) */ handles: void; @@ -1133,7 +1133,7 @@ declare namespace __esri { interface HandleOwnerProperties { /** * Handle registry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-HandleOwner.html#handles) */ handles?: void; @@ -1142,38 +1142,38 @@ declare namespace __esri { interface Handles extends Accessor { /** * Adds a group of handles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#add) - * + * * @param handles An array or collection handles to group. * @param key group handle key - * + * */ add(handles: WatchHandle | WatchHandle[] | Collection, key?: any): void; /** * Returns true if a group exists for the provided key, false otherwise. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#has) - * + * * @param key group handle key - * + * */ has(key: any): boolean; /** * Removes a group of handles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#remove) - * + * * @param key A group key or an array or collection of group keys to remove. - * + * */ remove(key?: any): void; /** * Removes all handles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#removeAll) - * - * + * + * */ removeAll(): void; } @@ -1193,10 +1193,10 @@ declare namespace __esri { interface JSONSupport { /** * Converts an instance of [this class]() to its [ArcGIS portal JSON](https://developers.arcgis.com/documentation/common-data-types/geometry-objects.htm) representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-JSONSupport.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -1209,11 +1209,11 @@ declare namespace __esri { /** * Creates a new instance of [this class]() and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input `json` parameter often comes from a response to a query operation in the REST API or a [toJSON()](http://pro.arcgis.com/en/pro-app/tool-reference/conversion/features-to-json.htm) method from another ArcGIS product. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for details and examples of when and how to use this function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-JSONSupport.html#fromJSON) - * + * * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. - * + * */ fromJSON(json: any): any; } @@ -1224,11 +1224,11 @@ declare namespace __esri { interface lang { /** * Use this method to deeply clone objects with properties that are computed or have their own `clone()` method. For example, if you are creating an object that stores an initial extent and a spatial reference for your application, you can use `esriLang.clone(initialProps)` to clone this object so that the `extent` and `spatialReference` are properly cloned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-lang.html#clone) - * + * * @param elem The object to be cloned. - * + * */ clone(elem: any): any; } @@ -1238,83 +1238,83 @@ declare namespace __esri { interface Loadable { /** * The Error object returned if an error occurred while loading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError) - * + * * @default null */ readonly loadError: Error; /** - * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) operation. - * + * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) operation. + * * Value | Description * ------|------------ * not-loaded | The object's resources have not loaded. * loading | The object's resources are currently loading. * loaded | The object's resources have loaded without errors. * failed | The object's resources failed to load. See [loadError](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError) for more details. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus) - * + * * @default not-loaded */ readonly loadStatus: string; /** * A list of warnings which occurred while loading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadWarnings) */ readonly loadWarnings: any[]; /** * Cancels a [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) operation if it is already in progress. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#cancelLoad) - * - * + * + * */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isFulfilled) - * - * + * + * */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. If it is rejected, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isRejected) - * - * + * + * */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. If it is resolved, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#isResolved) - * - * + * + * */ isResolved(): boolean; /** * Loads the resources referenced by this class. This method automatically executes for a [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) and all of the resources it references in [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) if the view is constructed with a map instance. This method must be called by the developer when accessing a resource that will not be loaded in a [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#load) - * - * + * + * */ load(): IPromise; /** * `when()` may be leveraged once an instance of the class is created. This method takes two input parameters: a `callback` function and an `errback` function. The `callback` executes when the instance of the class loads. The `errback` executes if the instance of the class fails to load. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#when) - * + * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. - * + * */ when(callback?: Function, errback?: Function): IPromise; } @@ -1334,36 +1334,36 @@ declare namespace __esri { interface corePromise { /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isFulfilled) - * - * + * + * */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. If it is rejected, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isRejected) - * - * + * + * */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. If it is resolved, `true` will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#isResolved) - * - * + * + * */ isResolved(): boolean; /** * `when()` may be leveraged once an instance of the class is created. This method takes two input parameters: a `callback` function and an `errback` function. The `callback` executes when the instance of the class loads. The `errback` executes if the instance of the class fails to load. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Promise.html#when) - * + * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. - * + * */ when(callback?: Function, errback?: Function): IPromise; } @@ -1380,39 +1380,39 @@ declare namespace __esri { interface promiseUtils { /** * Convenience utility method to wait for a number of promises to either resolve or reject. The resulting promise resolves to an array of result objects containing the promise and either a value if the promise resolved, or an error if the promise rejected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#eachAlways) - * + * * @param promises Array of promises, or object where each property is a promise. - * + * */ eachAlways(promises: IPromise[] | any): IPromise | any; /** * A convenience utility method for filtering an array of values using an asynchronous predicate function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#filter) - * + * * @param input The array of input values to filter. * @param predicate A predicate function returning a promise. Only array entries for which the returned promise contains `true` are kept. - * + * */ filter(input: T[], predicate: FilterPredicateCallback): IPromise; /** * Convenience utility method to create a promise that has been rejected with a provided error value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#reject) - * + * * @param error The error to reject the resulting promise with. - * + * */ reject(error?: any): IPromise; /** * Convenience utility method to create a promise that will be resolved with a provided value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#resolve) - * + * * @param value The value to resolve the resulting promise with. - * + * */ resolve(value?: T): IPromise; } @@ -1421,25 +1421,25 @@ declare namespace __esri { /** * The result object for a promise passed to [promiseUtils.eachAlways](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#eachAlways). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ export interface EachAlwaysResult extends Object { /** * The promise that has been fulfilled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ promise: IPromise; /** * The value with which the promise resolved. Defined only if the promise resolved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ value?: any; /** * The error with which the promise rejected. Defined only if the promise rejected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-promiseUtils.html#EachAlwaysResult) */ error?: any; @@ -1451,12 +1451,12 @@ declare namespace __esri { interface requireUtils { /** * Dynamically requires one or more modules and returns a promise that resolves when all the specified modules have loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-requireUtils.html#when) - * + * * @param moduleRequire The `require` function used to load the modules. This is the AMD alias (e.g. the `moduleRequire` reference in the snippets below) used to reference the `require` module. * @param moduleNames The names of the modules to load. - * + * */ when(moduleRequire: any, moduleNames: string[] | string): IPromise; } @@ -1465,26 +1465,26 @@ declare namespace __esri { /** * Various utilities and convenience functions for executing code at various phases of browser frames. The scheduling module allows you to register tasks that are executed in every animation frame. This can be used to synchronize updates with ongoing animations of the view, or to animate the view manually by adjusting the extent or camera in every frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html) */ interface scheduling { /** * Registers a frame task. An animation frame is composed of different phases to let various actors execute code before, after, or during the rendering of [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask) - * + * * @param phases The callbacks for each phase of the frame. - * + * */ addFrameTask(phases: PhaseCallbacks): FrameTaskHandle; /** * Schedules the execution of a `callback` function at the next web browser tick. Unlike [addFrameTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask), a scheduled `callback` will only run once. Scheduling a task for the next execution tick can be useful when you want to throttle/accumulate functionality over a single javascript execution context. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#schedule) - * + * * @param callback The function to call at the next tick. - * + * */ schedule(callback: Function): any; } @@ -1493,32 +1493,32 @@ declare namespace __esri { /** * An object to remove or pause a frame task registered with [addFrameTask()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) */ export interface FrameTaskHandle extends Object { /** * Pause the execution the frame task at every frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) - * - * + * + * */ pause(): void; /** * Resumes the execution the frame task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) - * - * + * + * */ resume(): void; /** * Removes the frame task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#FrameTaskHandle) - * - * + * + * */ remove(): void; } @@ -1527,25 +1527,25 @@ declare namespace __esri { /** * A set of [callbacks](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallback) that will be called at specific phases of the animation frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ export interface PhaseCallbacks extends Object { /** * A callback called before rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ prepare?: PhaseCallback; /** * A callback to execute rendering logic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ render?: PhaseCallback; /** * A callback to execute state update logic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseCallbacks) */ update?: PhaseCallback; @@ -1553,25 +1553,25 @@ declare namespace __esri { /** * An object with timing information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ export interface PhaseEvent extends Object { /** * The absolute time at the start of the current animation frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ time: number; /** * The elapsed time since the last animation frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ deltaTime: number; /** * The amount of time spent within the current animation frame. This can be used for budgeting (e.g. some tasks may already have run). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#PhaseEvent) */ elapsedFrameTime: number; @@ -1581,31 +1581,31 @@ declare namespace __esri { interface urlUtils { /** * Adds the given proxy rule to the proxy rules list: `esriConfig.request.proxyRules`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) - * + * * @param rule An object specifying a URL that should use the proxy. See the object specification table below for the required properties of this object. * @param rule.proxyUrl The URL of the proxy. * @param rule.urlPrefix The URL prefix of the resources that should be accessed through the given proxy. - * + * */ addProxyRule(rule: urlUtilsAddProxyRuleRule): number; /** * Returns the proxy rule that matches the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#getProxyRule) - * + * * @param url The URL of the resources accessed via proxy. - * + * */ getProxyRule(url: string): any; /** * Converts the URL arguments to an object representation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#urlToObject) - * + * * @param url The input URL. - * + * */ urlToObject(url: string): any; } @@ -1616,13 +1616,13 @@ declare namespace __esri { export interface urlUtilsAddProxyRuleRule extends Object { /** * The URL of the proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) */ proxyUrl: string; /** * The URL prefix of the resources that should be accessed through the given proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-urlUtils.html#addProxyRule) */ urlPrefix: string; @@ -1632,192 +1632,192 @@ declare namespace __esri { interface watchUtils { /** * Watches a property for changes and calls the callback with the initial value of the property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#init) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call with the initial value of the property when the property changes. - * + * */ init(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for changes and automatically attaches and detaches an event handler for a given event to the property value as needed. The attachedHandler and detachedHandler are optional and if provided will be called whenever the event handler is attached and detached respectively. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#on) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param eventName The name of the event to attach the event handler for. * @param eventHandler The event handler callback function. * @param attachedHandler Callback called each time the event handler is attached. * @param detachedHandler Callback called each time the event handler is detached. - * + * */ on(obj: Accessor, propertyName: string | string[], eventName: string, eventHandler: Function, attachedHandler?: EventAttachedCallback, detachedHandler?: EventAttachedCallback): WatchHandle; /** * Watches a property for changes once. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming truthy. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#once) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ once(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for changes. The returned handle can be paused (and resumed) to temporarily prevent the callback from being called on property changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#pausable) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ pausable(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PausableWatchHandle; /** * Watches a property for changes. This is an alias for [Accessor.watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#watch), provided for completeness. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#watch) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ watch(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming truthy. As with module:esri/core/watchUtils#init, the callback is called initially if the property is initially truthy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#when) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ when(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming `defined`. As with init(), the callback is called if the property is initially defined. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenDefined) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenDefined(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming `defined` once. As with init(), the callback is called if the property is initially `defined`. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming defined. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenDefinedOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenDefinedOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for becoming `false`. As with init(), the callback is called if the property is initially `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenFalse) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenFalse(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming `false` once. As with init(), the callback is called if the property is initially `false`. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming false. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenFalseOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenFalseOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for becoming falsy. As with module:esri/core/watchUtils#init, the callback is called initially if the property is initially falsy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenNot) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenNot(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming falsy once. As with init(), the callback is called if the property is initially falsy. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming falsy. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenNotOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenNotOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for becoming truthy once. As with init(), the callback is called if the property is initially truthy. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming truthy. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for becoming `true`. As with init(), the callback is called if the property is initially `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenTrue) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenTrue(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming `true` once. As with init(), the callback is called if the property is initially `true`. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming true. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenTrueOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenTrueOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; /** * Watches a property for becoming `undefined`. As with init(), the callback is called if the property is initially `undefined`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenUndefined) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenUndefined(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle; /** * Watches a property for becoming `undefined` once. As with init(), the callback is called if the property is initially `undefined`. The returned watch handle is removed after the first time the callback has been invoked. The returned handle additionally implements the Promise interface and can be used to create a promise chain to asynchronously handle a property value becoming undefined. The promise result is an object containing a `value`, `oldValue`, `propertyName` and `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenUndefinedOnce) - * + * * @param obj The object containing the property to watch. * @param propertyName The name of the property to watch. * @param callback The function to call when the property changes. - * + * */ whenUndefinedOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle; } @@ -1828,32 +1828,32 @@ declare namespace __esri { /** * Represents a watch created when an object invokes [watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#watch). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#PausableWatchHandle) */ export interface PausableWatchHandle extends Object { /** * Removes the watch handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#PausableWatchHandle) - * - * + * + * */ remove(): void; /** * Pauses the handle preventing changes to invoke the associated callback. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#PausableWatchHandle) - * - * + * + * */ pause(): void; /** * Resumes a paused the handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#PausableWatchHandle) - * - * + * + * */ resume(): void; } @@ -1865,27 +1865,27 @@ declare namespace __esri { /** * This module is a utility framework that simplifies the use of [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) in the ArcGIS API for JavaScript. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html) */ interface workers { /** * Opens a connection to workers and loads a script with the workers framework. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) - * + * * @param modulePath A fully qualified URL to a script to execute with the workers framework. * @param options Worker options. See properties below for object specifications. * @param options.client The objects defining the API accessible from the module. - * @param options.strategy - * Indicates how to load the module. See the table below for a list of possible values. - * + * @param options.strategy + * Indicates how to load the module. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * distributed | The module is loaded in each available worker. Each call to [Connection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) will be targeting an available worker. Use this strategy if the module doesn't maintain information between invocations (stateless). * dedicated | The module is loaded in one worker. Each call to [Connection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) will be targeting a same worker. Use this strategy if the module maintains information from previous invocations or communication between main and worker threads needs to be stateful. * local | The module is loaded in the main thread. Use this strategy if when using the worker framework API while disabling the use of workers. - * + * */ open(modulePath: string, options?: workersOpenOptions): IPromise; } @@ -1895,31 +1895,31 @@ declare namespace __esri { interface Connection { /** * A convenient method that invokes a method on each worker. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#broadcast) - * + * * @param methodName The name of the remote method to invoke on all workers. * @param data The unique parameter passed as argument of the remote method. - * + * */ broadcast(methodName: string, data?: any): IPromise[]; /** * Closes the existing connection instance to workers. Notifies all workers to destroy the connection instance and dispose the remote module. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#close) - * - * + * + * */ close(): void; /** * Invokes a [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#basic-invocation) on the remote module loaded with the worker. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) - * + * * @param methodName The name of the method to be invoked in the script. * @param data The unique parameter passed as argument of the remote method. See [Passing multiple parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#multiple-parameters) section to pass more than one parameter to the remote method. * @param transferList An array of [Transferable](https://developer.mozilla.org/en-US/docs/Web/API/Transferable) objects. Each transferable object in the array should have a corresponding entry in the data object. See [Using transferables](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#using-transferables) section for more information. - * + * */ invoke(methodName: string, data?: any, transferList?: any[]): IPromise; } @@ -1927,7 +1927,7 @@ declare namespace __esri { interface ConnectionConstructor { /** * This class is used to execute remote methods located on the module loaded into a separate thread via the [workers framework](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html) */ @@ -1941,22 +1941,22 @@ declare namespace __esri { export interface workersOpenOptions extends Object { /** * The objects defining the API accessible from the module. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) */ client?: any; /** - * Indicates how to load the module. See the table below for a list of possible values. - * + * Indicates how to load the module. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * distributed | The module is loaded in each available worker. Each call to [Connection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) will be targeting an available worker. Use this strategy if the module doesn't maintain information between invocations (stateless). * dedicated | The module is loaded in one worker. Each call to [Connection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html#invoke) will be targeting a same worker. Use this strategy if the module maintains information from previous invocations or communication between main and worker threads needs to be stateful. * local | The module is loaded in the main thread. Use this strategy if when using the worker framework API while disabling the use of workers. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html#open) - * + * * @default distributed */ strategy?: any; @@ -1964,7 +1964,7 @@ declare namespace __esri { /** * A convenience module for importing [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/guide/typescript-setup/index.html). For example, rather than importing geometries one at a time like this: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry.html) */ interface geometry { @@ -1975,49 +1975,49 @@ declare namespace __esri { interface Circle extends Polygon { /** * The center point of the circle. The center must be specified either as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) or an array of longitude/latitude coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#center) */ center: Point; /** * Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). When either of those spatial references is used, set geodesic to `true` to minimize distortion. Other coordinate systems will not create geodesic circles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#geodesic) - * + * * @default false */ geodesic: boolean; /** * This value defines the number of points along the curve of the circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#numberOfPoints) - * + * * @default 60 */ numberOfPoints: number; /** * The radius of the circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radius) - * + * * @default 1000 */ radius: number; /** * Unit of the radius. **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) - * + * * @default meters */ radiusUnit: string; /** * Creates a deep clone of Circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#clone) - * - * + * + * */ clone(): Circle; } @@ -2035,39 +2035,39 @@ declare namespace __esri { interface CircleProperties extends PolygonProperties { /** * The center point of the circle. The center must be specified either as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) or an array of longitude/latitude coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#center) */ center?: PointProperties; /** * Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). When either of those spatial references is used, set geodesic to `true` to minimize distortion. Other coordinate systems will not create geodesic circles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#geodesic) - * + * * @default false */ geodesic?: boolean; /** * This value defines the number of points along the curve of the circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#numberOfPoints) - * + * * @default 60 */ numberOfPoints?: number; /** * The radius of the circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radius) - * + * * @default 1000 */ radius?: number; /** * Unit of the radius. **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) - * + * * @default meters */ radiusUnit?: string; @@ -2079,13 +2079,13 @@ declare namespace __esri { * * degrees, minutes, and seconds * * U.S. National Grid (USNG) * * Military Grid Reference System (MGRS). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html) */ interface coordinateFormatter { /** * Parses coordinates in latitude/longitude notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. The coordinates may use decimal degrees, degrees and decimal minutes, or degrees, minutes, and seconds format. The spatial reference provided must have an ellipsoid and datum matching those used by the source of the latitude/longitude string. If no spatial reference is provided, it is assumed the latitude/longitude coordinates are in WGS84. **Supported characters** - * + * * | Symbol | Character | Name | Unicode number | HTML code | * | --- | --- | --- | --- | --- | * | Degree | * | Asterisk | U+002A | * | @@ -2095,43 +2095,43 @@ declare namespace __esri { * | Minute | ' | Apostrophe | U+0027 | ' | * | | ′ | Prime | U+2032 | ′ | * | Second | " | Quotation Mark | U+0022 | " | - * + * * The latitude/longitude string may contain leading and trailing whitespace, and may also contain a space, comma, or vertical bar symbol to separate the latitude from the longitude. It may also contain the characters 'N', 'S', 'E' and 'W', or use a minus (-) symbol to indicate the hemisphere of each value. Latitude/longitude notation examples: * * 55 56 39.123N 003 09 43.034W * * 55°56′39″N 3°09′43″W * * 55~56.65205', -003~09.71723' * * 55.9442008* | -3.1619539* - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromLatitudeLongitude) - * + * * @param coordinates The latitude/longitude notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm). If `null`, WGS84 will be used. - * + * */ fromLatitudeLongitude(coordinates: string, spatialReference?: SpatialReference): Point; /** * Parses coordinates in Military Grid Reference System (MGRS) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. The spatial reference provided must have an ellipsoid and datum matching those used by the source of the MGRS string. If no spatial reference is provided, it is assumed the MGRS string is referenced to WGS84. Note that the choice between zone 01 and 60 has no impact when reading from an MGRS notation string. The MGRS string can contain leading and trailing whitespace and can have whitespace between the grid zone designator, the 100km square identifier, and the numerical eastings and northings. MGRS notation examples: * * 30UVG898998 * * 30UVG 89885 99877 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromMgrs) - * + * * @param coordinates The MGRS notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) referenced by the MGRS coordinates. If `null`, WGS84 will be used. * @param conversionMode The mode used by the given MGRS coordinates. **Possible Values**: automatic | new-180-in-zone-01 | new-180-in-zone-60 | old-180-in-zone-01 | old-180-in-zone-60 - * + * */ fromMgrs(coordinates: string, spatialReference: SpatialReference, conversionMode: string): Point; /** * Parses coordinates in United States National Grid (USNG) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location. The spatial reference provided must have an ellipsoid and datum matching those used by the source of the USNG string. If no spatial reference is provided and the USNG string is suffixed with "(NAD 27)", it is assumed the USNG string is referenced to NAD 27. If no spatial reference is provided and no such suffix exists, it is assumed the USNG string is referenced to WGS84. USNG notation examples: * * 13TFJ 23 59 * * 13TFJ2374159574 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromUsng) - * + * * @param coordinates The USNG notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) that the USNG coordinates are in. If `null`, WGS84 will be used. - * + * */ fromUsng(coordinates: string, spatialReference?: SpatialReference): Point; /** @@ -2139,42 +2139,42 @@ declare namespace __esri { * * 30U 489885 6199877 * * 30U4898856199877 * * 30N 489885 6199877 (using N/S indicator) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#fromUtm) - * + * * @param coordinates The UTM notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) that the UTM coordinates are in. If `null`, WGS84 will be used. * @param conversionMode The latitude notation scheme used by the given UTM coordinates, either a latitudinal band, or a hemisphere designator. **Possible Values**: latitude-band-indicators | north-south-indicators - * + * */ fromUtm(coordinates: string, spatialReference: SpatialReference, conversionMode: string): Point; /** * Indicates if all dependencies of this module have been loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isLoaded) - * - * + * + * */ isLoaded(): boolean; /** * Indicates if this module is supported in the current browser. The browser must support [WebAssembly](https://caniuse.com/#feat=wasm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isSupported) - * - * + * + * */ isSupported(): boolean; /** * Load this module's dependencies. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#load) - * - * + * + * */ load(): IPromise; /** * Returns formatted coordinates in latitude/longitude notation representing the given point's location. The latitude/longitude string will contain a space separating the latitude from the longitude value, and the characters 'N' or 'S', and 'E' and 'W', to indicate the hemisphere of each value. The string will also contain spaces separating the components (degrees, minutes, seconds) of each value. The precision of the output is controlled by both the `format` and `decimalPlaces` parameters. For example: - * + * * | Decimal places | format | Example output | Angular precision | Approximate precision | * | --- | --- | --- | --- | --- | * | 0 | dd | 056N 0003W | 1deg | 100km | @@ -2189,19 +2189,19 @@ declare namespace __esri { * | 1 | dms | 55 56 39.1N 003 09 43.0W | 0.1sec| 3m | * | 2 | dms | 55 56 39.12N 003 09 43.03W | 0.01sec | 300mm | * | 3 | dms | 55 56 39.123N 003 09 43.034W | 0.001sec | 30mm | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toLatitudeLongitude) - * + * * @param point The location to be represented as a formatted latitude/longitude string. The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm). * @param format The mode to use when formatting the latitude/longitude string. **Possible Values**: dd | ddm | dms * @param decimalPlaces The number of decimal places to use, it should be an integer from 0 to 16. - * + * */ toLatitudeLongitude(point: Point, format: string, decimalPlaces?: number): string; /** * Returns formatted coordinates in Military Grid Reference System (MGRS) notation representing the given point's location. Note that the choice between zone 01 and 60 has an impact only when generating the MGRS notation string for a point with longitude of exactly 180deg. The precision value controls the number of digits used to represent each numerical easting and northing value within the MGRS string. For example: - * + * * | precision | add_spaces | Example output | Approximate precision | * | --- | --- | --- | --- | * | 0 | false | 30UVG | 100km | @@ -2216,20 +2216,20 @@ declare namespace __esri { * | 3 | true | 30U VG 898 998 | 100m | * | 4 | true | 30U VG 8988 9988 | 10m | * | 5 | true | 30U VG 89884 99881 | 1m | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toMgrs) - * + * * @param point The location to be represented in MGRS notation. The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) * @param conversionMode The mode to use for the returned MGRS notation string. **Possible Values**: automatic | new-180-in-zone-01 | new-180-in-zone-60 | old-180-in-zone-01 | old-180-in-zone-60 * @param precision The precision with which to represent the coordinates, it should be an integer from 0 to 8. * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the grid zone designator, the 100km square identifier, and the numerical easting and northing values. - * + * */ toMgrs(point: Point, conversionMode: string, precision?: number, addSpaces?: boolean): string; /** * Returns formatted coordinates in United States National Grid (USNG) notation representing the given point's location. The precision value controls the number of digits used to represent each numerical easting and northing value within the USNG string. For example: - * + * * | precision | add_spaces | Example output | Approximate precision | * | --- | --- | --- | --- | * | 0 | false | 13TFJ | 100km | @@ -2247,33 +2247,33 @@ declare namespace __esri { * | 4* | false | 13TFJ23795929 (NAD 27) | 10m | * | 2* | true | 13T FJ 23 59 (NAD 27) | 1km | * * *When the point's spatial reference is based on NAD 27.* - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toUsng) - * + * * @param point The location to be represented in USNG notation. The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm). * @param precision The precision with which to represent the coordinates, it should be an integer from 0 to 8. * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the grid zone designator, the 100km square identifier, and the numerical easting and northing values. - * + * */ toUsng(point: Point, precision?: number, addSpaces?: boolean): string; /** * Returns formatted coordinates in Universal Transverse Mercator (UTM) notation representing the given point's location. Example output for a point in the southern hemisphere: - * + * * | conversionMode | add_spaces | Example output | * | --- | --- | --- | * | latitude-band-indicators | false | 30U4898846199881 | * | latitude-band-indicators | true | 30U 489884 6199881 | * | north-south-indicators | false | 30N4898846199881 | * | north-south-indicators | true | 30N 489884 6199881 | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#toUtm) - * + * * @param point The location to be represented in UTM notation. The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) * @param conversionMode The latitude notation scheme to use in the returned UTM notation string, either a latitudinal band, or a hemisphere designator. **Possible Values**: latitude-band-indicators | north-south-indicators * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the UTM zone and latitude designator and each numerical easting and northing value. - * + * */ toUtm(point: Point, conversionMode: string, addSpaces?: boolean): string; } @@ -2283,183 +2283,183 @@ declare namespace __esri { interface Extent extends Geometry { /** * The center point of the extent in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#center) */ readonly center: Point; /** * The height of the extent in map units (the distance between [ymin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) and [ymax](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#height) */ readonly height: number; /** * The maximum possible `m` value in an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmax) - * + * * @default undefined */ mmax: number; /** * The minimum possible `m` value of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmin) - * + * * @default undefined */ mmin: number; /** * For Extent, the type is always `extent`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#type) */ readonly type: "extent"; /** * The width of the extent in map units (the distance between [xmin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) and [xmax](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width) */ readonly width: number; /** * The bottom-right X-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax) - * + * * @default 0 */ xmax: number; /** * The top-left X-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) - * + * * @default 0 */ xmin: number; /** * The top-right Y-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax) - * + * * @default 0 */ ymax: number; /** * The bottom-left Y-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) - * + * * @default 0 */ ymin: number; /** - * The maximum possible `z`, or elevation, value in an extent envelope. + * The maximum possible `z`, or elevation, value in an extent envelope. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmax) - * + * * @default undefined */ zmax: number; /** - * The minimum possible `z`, or elevation, value of an extent envelope. + * The minimum possible `z`, or elevation, value of an extent envelope. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmin) - * + * * @default undefined */ zmin: number; /** * Centers the extent to the specified [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). This method modifies the extent geometry in-place. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#centerAt) - * + * * @param point The point to center the extent. - * + * */ centerAt(point: Point): Extent; /** * Creates a deep clone of Extent object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) - * - * + * + * */ clone(): Extent; /** * Checks if the input geometry is contained within the extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#contains) - * + * * @param geometry Input geometry to test if it is contained within the extent. - * + * */ contains(geometry: Point | Extent): boolean; /** * Indicates if the input extent is equal to the testing extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#equals) - * + * * @param extent Input extent. - * + * */ equals(extent: Extent): boolean; /** * Expands the extent by the given factor. For example, a value of 1.5 will expand the extent to be 50 percent larger than the original extent. This method modifies the extent geometry in-place. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#expand) - * + * * @param factor The multiplier value. - * + * */ expand(factor: number): Extent; /** * Shrinks the original extent to the intersection with the input extent. This method modifies the extent geometry in-place. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. If the original extent and the input extent have no intersection, the extent is not modified and null is returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#intersection) - * + * * @param extent The input extent to intersect. - * + * */ intersection(extent: Extent): Extent; /** * Tests to validate if the input geometry intersects the extent and returns a Boolean value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#intersects) - * + * * @param geometry The geometry used to test the intersection. It can be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) or [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html). - * + * */ intersects(geometry: Geometry): boolean; /** * Returns an array with either one Extent that's been shifted to within +/- 180 or two Extents if the original extent intersects the International Dateline. This method modifies the extent geometry in-place. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#normalize) - * - * + * + * */ normalize(): Extent[]; /** * Modifies the extent geometry in-place with X and Y offsets in map units. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#offset) - * + * * @param dx The offset distance in map units for the X-coordinate. * @param dy The offset distance in map units for the Y-coordinate. * @param dz The offset distance in map units for the Z-coordinate. - * + * */ offset(dx: number, dy: number, dz: number): Extent; /** * Expands the original extent to include the extent of the input Extent. This method modifies the extent geometry in-place. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone) the extent object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#union) - * + * * @param extent The input extent to union. - * + * */ union(extent: Extent): Extent; } @@ -2477,67 +2477,67 @@ declare namespace __esri { interface ExtentProperties extends GeometryProperties { /** * The maximum possible `m` value in an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmax) - * + * * @default undefined */ mmax?: number; /** * The minimum possible `m` value of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmin) - * + * * @default undefined */ mmin?: number; /** * The bottom-right X-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax) - * + * * @default 0 */ xmax?: number; /** * The top-left X-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin) - * + * * @default 0 */ xmin?: number; /** * The top-right Y-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax) - * + * * @default 0 */ ymax?: number; /** * The bottom-left Y-coordinate of an extent envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin) - * + * * @default 0 */ ymin?: number; /** - * The maximum possible `z`, or elevation, value in an extent envelope. + * The maximum possible `z`, or elevation, value in an extent envelope. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmax) - * + * * @default undefined */ zmax?: number; /** - * The minimum possible `z`, or elevation, value of an extent envelope. + * The minimum possible `z`, or elevation, value of an extent envelope. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmin) - * + * * @default undefined */ zmin?: number; @@ -2546,50 +2546,50 @@ declare namespace __esri { interface Geometry extends Accessor, JSONSupport { /** * The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. An example is the extent of a polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#cache) */ readonly cache: any; /** * The extent of the geometry. For a point, the extent is null. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#extent) */ readonly extent: Extent; /** * Indicates if the geometry has M values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasM) */ hasM: boolean; /** - * Indicates if the geometry has Z (elevation) values. + * Indicates if the geometry has Z (elevation) values. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasZ) */ hasZ: boolean; /** * The spatial reference of the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference) - * + * * @default WGS84 (wkid: 4326) */ spatialReference: SpatialReference; /** * The geometry type. **Possible Values:** point | multipoint | polyline | polygon | extent | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type) */ readonly type: string; /** * Creates a deep clone of the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#clone) - * - * + * + * */ clone(): Geometry; } @@ -2607,22 +2607,22 @@ declare namespace __esri { interface GeometryProperties { /** * Indicates if the geometry has M values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasM) */ hasM?: boolean; /** - * Indicates if the geometry has Z (elevation) values. + * Indicates if the geometry has Z (elevation) values. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#hasZ) */ hasZ?: boolean; /** * The spatial reference of the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference) - * + * * @default WGS84 (wkid: 4326) */ spatialReference?: SpatialReferenceProperties; @@ -2632,376 +2632,376 @@ declare namespace __esri { interface geometryEngine { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. The GeometryEngine has two methods for buffering geometries client-side: buffer and [geodesicBuffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicBuffer). Use caution when deciding which method to use. As a general rule, use [geodesicBuffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicBuffer) if the input geometries have a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator). Only use buffer (this method) when attempting to buffer geometries with a [projected coordinate system](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) other than Web Mercator. If you need to buffer geometries with a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) other than WGS84 (wkid: 4326), use [GeometryService.buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#buffer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#buffer) - * + * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param unionResults Determines whether the output geometries should be unioned into a single polygon. - * + * */ buffer(geometry: Geometry | Geometry[], distance: number | number[], unit: string | number, unionResults?: boolean): Polygon | Polygon[]; /** * Calculates the clipped geometry from a target geometry by an envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#clip) - * + * * @param geometry The geometry to be clipped. * @param envelope The envelope used to clip. - * + * */ clip(geometry: Geometry, envelope: Extent): Geometry; /** * Indicates if one geometry contains another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#contains) - * + * * @param containerGeometry The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the `insideGeometry`. * @param insideGeometry The geometry that is tested for the "within" relationship to the `containerGeometry`. - * + * */ contains(containerGeometry: Geometry, insideGeometry: Geometry): boolean; /** * Calculates the convex hull of the input geometry. A convex hull is the smallest convex polygon that encloses a group of Objects, such as points. The input geometry can be a point, multipoint, polyline or polygon. The hull is typically a polygon but can also be a polyline or point in degenerate cases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#convexHull) - * + * * @param geometry The input geometry. * @param merge Dictates whether to merge output geometries. - * + * */ convexHull(geometry: Geometry, merge?: boolean): Geometry | Geometry[]; /** * Indicates if one geometry crosses another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#crosses) - * + * * @param geometry1 The geometry to cross. * @param geometry2 The geometry being crossed. - * + * */ crosses(geometry1: Geometry, geometry2: Geometry): boolean; /** * Split the input Polyline or Polygon where it crosses a cutting Polyline. For Polylines, all left cuts are grouped together in the first Geometry. Right cuts and coincident cuts are grouped in the second Geometry and each undefined cut, along with any uncut parts, are output as separate Polylines. For Polygons, all left cuts are grouped in the first Polygon, all right cuts are grouped in the second Polygon, and each undefined cut, along with any left-over parts after cutting, are output as a separate Polygon. If no cuts are returned then the array will be empty. An undefined cut will only be produced if a left cut or right cut was produced and there was a part left over after cutting, or a cut is bounded to the left and right of the cutter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#cut) - * + * * @param geometry The geometry to be cut. * @param cutter The polyline to cut the geometry. - * + * */ cut(geometry: Geometry, cutter: Polyline): Geometry[]; /** * Densify geometries by plotting points between existing vertices. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#densify) - * + * * @param geometry The geometry to be densified. * @param maxSegmentLength The maximum segment length allowed. Must be a positive value. * @param maxSegmentLengthUnit Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ densify(geometry: Geometry, maxSegmentLength: number, maxSegmentLengthUnit: string | number): Geometry; /** * Creates the difference of two geometries. The resultant geometry is the portion of `inputGeometry` not in the `subtractor`. The dimension of the `subtractor` has to be equal to or greater than that of the `inputGeometry`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#difference) - * + * * @param inputGeometry The input geometry to subtract from. * @param subtractor The geometry being subtracted from inputGeometry. - * + * */ difference(inputGeometry: Geometry | Geometry[], subtractor: Geometry): Geometry | Geometry[]; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#disjoint) - * + * * @param geometry1 The base geometry that is tested for the "disjoint" relationship to the other geometry. * @param geometry2 The comparison geometry that is tested for the "disjoint" relationship to the other geometry. - * + * */ disjoint(geometry1: Geometry, geometry2: Geometry): boolean; /** - * Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by `distanceUnit` or, if `distanceUnit` is null, the units of the spatialReference of input geometry. + * Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by `distanceUnit` or, if `distanceUnit` is null, the units of the spatialReference of input geometry. * > To calculate the geodesic distance between two points, first construct a [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) using the two points of interest as the beginning and ending points of a single path. Then use the polyline as input for the [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicLength) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#distance) - * + * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @param distanceUnit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ distance(geometry1: Geometry, geometry2: Geometry, distanceUnit: string | number): number; /** * Indicates if two geometries are equal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#equals) - * + * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. - * + * */ equals(geometry1: Geometry, geometry2: Geometry): boolean; /** * Returns an Object containing additional information about the input spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#extendedSpatialReferenceInfo) - * + * * @param spatialReference The input spatial reference. - * + * */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): any; /** * Flips a geometry on the horizontal axis. Can optionally be flipped around a point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#flipHorizontal) - * + * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. - * + * */ flipHorizontal(geometry: Geometry, flipOrigin?: Point): Geometry; /** * Flips a geometry on the vertical axis. Can optionally be flipped around a point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#flipVertical) - * + * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. - * + * */ flipVertical(geometry: Geometry, flipOrigin?: Point): Geometry; /** * Performs the generalize operation on the geometries in the cursor. Point and Multipoint geometries are left unchanged. Envelope is converted to a Polygon and then generalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#generalize) - * + * * @param geometry The input geometry to be generalized. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. * @param removeDegenerateParts When `true` the degenerate parts of the geometry will be removed from the output (may be undesired for drawing). * @param maxDeviationUnit Measurement unit for maxDeviation. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: string | number): Geometry; /** * Calculates the area of the input geometry. As opposed to [planarArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarArea), geodesicArea takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate areas using geodesicArea(). If the input geometries have a projected coordinate system other than Web Mercator, use [planarArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarArea) instead. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicArea) - * + * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for area units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | ares | hectares | square-feet | square-meters | square-yards | square-kilometers | square-miles - * + * */ geodesicArea(geometry: Polygon, unit: string | number): number; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. When calculating distances, this method takes the curvature of the earth into account, which provides highly accurate results when dealing with very large geometries and/or geometries that spatially vary on a global scale where one projected coordinate system could not accurately plot coordinates and measure distances for all the geometries. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. In general, if your input geometries are assigned one of those two spatial references, you should always use geodesicBuffer() to obtain the most accurate results for those geometries. If needing to buffer points assigned a [projected coordinate system other than Web Mercator](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm), use [buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#buffer) instead. If the input geometries have a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) other than WGS84 (wkid: 4326), use [GeometryService.buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#buffer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicBuffer) - * + * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param unionResults Determines whether the output geometries should be unioned into a single polygon. - * + * */ geodesicBuffer(geometry: Geometry | Geometry[], distance: number | number[], unit: string | number, unionResults?: boolean): Polygon | Polygon[]; /** * Returns a geodesically densified version of the input geometry. Use this function to draw the line(s) of the geometry along great circles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicDensify) - * + * * @param geometry A polyline or polygon to densify. * @param maxSegmentLength The maximum segment length allowed. This must be a positive value. * @param maxSegmentLengthUnit Measurement unit for `maxSegmentLength`. If a unit is not specified, the units are considered to be the same as the units of the `geometry`. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit: string | number): Geometry; /** * Calculates the length of the input geometry. As opposed to [planarLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarLength), geodesicLength() takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate lengths using geodesicLength(). If the input geometries have a projected coordinate system other than Web Mercator, use [planarLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarLength) instead. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicLength) - * + * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ geodesicLength(geometry: Geometry, unit: string | number): number; /** * Creates a new geometry through intersection between two geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#intersect) - * + * * @param geometry The input geometry(ies). * @param intersector The geometry being intersected. - * + * */ intersect(geometry: Geometry | Geometry[], intersector: Geometry): Geometry | Geometry[]; /** * Indicates if one geometry intersects another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#intersects) - * + * * @param geometry1 The geometry that is tested for the intersects relationship to the other geometry. * @param geometry2 The geometry being intersected. - * + * */ intersects(geometry1: Geometry, geometry2: Geometry): boolean; /** * Indicates if the given geometry is topologically simple. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#isSimple) - * + * * @param geometry The input geometry. - * + * */ isSimple(geometry: Geometry): boolean; /** * Finds the coordinate of the geometry that is closest to the specified point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestCoordinate) - * + * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest coordinate in the geometry. - * + * */ nearestCoordinate(geometry: Geometry, inputPoint: Point): NearestPointResult; /** * Finds the vertex on the geometry nearest to the specified point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertex) - * + * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest vertex in the geometry. - * + * */ nearestVertex(geometry: Geometry, inputPoint: Point): NearestPointResult; /** * Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertices) - * + * * @param geometry The geometry to consider. * @param inputPoint The point from which to measure. * @param searchRadius The distance to search from the inputPoint in the units of the view's spatial reference. * @param maxVertexCountToReturn The maximum number of vertices to return. - * + * */ nearestVertices(geometry: Geometry, inputPoint: Point, searchRadius: number, maxVertexCountToReturn: number): NearestPointResult[]; /** * The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. It is similar to buffering, but produces a one-sided result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#offset) - * + * * @param geometry The geometries to offset. * @param offsetDistance The planar distance to offset from the input geometry. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, if offsetDistance = 0, then there is no change in the geometries, otherwise it is constructed to the left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the "right side" of a simple polygon is always its inside. * @param offsetUnit Measurement unit of the offset distance. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param joinType The join type. **Possible values:** round | bevel | miter | square * @param bevelRatio Applicable when `joinType = 'miter'`; bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * @param flattenError Applicable when `joinType = 'round'`; flattenError determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join. - * + * */ offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit: string | number, joinType: string, bevelRatio?: number, flattenError?: number): Geometry | Geometry[]; /** * Indicates if one geometry overlaps another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#overlaps) - * + * * @param geometry1 The base geometry that is tested for the "overlaps" relationship with the other geometry. * @param geometry2 The comparison geometry that is tested for the "overlaps" relationship with the other geometry. - * + * */ overlaps(geometry1: Geometry, geometry2: Geometry): boolean; /** * Calculates the area of the input geometry. As opposed to [geodesicArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicArea), planarArea() performs this calculation using projected coordinates and does not take into account the earth's curvature. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate areas using [geodesicArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicArea). If the input geometries have a projected coordinate system other than Web Mercator, use planarArea() instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarArea) - * + * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for area units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | ares | hectares | square-feet | square-meters | square-yards | square-kilometers | square-miles - * + * */ planarArea(geometry: Polygon, unit: string | number): number; /** * Calculates the length of the input geometry. As opposed to [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicLength), planarLength() uses projected coordinates and does not take into account the curvature of the earth when performing this calculation. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate lengths using [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#geodesicLength). If the input geometries have a projected coordinate system other than Web Mercator, use planarLength() instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#planarLength) - * + * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ planarLength(geometry: Geometry, unit: string | number): number; /** * Indicates if the given DE-9IM relation holds for the two geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#relate) - * + * * @param geometry1 The first geometry for the relation. * @param geometry2 The second geometry for the relation. * @param relation The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: `0`,`1`,`2`), a Boolean value (`T` or `F`), or a mask character (for ignoring results: '\*'). Example: Each of the following DE-9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry: `TTTFFTFFT` (Boolean), 'T*\*\*\*\*\*FF\*' (ignore irrelevant intersections), or '102FF\*FF\*' (dimension form). Each returns the same result. See [this article](https://en.wikipedia.org/wiki/DE-9IM) and [this ArcGIS help page](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) for more information about the DE-9IM model and how string codes are constructed. - * + * */ relate(geometry1: Geometry, geometry2: Geometry, relation: string): boolean; /** * Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#rotate) - * + * * @param geometry The geometry to rotate. * @param angle The rotation angle in degrees. * @param rotationOrigin Point to rotate the geometry around. Defaults to the centroid of the geometry. - * + * */ rotate(geometry: Geometry, angle: number, rotationOrigin?: Point): Geometry; /** * Performs the simplify operation on the geometry which alters the given geometries to make their definitions topologically legal with respect to their geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#simplify) - * + * * @param geometry The geometry to be simplified. - * + * */ simplify(geometry: Geometry): Geometry; /** * Creates the symmetric difference of two geometries. The symmetric difference includes the parts that are in either of the sets, but not in both. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#symmetricDifference) - * + * * @param leftGeometry One of the Geometry instances in the XOR operation. * @param rightGeometry One of the Geometry instances in the XOR operation. - * + * */ symmetricDifference(leftGeometry: Geometry | Geometry[], rightGeometry: Geometry): Geometry | Geometry[]; /** * Indicates if one geometry touches another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#touches) - * + * * @param geometry1 The geometry to test the "touches" relationship with the other geometry. * @param geometry2 The geometry to be touched. - * + * */ touches(geometry1: Geometry, geometry2: Geometry): boolean; /** * All inputs must be of the same type of geometries and share one spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#union) - * + * * @param geometries An array of Geometries to union. - * + * */ union(geometries: Geometry[]): Geometry; /** * Indicates if one geometry is within another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#within) - * + * * @param innerGeometry The base geometry that is tested for the "within" relationship to the other geometry. * @param outerGeometry The comparison geometry that is tested for the "contains" relationship to the other geometry. - * + * */ within(innerGeometry: Geometry, outerGeometry: Geometry): boolean; } @@ -3010,37 +3010,37 @@ declare namespace __esri { /** * Object returned from the [nearestCoordinate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestCoordinate), [nearestVertex()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertex), and [nearestVertices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertices) methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ export interface NearestPointResult extends Object { /** * A vertex within the specified distance of the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ coordinate: Point; /** * The distance from the `inputPoint` in the units of the view's spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ distance: number; /** * Indicates if the vertex is on the right side of the `geometry`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ isRightSide: boolean; /** * The index of the vertex within the geometry's rings or paths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ vertexIndex: number; /** * Indicates if it is an empty geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#NearestPointResult) */ isEmpty: boolean; @@ -3050,376 +3050,376 @@ declare namespace __esri { interface geometryEngineAsync { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. The GeometryEngine has two methods for buffering geometries client-side: buffer and [geodesicBuffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicBuffer). Use caution when deciding which method to use. As a general rule, use [geodesicBuffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicBuffer) if the input geometries have a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator). Only use buffer (this method) when attempting to buffer geometries with a [projected coordinate system](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) other than Web Mercator. If you need to buffer geometries with a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) other than WGS84 (wkid: 4326), use [GeometryService.buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#buffer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#buffer) - * + * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param unionResults Determines whether the output geometries should be unioned into a single polygon. - * + * */ buffer(geometry: Geometry | Geometry[], distance: number | number[], unit: string | number, unionResults?: boolean): IPromise; /** * Calculates the clipped geometry from a target geometry by an envelope. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#clip) - * + * * @param geometry The geometry to be clipped. * @param envelope The envelope used to clip. - * + * */ clip(geometry: Geometry, envelope: Extent): IPromise; /** * Indicates if one geometry contains another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#contains) - * + * * @param containerGeometry The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the `insideGeometry`. * @param insideGeometry The geometry that is tested for the "within" relationship to the `containerGeometry`. - * + * */ contains(containerGeometry: Geometry, insideGeometry: Geometry): IPromise; /** * Calculates the convex hull of the input geometry. A convex hull is the smallest convex polygon that encloses a group of Objects, such as points. The input geometry can be a point, multipoint, polyline or polygon. The hull is typically a polygon but can also be a polyline or point in degenerate cases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#convexHull) - * + * * @param geometry The input geometry. * @param merge Dictates whether to merge output geometries. - * + * */ convexHull(geometry: Geometry, merge?: boolean): IPromise; /** * Indicates if one geometry crosses another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#crosses) - * + * * @param geometry1 The geometry to cross. * @param geometry2 The geometry being crossed. - * + * */ crosses(geometry1: Geometry, geometry2: Geometry): IPromise; /** * Split the input Polyline or Polygon where it crosses a cutting Polyline. For Polylines, all left cuts are grouped together in the first Geometry. Right cuts and coincident cuts are grouped in the second Geometry and each undefined cut, along with any uncut parts, are output as separate Polylines. For Polygons, all left cuts are grouped in the first Polygon, all right cuts are grouped in the second Polygon, and each undefined cut, along with any left-over parts after cutting, are output as a separate Polygon. If no cuts are returned then the array will be empty. An undefined cut will only be produced if a left cut or right cut was produced and there was a part left over after cutting, or a cut is bounded to the left and right of the cutter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#cut) - * + * * @param geometry The geometry to be cut. * @param cutter The polyline to cut the geometry. - * + * */ cut(geometry: Geometry, cutter: Polyline): IPromise; /** * Densify geometries by plotting points between existing vertices. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#densify) - * + * * @param geometry The geometry to be densified. * @param maxSegmentLength The maximum segment length allowed. Must be a positive value. * @param maxSegmentLengthUnit Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ densify(geometry: Geometry, maxSegmentLength: number, maxSegmentLengthUnit: string | number): IPromise; /** * Creates the difference of two geometries. The resultant geometry is the portion of inputGeometry not in the subtractor. The dimension of the subtractor has to be equal to or greater than that of the inputGeometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#difference) - * + * * @param inputGeometry The input geometry to subtract from. * @param subtractor The geometry being subtracted from inputGeometry. - * + * */ difference(inputGeometry: Geometry | Geometry[], subtractor: Geometry): IPromise; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#disjoint) - * + * * @param geometry1 The base geometry that is tested for the "disjoint" relationship to the other geometry. * @param geometry2 The comparison geometry that is tested for the "disjoint" relationship to the other geometry. - * + * */ disjoint(geometry1: Geometry, geometry2: Geometry): IPromise; /** - * Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by `distanceUnit` or, if `distanceUnit` is null, the units of the spatialReference of input geometry. + * Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by `distanceUnit` or, if `distanceUnit` is null, the units of the spatialReference of input geometry. * > To calculate the geodesic distance between two points, first construct a [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) using the two points of interest as the beginning and ending points of a single path. Then use the polyline as input for the [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicLength) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#distance) - * + * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @param distanceUnit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ distance(geometry1: Geometry, geometry2: Geometry, distanceUnit: string | number): IPromise; /** * Indicates if two geometries are equal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#equals) - * + * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. - * + * */ equals(geometry1: Geometry, geometry2: Geometry): IPromise; /** * Returns an Object containing additional information about the input spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#extendedSpatialReferenceInfo) - * + * * @param spatialReference The input spatial reference. - * + * */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): IPromise; /** * Flips a geometry on the horizontal axis. Can optionally be flipped around a point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#flipHorizontal) - * + * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. - * + * */ flipHorizontal(geometry: Geometry, flipOrigin?: Point): IPromise; /** * Flips a geometry on the vertical axis. Can optionally be flipped around a point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#flipVertical) - * + * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. - * + * */ flipVertical(geometry: Geometry, flipOrigin?: Point): IPromise; /** * Performs the generalize operation on the geometries in the cursor. Point and Multipoint geometries are left unchanged. Envelope is converted to a Polygon and then generalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#generalize) - * + * * @param geometry The input geometry to be generalized. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. * @param removeDegenerateParts When `true` the degenerate parts of the geometry will be removed from the output (may be undesired for drawing). * @param maxDeviationUnit Measurement unit for maxDeviation. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: string | number): IPromise; /** * Calculates the area of the input geometry. As opposed to [planarArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarArea), geodesicArea takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate areas using geodesicArea(). If the input geometries have a projected coordinate system other than Web Mercator, use [planarArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarArea) instead. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicArea) - * + * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for area units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | ares | hectares | square-feet | square-meters | square-yards | square-kilometers | square-miles - * + * */ geodesicArea(geometry: Polygon, unit: string | number): IPromise; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. When calculating distances, this method takes the curvature of the earth into account, which provides highly accurate results when dealing with very large geometries and/or geometries that spatially vary on a global scale where one projected coordinate system could not accurately plot coordinates and measure distances for all the geometries. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. In general, if your input geometries are assigned one of those two spatial references, you should always use geodesicBuffer() to obtain the most accurate results for those geometries. If needing to buffer points assigned a [projected coordinate system other than Web Mercator](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm), use [buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#buffer) instead. If the input geometries have a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) other than WGS84 (wkid: 4326), use [GeometryService.buffer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#buffer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicBuffer) - * + * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param unionResults Determines whether the output geometries should be unioned into a single polygon. - * + * */ geodesicBuffer(geometry: Geometry | Geometry[], distance: number | number[], unit: string | number, unionResults?: boolean): IPromise; /** * Returns a geodesically densified version of the input geometry. Use this function to draw the line(s) of the geometry along great circles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicDensify) - * + * * @param geometry A polyline or polygon to densify. * @param maxSegmentLength The maximum segment length allowed. This must be a positive value. * @param maxSegmentLengthUnit Measurement unit for `maxSegmentLength`. If a unit is not specified, the units are considered to be the same as the units of the `geometry`. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit: string | number): IPromise; /** * Calculates the length of the input geometry. As opposed to [planarLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarLength), geodesicLength() takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate lengths using geodesicLength(). If the input geometries have a projected coordinate system other than Web Mercator, use [planarLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarLength) instead. This method only works with WGS84 (wkid: 4326) and [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicLength) - * + * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometry. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ geodesicLength(geometry: Geometry, unit: string | number): IPromise; /** * Creates a new geometry through intersection between two geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#intersect) - * + * * @param geometry The input geometry(ies). * @param intersector The geometry being intersected. - * + * */ intersect(geometry: Geometry | Geometry[], intersector: Geometry): IPromise; /** * Indicates if one geometry intersects another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#intersects) - * + * * @param geometry1 The geometry that is tested for the intersects relationship to the other geometry. * @param geometry2 The geometry being intersected. - * + * */ intersects(geometry1: Geometry, geometry2: Geometry): IPromise; /** * Indicates if the given geometry is topologically simple. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#isSimple) - * + * * @param geometry The input geometry. - * + * */ isSimple(geometry: Geometry): IPromise; /** * Finds the coordinate of the geometry that is closest to the specified point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestCoordinate) - * + * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest coordinate in the geometry. - * + * */ nearestCoordinate(geometry: Geometry, inputPoint: Point): IPromise; /** * Finds vertex on the geometry nearest to the specified point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestVertex) - * + * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest vertex in the geometry. - * + * */ nearestVertex(geometry: Geometry, inputPoint: Point): IPromise; /** * Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#nearestVertices) - * + * * @param geometry The geometry to consider. * @param inputPoint The point from which to measure. * @param searchRadius The distance to search from the inputPoint in the units of the view's spatial reference. * @param maxVertexCountToReturn The maximum number of vertices to return. - * + * */ nearestVertices(geometry: Geometry, inputPoint: Point, searchRadius: number, maxVertexCountToReturn: number): IPromise; /** * The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. It is similar to buffering, but produces a one-sided result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#offset) - * + * * @param geometry The geometries to offset. * @param offsetDistance The planar distance to offset from the input geometry. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, if offsetDistance = 0, then there is no change in the geometries, otherwise it is constructed to the left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the "right side" of a simple polygon is always its inside. * @param offsetUnit Measurement unit of the offset distance. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards * @param joinType The join type. **Possible values:** round | bevel | miter | square * @param bevelRatio Applicable when `joinType = 'miter'`; bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * @param flattenError Applicable when `joinType = 'round'`; flattenError determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join. - * + * */ offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit: string | number, joinType: string, bevelRatio?: number, flattenError?: number): IPromise; /** * Indicates if one geometry overlaps another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#overlaps) - * + * * @param geometry1 The base geometry that is tested for the "overlaps" relationship with the other geometry. * @param geometry2 The comparison geometry that is tested for the "overlaps" relationship with the other geometry. - * + * */ overlaps(geometry1: Geometry, geometry2: Geometry): IPromise; /** * Calculates the area of the input geometry. As opposed to [geodesicArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicArea), planarArea() performs this calculation using projected coordinates and does not take into account the earth's curvature. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate areas using [geodesicArea()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicArea). If the input geometries have a projected coordinate system other than Web Mercator, use planarArea() instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarArea) - * + * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for area units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | ares | hectares | square-feet | square-meters | square-yards | square-kilometers | square-miles - * + * */ planarArea(geometry: Polygon, unit: string | number): IPromise; /** * Calculates the length of the input geometry. As opposed to [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicLength), planarLength() uses projected coordinates and does not take into account the curvature of the earth when performing this calculation. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or [Web Mercator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator), it is best practice to calculate lengths using [geodesicLength()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#geodesicLength). If the input geometries have a projected coordinate system other than Web Mercator, use planarLength() instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#planarLength) - * + * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** meters | feet | kilometers | miles | nautical-miles | yards - * + * */ planarLength(geometry: Geometry, unit: string | number): IPromise; /** * Indicates if the given DE-9IM relation holds for the two geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#relate) - * + * * @param geometry1 The first geometry for the relation. * @param geometry2 The second geometry for the relation. * @param relation The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: `0`,`1`,`2`), a Boolean value (`T` or `F`), or a mask character (for ignoring results: '\*'). Example: Each of the following DE-9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry: `TTTFFTFFT` (Boolean), 'T\*\*\*\*\*FF\*' (ignore irrelevant intersections), or '102FF\*FF\*' (dimension form). Each returns the same result. See [this article](https://en.wikipedia.org/wiki/DE-9IM) and [this ArcGIS help page](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) for more information about the DE-9IM model and how string codes are constructed. - * + * */ relate(geometry1: Geometry, geometry2: Geometry, relation: string): IPromise; /** * Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#rotate) - * + * * @param geometry The geometry to rotate. * @param angle The rotation angle in degrees. * @param rotationOrigin Point to rotate the geometry around. Defaults to the centroid of the geometry. - * + * */ rotate(geometry: Geometry, angle: number, rotationOrigin?: Point): IPromise; /** * Performs the simplify operation on the geometry which alters the given geometries to make their definitions topologically legal with respect to their geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#simplify) - * + * * @param geometry The geometry to be simplified. - * + * */ simplify(geometry: Geometry): IPromise; /** * Creates the symmetric difference of two geometries. The symmetric difference includes the parts that are in either of the sets, but not in both. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#symmetricDifference) - * + * * @param leftGeometry One of the Geometry instances in the XOR operation. * @param rightGeometry One of the Geometry instances in the XOR operation. - * + * */ symmetricDifference(leftGeometry: Geometry | Geometry[], rightGeometry: Geometry): IPromise; /** * Indicates if one geometry touches another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#touches) - * + * * @param geometry1 The geometry to test the "touches" relationship with the other geometry. * @param geometry2 The geometry to be touched. - * + * */ touches(geometry1: Geometry, geometry2: Geometry): IPromise; /** * All inputs must be of the same type of geometries and share one spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#union) - * + * * @param geometries An array of Geometries to union. - * + * */ union(geometries: Geometry[]): IPromise; /** * Indicates if one geometry is within another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngineAsync.html#within) - * + * * @param innerGeometry The base geometry that is tested for the "within" relationship to the other geometry. * @param outerGeometry The comparison geometry that is tested for the "contains" relationship to the other geometry. - * + * */ within(innerGeometry: Geometry, outerGeometry: Geometry): IPromise; } @@ -3428,30 +3428,30 @@ declare namespace __esri { interface HeightModelInfo extends Accessor, JSONSupport { /** - * The surface type or height model of the vertical coordinate system (VCS). A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers containing data that is compatible with the HeightModelInfo of the scene. - * + * The surface type or height model of the vertical coordinate system (VCS). A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers containing data that is compatible with the HeightModelInfo of the scene. + * * Value | Description * ------|------------ * gravity-related-height | A gravity-related VCS may set its zero point through a local mean sea level or a benchmark, and is compatible with other gravity-related VCS for the purposes of rendering. * ellipsoidal | An ellipsoidal VCS defines heights that are referenced to an ellipsoid of a geographic coordinate system. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel) - * + * * @default "gravity-related-height" */ readonly heightModel: string; /** * The unit of the vertical coordinate system. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will use this property to check that the vertical data of layers that define a HeightModelInfo is compatible with the view. **Possible Values:** meters | feet | us-feet | clarke-feet | clarke-yards | clarke-links | sears-yards | sears-feet | sears-chains | benoit-1895-b-chains | indian-yards | indian-1937-yards | gold-coast-feet | sears-1922-truncated-chains | 50-kilometers | 150-kilometers - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightUnit) - * + * * @default "meters" */ readonly heightUnit: string; /** * The datum realization of the vertical coordinate system. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers that define a HeightModelInfo with an identical `vertCRS` to that of the scene, when using an `ellipsoidal` height model. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#vertCRS) */ readonly vertCRS: string; @@ -3469,30 +3469,30 @@ declare namespace __esri { interface HeightModelInfoProperties { /** - * The surface type or height model of the vertical coordinate system (VCS). A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers containing data that is compatible with the HeightModelInfo of the scene. - * + * The surface type or height model of the vertical coordinate system (VCS). A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers containing data that is compatible with the HeightModelInfo of the scene. + * * Value | Description * ------|------------ * gravity-related-height | A gravity-related VCS may set its zero point through a local mean sea level or a benchmark, and is compatible with other gravity-related VCS for the purposes of rendering. * ellipsoidal | An ellipsoidal VCS defines heights that are referenced to an ellipsoid of a geographic coordinate system. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightModel) - * + * * @default "gravity-related-height" */ heightModel?: string; /** * The unit of the vertical coordinate system. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will use this property to check that the vertical data of layers that define a HeightModelInfo is compatible with the view. **Possible Values:** meters | feet | us-feet | clarke-feet | clarke-yards | clarke-links | sears-yards | sears-feet | sears-chains | benoit-1895-b-chains | indian-yards | indian-1937-yards | gold-coast-feet | sears-1922-truncated-chains | 50-kilometers | 150-kilometers - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#heightUnit) - * + * * @default "meters" */ heightUnit?: string; /** * The datum realization of the vertical coordinate system. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) will only render layers that define a HeightModelInfo with an identical `vertCRS` to that of the scene, when using an `ellipsoidal` height model. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-HeightModelInfo.html#vertCRS) */ vertCRS?: string; @@ -3501,94 +3501,94 @@ declare namespace __esri { interface Mesh extends Geometry { /** * An array of mesh components that can be used to apply materials to different regions of the same mesh. There are three common usage patterns for components. 1. **Specify a material for the whole mesh.** In this case, use a single component with only a material (leaving faces as `null`). 2. **Reuse vertex attributes.** When modeling continuous surfaces, it can be convenient to only specify vertices once and then simply refer to them. In this case, use a single component with faces set to index the vertex attributes that form triangles. 3. **Specify multiple materials for the same mesh.** In this case, use multiple components with faces that determine to which region of the mesh the material of the component applies. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#components) */ components: MeshComponent[]; /** * For Mesh, the type is always `mesh`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#type) */ readonly type: "mesh"; /** * Object describing the attributes of each vertex of the mesh. Vertex attributes are flat numerical arrays that describe the position (mandatory), normal (used for lighting calculations and shading) and uv (used for mapping material images to the mesh surface) for each vertex. Vertex attributes can be addressed by indices specified in the components [faces](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) property. If the mesh does not contain any components, or if a component does not specify any faces, then the vertex attributes are interpreted as if each consecutive vertex triple makes up a triangle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ vertexAttributes: MeshVertexAttributes; /** * Adds a component to the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#addComponent) - * + * * @param component The component to add. - * + * */ addComponent(component: MeshComponent): void; /** * Centers the mesh at the specified location without changing its scale. The mesh will be modified in place. To modify a copy of the mesh instead, use [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#clone) before calling [centerAt()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) - * + * * @param location The location at which to center the mesh. * @param params Additional parameters. * @param params.geographic Indicates whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the offset applied to center the mesh is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. * @param params.origin The origin at which to center. If not specified, the mesh will be centered at the mesh extent center. - * + * */ centerAt(location: Point, params?: MeshCenterAtParams): Mesh; /** * Creates a deep clone of the Mesh object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#clone) - * - * + * + * */ clone(): Mesh; /** * Offsets the mesh geometry by the specified distance in x, y, and z. The units of x, y, and z are the units of the spatial reference. When the offset is applied geographically (default for either WGS84 or WebMercator), then the offsets are interpreted in meters. The mesh will be modified in place. To modify a copy of the mesh instead, use [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#clone) before calling [offset()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#offset). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#offset) - * + * * @param dx The amount to offset the geometry in the x direction. * @param dy The amount to offset the geometry in the y direction. * @param dz The amount to offset the geometry in the z direction. * @param params Additional parameters. * @param params.geographic Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the offset is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. - * + * */ offset(dx: number, dy: number, dz: number, params?: MeshOffsetParams): Mesh; /** * Removes a component from the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#removeComponent) - * + * * @param component The component to remove. - * + * */ removeComponent(component: MeshComponent): void; /** * Rotates the mesh geometry around its x, y and z axis (in that order). For each rotation angle, the rotation direction is clockwise when looking in the direction of the respective axis. The mesh will be modified in place. To modify a copy of the mesh instead, use [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#clone) before calling [rotate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) - * + * * @param angleX The angle by which to rotate around the x-axis (in degrees). * @param angleY The angle by which to rotate around the y-axis (in degrees). * @param angleZ The angle by which to rotate around the z-axis (in degrees). * @param params Additional parameters. * @param params.geographic Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the rotation is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. * @param params.origin The origin around which to rotate. If not specified, the mesh will be rotated around the mesh extent center. - * + * */ rotate(angleX: number, angleY: number, angleZ: number, params?: MeshRotateParams): Mesh; /** * Notifies that any cached values that depend on vertex attributes need to be recalculated. Use this method after modifying the vertex attributes in place so that values that depend on them (such as the calculation of the extent) are recalculated accordingly. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributesChanged) - * - * + * + * */ vertexAttributesChanged(): void; } @@ -3596,7 +3596,7 @@ declare namespace __esri { interface MeshConstructor { /** * A mesh is a general, client-side 3D [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) type composed of [vertices with attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes). The vertices include geographic position, normals that affect lighting/shading and uv coordinates that can be used to map images to the mesh. Vertices are combined into 3D primitives to render the mesh in the scene (only triangle primitives are currently supported). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) */ @@ -3605,69 +3605,69 @@ declare namespace __esri { /** * Creates a mesh representing a box. The spatial reference of the resulting mesh is the same as the location where it is placed. **Box UV coordinate space** The box geometry will have UV coordinates generated according to the following scheme: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) - * + * * @param location The location bottom center of the box. * @param params Additional parameters. * @param params.size A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. * @param params.geographic Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. * @param params.material The material to be used for the mesh. * @param params.imageFace The face for generating image uv coordinates. By default, a single set of unwrapped UV coordinates are generated for all the faces. By setting the `imageFace` parameter to one of `east`, `west`, `north`, `south`, `up` or `down`, the specified face will have full sized UV coordinates while the other faces will pertain their regular unwrapped UV coordinates. This is useful for applying an image only to a single face of the box. The provided `material` parameter will be applied to the specified `imageFace`. The resulting mesh will have two components, the first contains the selected image face and the second contains the other faces of the box. - * + * */ createBox(location: Point, params?: MeshCreateBoxParams): Mesh; /** * Creates a mesh representing a cylinder. The spatial reference of the resulting mesh is the same as the location where it is placed. **Cylinder UV coordinate space** The cylinder geometry will have UV coordinates generated according to the following scheme (example is shown for 8 vertices cylinder): - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) - * + * * @param location The location of the bottom center of the cylinder. * @param params Additional parameters. * @param params.size A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. * @param params.geographic Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. * @param params.densificationFactor The additional number of subdivisions for generating the mesh representing a cylinder. A densificationFactor parameter of 0 will generate a default of 16 vertices to approximate the cylinder. A densificationFactor of 1 will generate 32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a perfect cylinder (at the cost of processing and rendering performance). * @param params.material The material to be used for the mesh. - * + * */ createCylinder(location: Point, params?: MeshCreateCylinderParams): Mesh; /** * Creates a new mesh geometry from a polygon geometry. The resulting mesh contains only a position vertex attribute and a single component with faces. The default shading will be set to `flat`. The spatial reference of the resulting mesh is the same as the input polygon. The resulting mesh will not contain any uv nor normal vertex attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromPolygon) - * + * * @param polygon The input polygon. * @param params Optional parameters. * @param params.material The material to be used for the mesh. - * + * */ createFromPolygon(polygon: Polygon, params?: MeshCreateFromPolygonParams): Mesh; /** * Creates a mesh representing a plane. The spatial reference of the resulting mesh is the same as the location where it is placed. A plane consists of two triangles and may be conveniently oriented at creation time. **Plane UV coordinate space** The plane geometry will have UV coordinates generated according to the following scheme: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) - * + * * @param location The location of the bottom center of the plane. * @param params Additional parameters. * @param params.size A uniform size value or an object containing individual values width and height. The unit of the size values is derived from the spatial reference of the provided location. * @param params.facing Direction the plane is facing. Possible values are `east`, `west`, `north`, `south`, `up` and `down`. Defaults to `up`, * @param params.geographic Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. * @param params.material The material to be used for the mesh. - * + * */ createPlane(location: Point, params?: MeshCreatePlaneParams): Mesh; /** * Creates a mesh representing a sphere. The spatial reference of the resulting mesh is the same as the location where it is placed. **Sphere UV coordinate space** The sphere geometry will have UV coordinates generated according to the following scheme (example is shown for 8x8 vertices sphere): - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) - * + * * @param location The location of the bottom center of the sphere. * @param params Additional parameters. * @param params.size A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. * @param params.geographic Indicates whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. * @param params.densificationFactor The additional number of subdivisions for generating the mesh representing a sphere. A densificationFactor parameter of 0 will generate a default of 16-by-16 vertices to approximate the sphere. A densificationFactor of 1 will generate 32-by-32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a perfect sphere (at the cost of processing and rendering performance). * @param params.material The material to be used for the mesh. - * + * */ createSphere(location: Point, params?: MeshCreateSphereParams): Mesh; @@ -3679,13 +3679,13 @@ declare namespace __esri { interface MeshProperties extends GeometryProperties { /** * An array of mesh components that can be used to apply materials to different regions of the same mesh. There are three common usage patterns for components. 1. **Specify a material for the whole mesh.** In this case, use a single component with only a material (leaving faces as `null`). 2. **Reuse vertex attributes.** When modeling continuous surfaces, it can be convenient to only specify vertices once and then simply refer to them. In this case, use a single component with faces set to index the vertex attributes that form triangles. 3. **Specify multiple materials for the same mesh.** In this case, use multiple components with faces that determine to which region of the mesh the material of the component applies. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#components) */ components?: MeshComponentProperties[]; /** * Object describing the attributes of each vertex of the mesh. Vertex attributes are flat numerical arrays that describe the position (mandatory), normal (used for lighting calculations and shading) and uv (used for mapping material images to the mesh surface) for each vertex. Vertex attributes can be addressed by indices specified in the components [faces](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) property. If the mesh does not contain any components, or if a component does not specify any faces, then the vertex attributes are interpreted as if each consecutive vertex triple makes up a triangle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ vertexAttributes?: MeshVertexAttributesProperties; @@ -3695,13 +3695,13 @@ declare namespace __esri { export interface MeshCenterAtParams extends Object { /** * Indicates whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the offset applied to center the mesh is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) */ geographic?: boolean; /** * The origin at which to center. If not specified, the mesh will be centered at the mesh extent center. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#centerAt) */ origin?: Point; @@ -3711,25 +3711,25 @@ declare namespace __esri { export interface MeshCreateBoxParams extends Object { /** * A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ size?: number | MeshCreateBoxParamsSize; /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ geographic?: boolean; /** * The material to be used for the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ material?: MeshCreateBoxParamsMaterial; /** * The face for generating image uv coordinates. By default, a single set of unwrapped UV coordinates are generated for all the faces. By setting the `imageFace` parameter to one of `east`, `west`, `north`, `south`, `up` or `down`, the specified face will have full sized UV coordinates while the other faces will pertain their regular unwrapped UV coordinates. This is useful for applying an image only to a single face of the box. The provided `material` parameter will be applied to the specified `imageFace`. The resulting mesh will have two components, the first contains the selected image face and the second contains the other faces of the box. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ imageFace?: string; @@ -3739,7 +3739,7 @@ declare namespace __esri { export interface MeshCreateBoxParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ color?: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -3749,19 +3749,19 @@ declare namespace __esri { export interface MeshCreateBoxParamsSize extends Object { /** * The width of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ width?: number; /** * The depth of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ depth?: number; /** * The height of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createBox) */ height?: number; @@ -3771,25 +3771,25 @@ declare namespace __esri { export interface MeshCreateCylinderParams extends Object { /** * A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ size?: number | MeshCreateCylinderParamsSize; /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ geographic?: boolean; /** * The additional number of subdivisions for generating the mesh representing a cylinder. A densificationFactor parameter of 0 will generate a default of 16 vertices to approximate the cylinder. A densificationFactor of 1 will generate 32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a perfect cylinder (at the cost of processing and rendering performance). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ densificationFactor?: number; /** * The material to be used for the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ material?: MeshCreateCylinderParamsMaterial; @@ -3799,7 +3799,7 @@ declare namespace __esri { export interface MeshCreateCylinderParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ color: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -3809,19 +3809,19 @@ declare namespace __esri { export interface MeshCreateCylinderParamsSize extends Object { /** * The width of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ width?: number; /** * The depth of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ depth?: number; /** * The height of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createCylinder) */ height?: number; @@ -3831,7 +3831,7 @@ declare namespace __esri { export interface MeshCreateFromPolygonParams extends Object { /** * The material to be used for the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromPolygon) */ material?: MeshCreateFromPolygonParamsMaterial; @@ -3841,7 +3841,7 @@ declare namespace __esri { export interface MeshCreateFromPolygonParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createFromPolygon) */ color?: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -3851,25 +3851,25 @@ declare namespace __esri { export interface MeshCreatePlaneParams extends Object { /** * A uniform size value or an object containing individual values width and height. The unit of the size values is derived from the spatial reference of the provided location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ size?: number | MeshCreatePlaneParamsSize; /** * Direction the plane is facing. Possible values are `east`, `west`, `north`, `south`, `up` and `down`. Defaults to `up`, - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ facing?: string; /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ geographic?: boolean; /** * The material to be used for the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ material?: MeshCreatePlaneParamsMaterial; @@ -3879,7 +3879,7 @@ declare namespace __esri { export interface MeshCreatePlaneParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ color?: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -3889,13 +3889,13 @@ declare namespace __esri { export interface MeshCreatePlaneParamsSize extends Object { /** * The width of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ width?: number; /** * The height of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createPlane) */ height?: number; @@ -3905,25 +3905,25 @@ declare namespace __esri { export interface MeshCreateSphereParams extends Object { /** * A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ size?: number | MeshCreateSphereParamsSize; /** * Indicates whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the mesh is created in a Cartesian system with respect to the local coordinate system on the globe and sizes are specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ geographic?: boolean; /** * The additional number of subdivisions for generating the mesh representing a sphere. A densificationFactor parameter of 0 will generate a default of 16-by-16 vertices to approximate the sphere. A densificationFactor of 1 will generate 32-by-32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a perfect sphere (at the cost of processing and rendering performance). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ densificationFactor?: number; /** * The material to be used for the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ material?: MeshCreateSphereParamsMaterial; @@ -3933,7 +3933,7 @@ declare namespace __esri { export interface MeshCreateSphereParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ color?: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -3943,19 +3943,19 @@ declare namespace __esri { export interface MeshCreateSphereParamsSize extends Object { /** * The width of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ width?: number; /** * The depth of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ depth?: number; /** * The height of the created mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#createSphere) */ height?: number; @@ -3965,7 +3965,7 @@ declare namespace __esri { export interface MeshOffsetParams extends Object { /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the offset is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#offset) */ geographic?: boolean; @@ -3975,13 +3975,13 @@ declare namespace __esri { export interface MeshRotateParams extends Object { /** * Whether to georeference relative to the globe or the projected coordinate system (PCS). This parameter is only relevant for spatial references that can be used in both local and global viewing modes (currently only WebMercator). This parameter defaults to `true` for WebMercator and WGS84, and `false` for any other PCS. When true, the rotation is applied in a Cartesian system with respect to the local coordinate system on the globe and is specified in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) */ geographic?: boolean; /** * The origin around which to rotate. If not specified, the mesh will be rotated around the mesh extent center. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#rotate) */ origin?: Point; @@ -3991,25 +3991,25 @@ declare namespace __esri { export interface MeshVertexAttributesProperties extends Object { /** * A flat array of vertex positions. Vertex positions have x, y and z coordinates and they should be in the spatial reference system of the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ position?: Float64Array | number[] | Float32Array; /** * A flat array of vertex uv coordinates (2 elements per vertex). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ uv?: Float32Array | number[] | Float64Array; /** * A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ normal?: Float32Array | number[] | Float64Array; /** * **Since: 4.9** A flat array of the vertex colors (4 elements per vertex ranging from 0 to 255). Vertex colors are multiplied by the component material color (if any is defined). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ color?: Uint8Array | number[] | Uint8ClampedArray; @@ -4018,25 +4018,25 @@ declare namespace __esri { export interface MeshVertexAttributes extends AnonymousAccessor { /** * A flat array of vertex positions. Vertex positions have x, y and z coordinates and they should be in the spatial reference system of the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ position: Float64Array; /** * A flat array of vertex uv coordinates (2 elements per vertex). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ uv?: Float32Array; /** * A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ normal?: Float32Array; /** * **Since: 4.9** A flat array of the vertex colors (4 elements per vertex ranging from 0 to 255). Vertex colors are multiplied by the component material color (if any is defined). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) */ color?: Uint8Array; @@ -4045,60 +4045,60 @@ declare namespace __esri { interface Multipoint extends Geometry { /** * An array of points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) */ points: number[][]; /** * For Multipoint, the type is always `multipoint`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#type) */ readonly type: "multipoint"; /** * Adds a point to the Multipoint. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#addPoint) - * + * * @param point The point to add to the multipoint. The point can either be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) or an array of numbers representing XY coordinates. - * + * */ addPoint(point: Point | number[]): Multipoint; /** * Creates a deep clone of Multipoint object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#clone) - * - * + * + * */ clone(): Multipoint; /** * Returns the point at the specified index. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#getPoint) - * + * * @param index The index of the point in the [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) property. - * + * */ getPoint(index: number): Point; /** * Removes a point from the Multipoint. The index specifies which point to remove. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#removePoint) - * + * * @param index The index of the point to remove. - * + * */ removePoint(index: number): Point; /** * Updates the point at the specified index. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#setPoint) - * + * * @param index The index of the point in the [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) property. * @param point Point geometry that specifies the new location. - * + * */ setPoint(index: number, point: Point): Multipoint; } @@ -4116,7 +4116,7 @@ declare namespace __esri { interface MultipointProperties extends GeometryProperties { /** * An array of points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html#points) */ points?: number[][]; @@ -4125,97 +4125,97 @@ declare namespace __esri { interface Point extends Geometry { /** * The latitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#latitude) */ latitude: number; /** * The longitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#longitude) */ longitude: number; /** * The m-coordinate of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#m) - * + * * @default undefined */ m: number; /** * For Point, the type is always `point`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#type) */ readonly type: "point"; /** * The x-coordinate (easting) of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#x) - * + * * @default 0 */ x: number; /** * The y-coordinate (northing) of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#y) - * + * * @default 0 */ y: number; /** - * The z-coordinate (or elevation) of the point in map units. + * The z-coordinate (or elevation) of the point in map units. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#z) - * + * * @default undefined */ z: number; /** * Creates a deep clone of Point object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) - * - * + * + * */ clone(): Point; /** * Copies all values from another Point instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#copy) - * + * * @param other The point to copy from. - * + * */ copy(other: Point): void; /** * Computes the Euclidean distance between this Point and a given Point. Points must have the same spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#distance) - * + * * @param other The point to compute the distance to. - * + * */ distance(other: Point): number; /** * Determines if the input point is equal to the point calling the function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#equals) - * + * * @param point The input point to test. - * + * */ equals(point: Point): boolean; /** * Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units. You should [clone](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) the point object before calling this method where appropriate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#normalize) - * - * + * + * */ normalize(): Point; } @@ -4223,7 +4223,7 @@ declare namespace __esri { interface PointConstructor { /** * A location defined by X, Y, and Z coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) */ @@ -4237,46 +4237,46 @@ declare namespace __esri { interface PointProperties extends GeometryProperties { /** * The latitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#latitude) */ latitude?: number; /** * The longitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#longitude) */ longitude?: number; /** * The m-coordinate of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#m) - * + * * @default undefined */ m?: number; /** * The x-coordinate (easting) of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#x) - * + * * @default 0 */ x?: number; /** * The y-coordinate (northing) of the point in map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#y) - * + * * @default 0 */ y?: number; /** - * The z-coordinate (or elevation) of the point in map units. + * The z-coordinate (or elevation) of the point in map units. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#z) - * + * * @default undefined */ z?: number; @@ -4285,121 +4285,121 @@ declare namespace __esri { interface Polygon extends Geometry { /** * The centroid of the polygon. For a polygon with multiple rings, it represents the centroid of the largest ring. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#centroid) */ centroid: Point; /** * Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isSelfIntersecting) */ isSelfIntersecting: boolean; /** * An array of rings. Each ring is a two-dimensional array of numbers representing the coordinates of each vertex in the ring in the spatial reference of the view. The first vertex of each ring should always be the same as the last vertex. Each vertex is an array of two, three, or four numbers. The table below shows the various structures of a vertex array. - * + * * Case | Vertex array * --- | --- * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM)| [x, y] * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, m] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, z] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, z, m] - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) */ rings: number[][][]; /** * For Polygon, the type is always `polygon`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#type) */ readonly type: "polygon"; /** * Adds a ring to the Polygon. The ring can be one of the following: an array of numbers or an array of points. When added the index of the ring is incremented by one. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#addRing) - * + * * @param points A polygon ring. The first and last coordinates/points in the ring must be the same. This can either be defined as an array of Point geometries or an array of XY coordinates. - * + * */ addRing(points: Point[] | number[][]): Polygon; /** * Creates a deep clone of Polygon object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#clone) - * - * + * + * */ clone(): Polygon; /** * Checks on the client if the input point is inside the polygon. A point on the polygon line is considered inside. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#contains) - * + * * @param point The point to test whether it is contained within the testing polygon. - * + * */ contains(point: Point): boolean; /** * Returns a point specified by a ring and point in the path. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#getPoint) - * + * * @param ringIndex The index of the ring containing the desired point. * @param pointIndex The index of the desired point within the ring. - * + * */ getPoint(ringIndex: number, pointIndex: number): Point; /** * Inserts a new point into the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#insertPoint) - * + * * @param ringIndex The index of the ring in which to insert the point. * @param pointIndex The index of the point to insert within the ring. * @param point The point to insert. - * + * */ insertPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; /** * Checks if a Polygon ring is clockwise. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isClockwise) - * + * * @param ring A polygon ring. The first and last coordinates/points in the ring must be the same. This can either be defined as an array of Point geometries or an array of XY coordinates. - * + * */ isClockwise(ring: Point[] | number[][]): boolean; /** * Removes a point from the polygon at the given `pointIndex` within the ring identified by `ringIndex`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#removePoint) - * + * * @param ringIndex The index of the ring containing the point to remove. * @param pointIndex The index of the point to remove within the ring. - * + * */ removePoint(ringIndex: number, pointIndex: number): Point[]; /** * Removes a ring from the Polygon. The index specifies which ring to remove. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#removeRing) - * + * * @param index The index of the ring to remove. - * + * */ removeRing(index: number): Point[]; /** * Updates a point in the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#setPoint) - * + * * @param ringIndex The index of the ring containing the point to update. * @param pointIndex The index of the point to update within the ring. * @param point The new point geometry. - * + * */ setPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; } @@ -4407,7 +4407,7 @@ declare namespace __esri { interface PolygonConstructor { /** * A polygon contains an array of [rings](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) and a [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#spatialReference). Each ring is represented as an array points. The first and last points of a ring must be the same. A polygon also has boolean-valued [hasM](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) and [hasZ](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) */ @@ -4416,11 +4416,11 @@ declare namespace __esri { /** * Converts the given Extent to a Polygon instance. This is useful for scenarios in which you would like to display an area of interest, which is typically defined by an Extent or bounding box, as a polygon with a fill symbol in the view. Some geoprocessing tools require input geometries to be of a Polygon type and not an Extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#fromExtent) - * + * * @param extent An extent object to convert to a polygon. - * + * */ fromExtent(extent: Extent): Polygon; @@ -4432,27 +4432,27 @@ declare namespace __esri { interface PolygonProperties extends GeometryProperties { /** * The centroid of the polygon. For a polygon with multiple rings, it represents the centroid of the largest ring. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#centroid) */ centroid?: PointProperties; /** * Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#isSelfIntersecting) */ isSelfIntersecting?: boolean; /** * An array of rings. Each ring is a two-dimensional array of numbers representing the coordinates of each vertex in the ring in the spatial reference of the view. The first vertex of each ring should always be the same as the last vertex. Each vertex is an array of two, three, or four numbers. The table below shows the various structures of a vertex array. - * + * * Case | Vertex array * --- | --- * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM)| [x, y] * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, m] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, z] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#hasM) | [x, y, z, m] - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html#rings) */ rings?: number[][][]; @@ -4461,91 +4461,91 @@ declare namespace __esri { interface Polyline extends Geometry { /** * An array of paths, or line segments, that make up the polyline. Each path is a two-dimensional array of numbers representing the coordinates of each vertex in the path in the spatial reference of the view. Each vertex is represented as an array of two, three, or four numbers. The table below shows the various structures of a vertex array. - * + * * Case | Vertex array * --- | --- * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y] * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, m] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, z] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, z, m] - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#paths) */ paths: number[][][]; /** * For Polyline, the type is always `polyline`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#type) */ readonly type: "polyline"; /** * Adds a path, or line segment, to the polyline. When added, the index of the path is incremented by one. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#addPath) - * + * * @param points A polyline path. This can either be defined as an array of Point geometries or an array of XY coordinates. - * + * */ addPath(points: Point[] | number[][]): Polyline; /** * Creates a deep clone of Polyline object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#clone) - * - * + * + * */ clone(): Polyline; /** * Returns a point specified by a path and point in the path. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#getPoint) - * + * * @param pathIndex The index of a path in the polyline. * @param pointIndex The index of a point in a path. - * + * */ getPoint(pathIndex: number, pointIndex: number): Point; /** * Inserts a new point into a polyline. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#insertPoint) - * + * * @param pathIndex The index of the path in which to insert a point. * @param pointIndex The index of the inserted point in the path. * @param point The point to insert. - * + * */ insertPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline; /** * Removes a path from the Polyline. The index specifies which path to remove. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#removePath) - * + * * @param index The index of the path to remove from the polyline. - * + * */ removePath(index: number): Point[]; /** * Removes a point from the polyline at the given `pointIndex` within the path identified by the given `pathIndex`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#removePoint) - * + * * @param pathIndex The index of the path containing the point to be removed. * @param pointIndex The index of the point to be removed within the path. - * + * */ removePoint(pathIndex: number, pointIndex: number): Point; /** * Updates a point in a polyline. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#setPoint) - * + * * @param pathIndex The index of the path that contains the point to be updated. * @param pointIndex The index of the point to be updated in the path. * @param point Point geometry to update in the path. - * + * */ setPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline; } @@ -4563,15 +4563,15 @@ declare namespace __esri { interface PolylineProperties extends GeometryProperties { /** * An array of paths, or line segments, that make up the polyline. Each path is a two-dimensional array of numbers representing the coordinates of each vertex in the path in the spatial reference of the view. Each vertex is represented as an array of two, three, or four numbers. The table below shows the various structures of a vertex array. - * + * * Case | Vertex array * --- | --- * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y] * [without z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, m] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [without m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, z] * [with z](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) and [with m](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasM) | [x, y, z, m] - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#paths) */ paths?: number[][][]; @@ -4579,72 +4579,72 @@ declare namespace __esri { /** * A client-side projection engine for converting geometries from one [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) to another. When projecting geometries the starting spatial reference must be specified on the input geometry. You can specify a specific geographic (datum) transformation for the [project](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) operation, or accept the default transformation if one is needed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) */ interface projection { /** - * Returns the default geographic transformation used to convert the geometry from the input spatial reference to the output spatial reference. The default transformation is used when [projecting geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) where the datum transformation is required but not specified in the `geographicTransformation` parameter. - * > **Known Limitations** + * Returns the default geographic transformation used to convert the geometry from the input spatial reference to the output spatial reference. The default transformation is used when [projecting geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) where the datum transformation is required but not specified in the `geographicTransformation` parameter. + * > **Known Limitations** * * This method returns equation-based geographic transformations only. * * Geographic transformations are returned with their maximum number of [steps](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#steps). Currently, number of steps is limited to 2. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformation) - * + * * @param inSpatialReference The input spatial reference from which to project geometries. This is the spatial reference of the input geometries. * @param outSpatialReference The spatial reference to which you are converting the geometries. * @param extent An extent used to determine the suitability of the returned transformation. The extent will be re-projected to the `inSpatialReference` if it has a different spatial reference. - * + * */ getTransformation(inSpatialReference: SpatialReference | SpatialReferenceProperties, outSpatialReference: SpatialReference | SpatialReferenceProperties, extent?: Extent): GeographicTransformation; /** - * Returns a list of all geographic transformations suitable to convert geometries from the input spatial reference to the specified output spatial reference. The list is ordered in descending order by suitability, with the most suitable being first in the list. - * > **Known Limitations** + * Returns a list of all geographic transformations suitable to convert geometries from the input spatial reference to the specified output spatial reference. The list is ordered in descending order by suitability, with the most suitable being first in the list. + * > **Known Limitations** * * This method returns all the suitable equation-based geographic transformations. * * Geographic transformations are returned with their maximum number of [steps](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#steps). Currently, number of steps is limited to 2. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformations) - * + * * @param inSpatialReference The spatial reference that the geometries are currently using. * @param outSpatialReference The spatial reference to which you are converting the geometries to. * @param extent An extent used to determine the suitability of the returned transformations. The extent will be re-projected to the input spatial reference if necessary. - * + * */ getTransformations(inSpatialReference: SpatialReference | SpatialReferenceProperties, outSpatialReference: SpatialReference | SpatialReferenceProperties, extent?: Extent): GeographicTransformation[]; /** * Indicates if all dependencies of this module have been loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#isLoaded) - * - * + * + * */ isLoaded(): boolean; /** * Indicates if this module is supported in the browser. The browser must support [WebAssembly](https://caniuse.com/#feat=wasm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#isSupported) - * - * + * + * */ isSupported(): boolean; /** * Loads this module's dependencies. This method must be called before [projecting](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#load) - * - * + * + * */ load(): IPromise; /** - * Projects a geometry or an array of geometries to the specified output spatial reference. A default geographic transformation is used if not explicitly provided, but required. Use the [getTransformation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformation) method to find out which transformation is used by default for the given input and output spatial references. Note that you must [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#load) this module before attempting to project geometries. + * Projects a geometry or an array of geometries to the specified output spatial reference. A default geographic transformation is used if not explicitly provided, but required. Use the [getTransformation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#getTransformation) method to find out which transformation is used by default for the given input and output spatial references. Note that you must [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#load) this module before attempting to project geometries. * > **Known Limitations** This method uses the spatial reference of the first geometry as an input spatial reference. Therefore all geometries in the array must have the same spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html#project) - * + * * @param geometry The geometry or geometries to project. * @param outSpatialReference The spatial reference to which you are converting the geometries' coordinates. * @param geographicTransformation The geographic transformation used to transform the geometries. Specify this parameter to project a geometry when the default transformation is not appropriate for your requirements. - * + * */ project(geometry: Geometry | Geometry[], outSpatialReference: SpatialReference | SpatialReferenceProperties, geographicTransformation?: GeographicTransformation): Geometry | Geometry[]; } @@ -4654,27 +4654,27 @@ declare namespace __esri { interface ScreenPoint extends Accessor { /** * X-coordinate in pixels relative to the top-left corner of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html#x) - * + * * @default 0 */ x: number; /** * Y-coordinate in pixels relative to the top-left corner of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html#y) - * + * * @default 0 */ y: number; /** * Creates a deep clone of ScreenPoint object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html#clone) - * - * + * + * */ clone(): ScreenPoint; } @@ -4690,17 +4690,17 @@ declare namespace __esri { interface ScreenPointProperties { /** * X-coordinate in pixels relative to the top-left corner of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html#x) - * + * * @default 0 */ x?: number; /** * Y-coordinate in pixels relative to the top-left corner of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html#y) - * + * * @default 0 */ y?: number; @@ -4709,56 +4709,56 @@ declare namespace __esri { interface SpatialReference extends Accessor, JSONSupport { /** * Indicates if the spatial reference refers to a geographic coordinate system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isGeographic) */ readonly isGeographic: boolean; /** * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is one of the following values: `102113`, `102100`, `3857`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWebMercator) */ readonly isWebMercator: boolean; /** * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is `4326`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWGS84) */ readonly isWGS84: boolean; /** * Indicates if the spatial reference of the map supports wrapping around the International Date Line. Value is `true` if the spatial reference is Web Mercator or WGS84. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#isWrappable) */ readonly isWrappable: boolean; /** * The well-known ID of a spatial reference. See [Projected Coordinate Systems](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) and [Geographic Coordinate Systems](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) for the list of supported spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) */ wkid: number; /** * The well-known text that defines a spatial reference. Many browsers have a limit to the length of a GET request of approximately 2048 characters. When using well-known text to specify the spatial reference you can easily exceed this limit. In these cases, you will need to setup and use a proxy page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) */ wkt: string; /** * Returns a deep clone of the spatial reference object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#clone) - * - * + * + * */ clone(): SpatialReference; /** * Checks if the specified spatial reference object has the same [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) or [wkt](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) as this spatial reference object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#equals) - * + * * @param spatialReference The spatial reference to compare to. - * + * */ equals(spatialReference: SpatialReference): boolean; } @@ -4771,13 +4771,13 @@ declare namespace __esri { /** * A convenience spatial reference instance for Web Mercator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#WebMercator) */ WebMercator: SpatialReference; /** * A convenience spatial reference instance for WGS84. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#WGS84) */ WGS84: SpatialReference; @@ -4790,13 +4790,13 @@ declare namespace __esri { interface SpatialReferenceProperties { /** * The well-known ID of a spatial reference. See [Projected Coordinate Systems](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) and [Geographic Coordinate Systems](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) for the list of supported spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) */ wkid?: number; /** * The well-known text that defines a spatial reference. Many browsers have a limit to the length of a GET request of approximately 2048 characters. When using well-known text to specify the spatial reference you can easily exceed this limit. In these cases, you will need to setup and use a proxy page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) */ wkt?: string; @@ -4805,17 +4805,17 @@ declare namespace __esri { interface GeographicTransformation { /** * Geographic transformation steps. Each step represents a geographic transformation that will be used in the process of transforming coordinates from one geographic coordinate system to another. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#steps) */ steps: GeographicTransformationStep[]; /** * Returns the inverse of the geographic transformation calling this method or `null` if the transformation is not invertible. The inverse of a transformation converts coordinates using the same method and parameters, but in the opposite direction of the original object. For example if the original object represents the `NAD_1983_HARN_To_NAD_1983_NSRS2007_1` transformation, then the inverse will transform from `NAD 83 (NSRS 2007)` to `NAD 83 (HARN)`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html#getInverse) - * - * + * + * */ getInverse(): GeographicTransformation; } @@ -4823,7 +4823,7 @@ declare namespace __esri { interface GeographicTransformationConstructor { /** * Projecting your data between coordinate systems sometimes requires transforming between geographic coordinate systems. Geographic transformations are used to transform coordinates between spatial references that have different geographic coordinate systems, and thus different datums. Using the most suitable transformation ensures the best possible accuracy when converting geometries from one spatial reference to another. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformation.html) */ @@ -4836,31 +4836,31 @@ declare namespace __esri { interface GeographicTransformationStep { /** * Indicates with the geographic transformation is inverted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#isInverse) - * + * * @default false */ isInverse: boolean; /** * The well-known id (wkid) hat represents a known geographic transformation. See [Geographic datum transformations](https://developers.arcgis.com/java/10-2/guide/datum-transformations.htm#ESRI_SECTION1_7635FE2A60E6449898D5AD0ADE2CA0C3) for the list of supported equation-based geographic transformations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#wkid) */ wkid: number; /** * The well-known text (wkt) that represents a known geographic transformation. See [Geographic datum transformations](https://developers.arcgis.com/java/10-2/guide/datum-transformations.htm#ESRI_SECTION1_7635FE2A60E6449898D5AD0ADE2CA0C3) for the list of supported equation-based geographic transformations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#wkt) */ wkt: string; /** * Gets the inverse of the geographic transformation step used to call this method or `null` if the transformation step is not invertible. The inverse of a transformation converts coordinates using the same method and parameters, but in the opposite direction of the original object. For example if the original object represents the `NAD_1983_HARN_To_NAD_1983_NSRS2007_1` transformation, then the inverse will transform from `NAD 83 (NSRS 2007)` to `NAD 83 (HARN)`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-GeographicTransformationStep.html#getInverse) - * - * + * + * */ getInverse(): GeographicTransformationStep; } @@ -4877,37 +4877,37 @@ declare namespace __esri { interface ImageMeshColor extends Accessor { /** * A direct reference to the image data. The image data can be an [image element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement), [canvas element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement) or [ImageData](https://developer.mozilla.org/en-US/docs/Web/API/ImageData). The data property is mutually exclusive with the url property, setting the data will clear the url (if there is one). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#data) */ data: HTMLImageElement | HTMLCanvasElement | ImageData; /** * Indicates whether the image data should be interpreted as being semi-transparent. The default value is automatically derived when the data property contains a canvas element or an ImageData object. In all other cases it defaults to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#transparent) - * + * * @default undefined */ transparent: boolean; /** * For ImageMeshColor the type is always `image`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#type) */ readonly type: "image"; /** * The url to the image resource. This can either be a remote url (absolute or relative) or a data url. The url property is mutually exclusive with the data property, setting the url will clear the data (if there is one). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#url) */ url: string; /** * Creates a deep clone. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#clone) - * - * + * + * */ clone(): ImageMeshColor; } @@ -4915,7 +4915,7 @@ declare namespace __esri { interface ImageMeshColorConstructor { /** * ImageMeshColor is a type of mesh color that represents an image mapped to the mesh by its uv vertex attributes. ImageMeshColor instances can be used with the [MeshComponent.material.color](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) property. Images can be referred to either by url or directly by data ( [image element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement), [canvas element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement) or [ImageData](https://developer.mozilla.org/en-US/docs/Web/API/ImageData)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html) */ @@ -4927,21 +4927,21 @@ declare namespace __esri { interface ImageMeshColorProperties { /** * A direct reference to the image data. The image data can be an [image element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement), [canvas element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement) or [ImageData](https://developer.mozilla.org/en-US/docs/Web/API/ImageData). The data property is mutually exclusive with the url property, setting the data will clear the url (if there is one). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#data) */ data?: HTMLImageElement | HTMLCanvasElement | ImageData; /** * Indicates whether the image data should be interpreted as being semi-transparent. The default value is automatically derived when the data property contains a canvas element or an ImageData object. In all other cases it defaults to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#transparent) - * + * * @default undefined */ transparent?: boolean; /** * The url to the image resource. This can either be a remote url (absolute or relative) or a data url. The url property is mutually exclusive with the data property, setting the url will clear the data (if there is one). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html#url) */ url?: string; @@ -4951,20 +4951,20 @@ declare namespace __esri { interface jsonUtils { /** * Creates a new instance of an appropriate [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input `json` parameter often comes from a response to a query operation in the REST API or a [toJSON()](http://pro.arcgis.com/en/pro-app/tool-reference/conversion/features-to-json.htm) method from another ArcGIS product. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for details and examples of when and how to use this function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-jsonUtils.html#fromJSON) - * + * * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. - * + * */ fromJSON(json: any): Geometry; /** * Returns the type for a given geometry in the JSON format used by the ArcGIS platform. This only applies to geometries that can be processed by the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-jsonUtils.html#getJsonType) - * + * * @param geometry The input geometry object. - * + * */ getJsonType(geometry: Geometry): string; } @@ -4974,36 +4974,36 @@ declare namespace __esri { interface MeshComponent extends Accessor { /** * A flat array of indices that refer to vertices in the [vertexAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) of the mesh to which the component belongs. Each triple of indices defines a triangle to render (i.e. the faces array must always have a length that is a multiple of 3). Note that the indices refer to **vertices** and not to the index of the first coordinate of a vertex in the [vertexAttributes.position](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) array. If faces is `null`, then all the vertices in the mesh will be rendered as triangles for this component. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) */ faces: Uint32Array; /** * The material determines how the component is visualized. Materials specify a color that may either be a single color value (a [ValueMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html)) or an image ( an [ImageMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html)), which is mapped to the uv coordinate specified for each vertex in the mesh vertex attributes. The material property supports a number of convenience autocast types, including hex color strings and well known color strings (autocasts to [ValueMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html)), or strings representing urls, HTMLImageElements or HTMLCanvasElements (autocasts to [ImageMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ material: MeshComponentMaterial; /** - * Specifies the type of normals used for lighting. This determines whether the object has a smooth or an angular appearance. The following shading types are supported: - * + * Specifies the type of normals used for lighting. This determines whether the object has a smooth or an angular appearance. The following shading types are supported: + * * | Type | Description | * |------|-------------| * | source | Shading uses the normals as defined in the vertex attributes. If no normals are defined, then shading defaults back to `flat` | * | flat | Shading uses normals created per triangle face. This type of shading is good for objects with sharp edges such as boxes. | * | smooth | Shading uses per-vertex normals that average the normals of all the faces a vertex is a part of. This type of shading is good for meshes that approximate curved surfaces such as spheres. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#shading) */ shading: string; /** * Creates a deep clone. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#clone) - * - * + * + * */ clone(): MeshComponent; } @@ -5011,7 +5011,7 @@ declare namespace __esri { interface MeshComponentConstructor { /** * The MeshComponent class is used to apply one or more materials to a single [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html). The [faces](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) property is a flat array of indices in the mesh [vertexAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) and defines the region of vertices in the mesh on which to apply the material. Each triple of values in the flat array of indices specifies a triangle to be rendered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html) */ @@ -5023,26 +5023,26 @@ declare namespace __esri { interface MeshComponentProperties { /** * A flat array of indices that refer to vertices in the [vertexAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) of the mesh to which the component belongs. Each triple of indices defines a triangle to render (i.e. the faces array must always have a length that is a multiple of 3). Note that the indices refer to **vertices** and not to the index of the first coordinate of a vertex in the [vertexAttributes.position](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#vertexAttributes) array. If faces is `null`, then all the vertices in the mesh will be rendered as triangles for this component. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#faces) */ faces?: Uint32Array | number[] | Uint16Array; /** * The material determines how the component is visualized. Materials specify a color that may either be a single color value (a [ValueMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html)) or an image ( an [ImageMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html)), which is mapped to the uv coordinate specified for each vertex in the mesh vertex attributes. The material property supports a number of convenience autocast types, including hex color strings and well known color strings (autocasts to [ValueMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html)), or strings representing urls, HTMLImageElements or HTMLCanvasElements (autocasts to [ImageMeshColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ImageMeshColor.html)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ material?: MeshComponentMaterialProperties; /** - * Specifies the type of normals used for lighting. This determines whether the object has a smooth or an angular appearance. The following shading types are supported: - * + * Specifies the type of normals used for lighting. This determines whether the object has a smooth or an angular appearance. The following shading types are supported: + * * | Type | Description | * |------|-------------| * | source | Shading uses the normals as defined in the vertex attributes. If no normals are defined, then shading defaults back to `flat` | * | flat | Shading uses normals created per triangle face. This type of shading is good for objects with sharp edges such as boxes. | * | smooth | Shading uses per-vertex normals that average the normals of all the faces a vertex is a part of. This type of shading is good for meshes that approximate curved surfaces such as spheres. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#shading) */ shading?: string; @@ -5052,7 +5052,7 @@ declare namespace __esri { export interface MeshComponentMaterialProperties extends Object { /** * the material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ color?: ValueMeshColorProperties | ImageMeshColorProperties; @@ -5061,7 +5061,7 @@ declare namespace __esri { export interface MeshComponentMaterial extends AnonymousAccessor { /** * the material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) */ color: ValueMeshColor | ImageMeshColor; @@ -5071,36 +5071,36 @@ declare namespace __esri { interface meshUtils { /** * Creates a mesh geometry by sampling elevation data from an elevation service on a regular grid. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) - * + * * @param source The source from which to query the elevation data. * @param extent The extent from which to create the mesh. * @param params Optional parameters. * @param params.material The material. * @param params.demResolution Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See [ElevationLayer.queryElevation](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) for more details on the different settings. - * + * */ createFromElevation(source: ElevationLayer | Ground | ElevationSampler, extent: Extent, params?: meshUtilsCreateFromElevationParams): IPromise; /** * Georeferences vertices specified in a Cartesian coordinate system. This is useful when converting general 3D model meshes not typically georeferenced. This method operates on mesh vertex attributes and will convert positions and normals (if specified) from a local (0, 0, 0) Cartesian system to the properly georeferenced coordinates at the specified `location`. The `location`'s coordinate system determines the units of the converted positions. If the coordinate system is WGS84, metric units are used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#georeference) - * + * * @param vertexAttributes The position and normal buffers to georeference. * @param location The location at which to georeference the position and normal buffers. * @param params Optional parameters. * @param params.geographic Indicates whether to georeference relative to the globe or the projected coordinate system. - * + * */ georeference(vertexAttributes: VertexAttributes, location: Point, params?: meshUtilsGeoreferenceParams): VertexAttributes; /** * Merges multiple meshes into a single mesh. All mesh geometries must be in the same spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#merge) - * + * * @param geometries One or more meshes. - * + * */ merge(geometries: Mesh[]): Mesh; } @@ -5109,19 +5109,19 @@ declare namespace __esri { /** * Represents the position and normal vertex attribute buffers of a mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ export interface VertexAttributes extends Object { /** * The position buffer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ position: Float64Array; /** * The normal buffer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#VertexAttributes) */ normal?: Float32Array; @@ -5131,15 +5131,15 @@ declare namespace __esri { export interface meshUtilsCreateFromElevationParams extends Object { /** * The material. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) */ material?: meshUtilsCreateFromElevationParamsMaterial; /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See [ElevationLayer.queryElevation](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) for more details on the different settings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) - * + * * @default auto */ demResolution?: number | string; @@ -5149,7 +5149,7 @@ declare namespace __esri { export interface meshUtilsCreateFromElevationParamsMaterial extends Object { /** * The material color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#createFromElevation) */ color?: ValueMeshColor | ImageMeshColor | string | HTMLImageElement | HTMLCanvasElement | number[]; @@ -5159,7 +5159,7 @@ declare namespace __esri { export interface meshUtilsGeoreferenceParams extends Object { /** * Indicates whether to georeference relative to the globe or the projected coordinate system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-meshUtils.html#georeference) */ geographic?: boolean; @@ -5169,13 +5169,13 @@ declare namespace __esri { interface normalizeUtils { /** * Normalizes geometries that intersect the central meridian or fall outside the world extent so they stay within the coordinate system of the view. Only supported for Web Mercator and WGS84 spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-normalizeUtils.html#normalizeCentralMeridian) - * + * * @param geometries An array of geometries to normalize. * @param geometryService A geometry service used to perform the normalization. If this value is `null` then the default geometry service in [esriConfig.geometryServiceUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#geometryServiceUrl) is used. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request. - * + * */ normalizeCentralMeridian(geometries: Geometry[], geometryService?: GeometryService, requestOptions?: any): IPromise; } @@ -5185,23 +5185,23 @@ declare namespace __esri { interface ValueMeshColor extends Accessor { /** * For ValueMeshColor the type is always `value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html#type) */ readonly type: "value"; /** * The color value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html#value) */ value: Color; /** * Creates a deep clone. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html#clone) - * - * + * + * */ clone(): ValueMeshColor; } @@ -5209,7 +5209,7 @@ declare namespace __esri { interface ValueMeshColorConstructor { /** * ValueMeshColor is a type of mesh color that represents a single uniform color to be applied to a mesh component. ValueMeshColor instances can be used with the [MeshComponent.material.color](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshComponent.html#material) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html) */ @@ -5221,7 +5221,7 @@ declare namespace __esri { interface ValueMeshColorProperties { /** * The color value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-ValueMeshColor.html#value) */ value?: Color | number[] | string; @@ -5231,60 +5231,60 @@ declare namespace __esri { interface webMercatorUtils { /** * Returns `true` if the `source` spatial reference can be projected to the `target` spatial reference with the [project()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#project) function, or if the `source` and `target` are the same [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#canProject) - * + * * @param source The input [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) or an object with `spatialReference` property such as [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) or [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). * @param target The target [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) or an object with `spatialReference` property such as [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) or [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). - * + * */ canProject(source: SpatialReference | any, target: SpatialReference | any): boolean; /** * Converts a geometry from geographic units (wkid: 4326) to Web Mercator units (wkid: 3857). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#geographicToWebMercator) - * + * * @param geometry The input geometry to convert. - * + * */ geographicToWebMercator(geometry: Geometry): Geometry; /** * Translates the given latitude and longitude (decimal degree) values to Web Mercator XY values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#lngLatToXY) - * + * * @param long The longitude value to convert. * @param lat The latitude value to convert. - * + * */ lngLatToXY(long: number, lat: number): number[]; /** * Projects the geometry clientside (if possible). You should test the input geometry in [canProject()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#canProject) prior to using this function. If the result of [canProject()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#canProject) is `true`, then proceed to project. If [canProject()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#canProject) returns `false`, then `project()` won't return useful results. Use [GeometryService.project()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#project) instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#project) - * + * * @param geometry The input geometry. * @param spatialReference The target [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) or an object with `spatialReference` property such as [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) or [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). - * + * */ project(geometry: Geometry, spatialReference: SpatialReference | any): Geometry; /** * Converts a geometry from Web Mercator units (wkid: 3857) to geographic units (wkid: 4326). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#webMercatorToGeographic) - * + * * @param geometry The input geometry to convert. - * + * */ webMercatorToGeographic(geometry: Geometry): Geometry; /** * Translates the given Web Mercator coordinates to Longitude and Latitude values (decimal degrees). By default the returned longitude is normalized so that it is within -180 and +180. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-webMercatorUtils.html#xyToLngLat) - * + * * @param x The X coordinate value to convert. * @param y The Y coordinate value to convert. - * + * */ xyToLngLat(x: number, y: number): number[]; } @@ -5294,77 +5294,77 @@ declare namespace __esri { interface Graphic extends Accessor, JSONSupport { /** * Name-value pairs of fields and field values associated with the graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) */ attributes: any; /** - * The geometry that defines the graphic's location. + * The geometry that defines the graphic's location. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry) */ geometry: Geometry; /** * If applicable, references the layer in which the graphic is stored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer) */ layer: Layer; /** * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected. The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) may be used to access a graphic's [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) and display their values in the view's default popup. See the documentation for [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for details on how to display attribute values in the popup. As of 4.8 to get the actual `popupTemplate` of the graphic, see the [getEffectivePopupTemplate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getEffectivePopupTemplate) method that either returns this value or the `popupTemplate` of the graphic's layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the graphic. Choosing a symbol for a graphic depends on the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) type (SceneView or MapView), and the [geometry type](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type) of the graphic. Each graphic may have its own symbol specified when the parent layer is a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html). For a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) the symbol of each graphic should not be set by the developer since the graphics' rendering properties are determined by the layer's [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) */ symbol: Symbol; /** * Indicates the visibility of the graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#visible) - * + * * @default true */ visible: boolean; /** * Creates a deep clone of the graphic object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#clone) - * - * + * + * */ clone(): Graphic; /** * Returns the value of the specified attribute. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getAttribute) - * + * * @param name The name of the attribute. - * + * */ getAttribute(name: string): any; /** * Returns the popup template applicable for the graphic. It's either the value of [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#popupTemplate) or the `popupTemplate` from the graphic's layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getEffectivePopupTemplate) - * - * + * + * */ getEffectivePopupTemplate(): PopupTemplate; /** * Sets a new value to the specified attribute. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#setAttribute) - * + * * @param name The name of the attribute to set. * @param newValue The new value to set on the named attribute. - * + * */ setAttribute(name: string, newValue: any): void; } @@ -5372,7 +5372,7 @@ declare namespace __esri { interface GraphicConstructor { /** * A Graphic is a vector representation of real world geographic phenomena. It can contain [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry), a [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol), and [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes). A Graphic is displayed in the [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) */ @@ -5386,40 +5386,40 @@ declare namespace __esri { interface GraphicProperties { /** * Name-value pairs of fields and field values associated with the graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) */ attributes?: any; /** - * The geometry that defines the graphic's location. + * The geometry that defines the graphic's location. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry) */ geometry?: GeometryProperties; /** * If applicable, references the layer in which the graphic is stored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer) */ layer?: LayerProperties; /** * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected. The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) may be used to access a graphic's [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) and display their values in the view's default popup. See the documentation for [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for details on how to display attribute values in the popup. As of 4.8 to get the actual `popupTemplate` of the graphic, see the [getEffectivePopupTemplate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#getEffectivePopupTemplate) method that either returns this value or the `popupTemplate` of the graphic's layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the graphic. Choosing a symbol for a graphic depends on the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) type (SceneView or MapView), and the [geometry type](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type) of the graphic. Each graphic may have its own symbol specified when the parent layer is a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html). For a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) the symbol of each graphic should not be set by the developer since the graphics' rendering properties are determined by the layer's [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) */ symbol?: SymbolProperties; /** * Indicates the visibility of the graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#visible) - * + * * @default true */ visible?: boolean; @@ -5428,78 +5428,78 @@ declare namespace __esri { interface Ground extends Accessor, Loadable, JSONSupport { /** * A collection of [ElevationLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) that define the elevation or terrain that makes up the ground surface. When elevation layers are added to the ground, the topographical variations of the surface are rendered in 3D as they would appear in the real world. ![elev-default](https://developers.arcgis.com/javascript/assets/img/apiref/ground/elev-default.png) When the layers collection is empty, the ground surface is flat. ![no-elev](https://developers.arcgis.com/javascript/assets/img/apiref/ground/no-elev.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) */ layers: Collection; /** * Indicates whether the instance has loaded. When `true`, the properties of the object can be accessed. A Ground is considered loaded when its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) are fully created, but not yet loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * Specifies the user navigation constraints relative to the ground surface. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ navigationConstraint: GroundNavigationConstraint; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). This property can be used for a see-through ground effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) - * + * * @default 1 */ opacity: number; /** * The color of the ground surface, displayed underneath the basemap. If this is null, a grid is displayed instead. The alpha value in the color is ignored. Use the [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) property to control the opacity of the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#surfaceColor) - * + * * @default null */ surfaceColor: Color; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#clone) - * - * + * + * */ clone(): Ground; /** * Creates an elevation sampler for the given extent by querying the ground layers for elevation data and caching it so values may be sampled quickly afterwards. The sampler uses the elevation data from the first layer that has data available. For getting elevation data from a specific layer use [ElevationLayer.createElevationSampler()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) - * + * * @param extent The extent for which to create the sampler. * @param options Additional sampler options. * @param options.noDataValue The value to use when there is no data available. - * + * */ createElevationSampler(extent: Extent, options?: GroundCreateElevationSamplerOptions): IPromise; /** * Loads all the externally loadable resources associated with the ground. For the ground this will load all the layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#loadAll) - * - * + * + * */ loadAll(): IPromise; /** * Queries the ground layer services for elevation values for the given geometry. The returned result contains a copy of the geometry with z-values sampled from elevation data from the first layer that has data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) - * + * * @param geometry The geometry to sample. * @param options Additional query options. * @param options.returnSampleInfo Indicates whether to return additional sample information for each sampled coordinate. * @param options.noDataValue The value that appears in the resulting geometry when there is no data available. - * + * */ queryElevation(geometry: Point | Multipoint | Polyline, options?: GroundQueryElevationOptions): IPromise; } @@ -5507,7 +5507,7 @@ declare namespace __esri { interface GroundConstructor { /** * The Ground class contains properties that specify how the ground surface is displayed in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It contains a [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) property, which is a collection of [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) that defines the elevation or terrain of the map's surface. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) */ @@ -5521,29 +5521,29 @@ declare namespace __esri { interface GroundProperties extends LoadableProperties { /** * A collection of [ElevationLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) that define the elevation or terrain that makes up the ground surface. When elevation layers are added to the ground, the topographical variations of the surface are rendered in 3D as they would appear in the real world. ![elev-default](https://developers.arcgis.com/javascript/assets/img/apiref/ground/elev-default.png) When the layers collection is empty, the ground surface is flat. ![no-elev](https://developers.arcgis.com/javascript/assets/img/apiref/ground/no-elev.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) */ layers?: CollectionProperties; /** * Specifies the user navigation constraints relative to the ground surface. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ navigationConstraint?: GroundNavigationConstraintProperties; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). This property can be used for a see-through ground effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) - * + * * @default 1 */ opacity?: number; /** * The color of the ground surface, displayed underneath the basemap. If this is null, a grid is displayed instead. The alpha value in the color is ignored. Use the [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#opacity) property to control the opacity of the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#surfaceColor) - * + * * @default null */ surfaceColor?: Color | number[] | string; @@ -5551,25 +5551,25 @@ declare namespace __esri { /** * Object returned when [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) promise resolves: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ export interface ElevationQueryResult extends Object { /** * The geometry with sampled z-values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ geometry: Point | Multipoint | Polyline; /** * Contains additional information about how the geometry was sampled. This property is present depending on whether the user set `options.returnSampleInfo = true`, for each coordinate in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ sampleInfo?: ElevationQueryResultSampleInfo[]; /** * The value used when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ noDataValue: number; @@ -5579,9 +5579,9 @@ declare namespace __esri { export interface GroundCreateElevationSamplerOptions extends Object { /** * The value to use when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) - * + * * @default 0 */ noDataValue?: number; @@ -5590,15 +5590,15 @@ declare namespace __esri { export interface GroundNavigationConstraintProperties extends Object { /** - * The type of the constraint. It can be one of the following: - * + * The type of the constraint. It can be one of the following: + * * Value | Description * -----------|-------------------- * stay-above | User can only navigate above ground surface * none | User can navigate above and below the ground surface - * + * * Default value: stay-above - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ type?: string; @@ -5606,15 +5606,15 @@ declare namespace __esri { export interface GroundNavigationConstraint extends AnonymousAccessor { /** - * The type of the constraint. It can be one of the following: - * + * The type of the constraint. It can be one of the following: + * * Value | Description * -----------|-------------------- * stay-above | User can only navigate above ground surface * none | User can navigate above and below the ground surface - * + * * Default value: stay-above - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) */ type: string; @@ -5624,17 +5624,17 @@ declare namespace __esri { export interface GroundQueryElevationOptions extends Object { /** * Indicates whether to return additional sample information for each sampled coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) - * + * * @default false */ returnSampleInfo?: boolean; /** * The value that appears in the resulting geometry when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) - * + * * @default 0 */ noDataValue?: number; @@ -5644,13 +5644,13 @@ declare namespace __esri { export interface ElevationQueryResultSampleInfo extends Object { /** * The resolution at which the z-value was sampled. If no data was available for sampling for a given coordinate, the dem resolution value will be -1 for that coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ demResolution: number; /** * The elevation source from which the data for the corresponding coordinate was sampled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#ElevationQueryResult) */ source: ElevationLayer; @@ -5659,61 +5659,61 @@ declare namespace __esri { interface Credential extends Accessor { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#expires) */ expires: number; /** * Indicates whether this credential belongs to a user with admin privileges. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#isAdmin) */ isAdmin: boolean; /** * The Identity Manager's [setOAuthRedirectionHandler](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) returns an object that contains a `state` property. This information is returned for this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#oAuthState) */ oAuthState: any; /** * The server url. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#server) */ server: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#ssl) */ ssl: boolean; /** * Token generated by the token service using the specified userId and password. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) */ token: string; /** * User associated with the Credential object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#userId) */ userId: string; /** * Destroys the credential. When the credential is destroyed, you should remove any map layers that are using this credential. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#destroy) - * - * + * + * */ destroy(): void; /** * Generates a new token and updates the Credential's [token](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) property with the newly acquired token. Tokens are typically kept valid using a timer that automatically triggers a refresh before the token expires. Use this method in cases where the timer has been delayed or stopped. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#refreshToken) - * - * + * + * */ refreshToken(): void; } @@ -5729,43 +5729,43 @@ declare namespace __esri { interface CredentialProperties { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#expires) */ expires?: number; /** * Indicates whether this credential belongs to a user with admin privileges. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#isAdmin) */ isAdmin?: boolean; /** * The Identity Manager's [setOAuthRedirectionHandler](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) returns an object that contains a `state` property. This information is returned for this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#oAuthState) */ oAuthState?: any; /** * The server url. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#server) */ server?: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#ssl) */ ssl?: boolean; /** * Token generated by the token service using the specified userId and password. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#token) */ token?: string; /** * User associated with the Credential object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html#userId) */ userId?: string; @@ -5774,27 +5774,27 @@ declare namespace __esri { interface IdentityManager extends IdentityManagerBase { /** * Dialog box widget used to challenge the user for their credentials when the application attempts to access a secure resource. This property is available after the dialog-create event has fired. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#dialog) */ dialog: any; /** * Once a user successfully logs in, they are redirected back to the application. Use this method if the application needs to execute custom logic before the page is redirected. The IdentityManager calls the custom handler function with an object containing redirection properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthRedirectionHandler) - * + * * @param handlerFunction When called, the callback passed to `setOAuthRedirectionHandler` receives an object containing the redirection properties. - * + * */ setOAuthRedirectionHandler(handlerFunction: HandlerCallback): void; /** * Use this method in the popup callback page to pass the token and other values back to the IdentityManager. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#setOAuthResponseHash) - * + * * @param hash The token information in addition to any other values needed to be passed back to the IdentityManager. - * + * */ setOAuthResponseHash(hash: string): void; @@ -5807,7 +5807,7 @@ declare namespace __esri { interface IdentityManagerConstructor { /** * This object provides the framework and helper methods used in managing user credentials for the following resources: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html) */ @@ -5829,116 +5829,116 @@ declare namespace __esri { interface IdentityManagerBase extends Evented { /** * The suggested lifetime of the token in minutes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#tokenValidity) - * + * * @default 60 */ tokenValidity: number; /** * If your application is on the same domain as *.arcgis.com or ArcGIS Enterprise Server, the IdentityManager will redirect the user to its sign-in page. For instance, let's say an application accesses secure resources from ArcGIS.com or one of its subdomains. Once the application attempts to access this resource, the IdentityManager redirects the user to the ArcGIS.com sign-in page. Once a user successfully logs in, they are redirected back to the application. The same holds true if the application accesses secure resources from ArcGIS Enterprise as the IdentityManager will redirect the user to its sign-in page. If you do not wish for the application to automatically redirect, set this property to `false`. (Please note that this is not a common scenario. For most, using the OAuth sign-in behavior should handle most of their authentication needs.) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#useSignInPage) - * + * * @default true */ useSignInPage: boolean; /** * Returns the [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) if the user has already signed in to access the given resource. If the user has not signed in, then the promise will be rejected and its error callback will be called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#checkSignInStatus) - * + * * @param resUrl The resource URL. - * + * */ checkSignInStatus(resUrl: string): IPromise; /** * Destroys all credentials. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#destroyCredentials) - * - * + * + * */ destroyCredentials(): void; /** * Returns the [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) for the resource identified by the specified url. Optionally, you can provide a userId to find credentials for a specific user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#findCredential) - * + * * @param url The URL to a server. * @param userId The userId for which you want to obtain credentials. - * + * */ findCredential(url: string, userId?: string): Credential; /** * Returns the [OAuthInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html) configuration for the passed in Portal server URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#findOAuthInfo) - * + * * @param url The URL to a Portal. - * + * */ findOAuthInfo(url: string): OAuthInfo; /** * Returns information about the server that is hosting the specified URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#findServerInfo) - * + * * @param url The URL to the server - * + * */ findServerInfo(url: string): ServerInfo; /** * Returns an object containing a token and its expiration time. It is necessary to provide the [ServerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html) object that contains a token service URL and a user info object containing username and password. This is a helper method typically called by sub-classes to generate tokens. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#generateToken) - * + * * @param serverInfo A ServerInfo object that contains a token service URL. * @param userInfo A user info object containing a user name and password. * @param options See the table below for the structure of this object. * @param options.serverUrl The server URL. * @param options.token The server token. * @param options.ssl Indicates if the server requires SSL. - * + * */ generateToken(serverInfo: ServerInfo, userInfo: any, options?: IdentityManagerBaseGenerateTokenOptions): IPromise; /** * Returns a [Credential](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-Credential.html) object that can be used to access the secured resource identified by the input URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#getCredential) - * + * * @param url The URL for the secure resource * @param options See the table below for the structure of the **options** object. * @param options.error Error object returned by the server from a previous attempt to fetch the given URL. * @param options.oAuthPopupConfirmation If set to *false*, the user will not be shown a dialog before the OAuth popup window is opened. * @param options.retry Determines if the method should make additional attempts to get the credentials after a failure. * @param options.token Token used for a previous unsuccessful attempt to fetch the given URL. - * + * */ getCredential(url: string, options?: IdentityManagerBaseGetCredentialOptions): IPromise; /** * Call this method during application initialization with the JSON previously obtained from the [toJSON()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#toJSON) method used to re-hydrate the state of IdentityManager. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#initialize) - * + * * @param json The JSON obtained from the [toJSON()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#toJSON) method. - * + * */ initialize(json: any): void; /** * Indicates if the IdentityManager is busy accepting user input. For example, it returns `true` if the user has invoked [signIn](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#signIn) and is waiting for a response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#isBusy) - * - * + * + * */ isBusy(): boolean; /** * Subclasses must implement this method if OAuth support is required. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#oAuthSignIn) - * + * * @param resUrl The resource URL. * @param serverInfo A ServerInfo object that contains the token service URL. * @param oAuthInfo An OAuthInfo object that contains the authorization configuration. @@ -5946,87 +5946,87 @@ declare namespace __esri { * @param options.error Error object returned by the server from a previous attempt to fetch the given URL. * @param options.oAuthPopupConfirmation Indicates whether the user will be shown a dialog before the OAuth popup window is opened. * @param options.token Token used for previous unsuccessful attempts to fetch the given URL. - * + * */ oAuthSignIn(resUrl: string, serverInfo: ServerInfo, oAuthInfo: OAuthInfo, options?: IdentityManagerBaseOAuthSignInOptions): IPromise; /** * Registers OAuth 2.0 configurations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#registerOAuthInfos) - * + * * @param oAuthInfos An array of OAuthInfo objects that defines the OAuth configurations. - * + * */ registerOAuthInfos(oAuthInfos: OAuthInfo[]): void; /** * Register secure servers and the token endpoints. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#registerServers) - * + * * @param serverInfos An array of ServerInfos objects that defines the secure service and token endpoint. The IdentityManager makes its best guess to determine the location of the secure server and token endpoint. Therefore, in most cases calling this method is not necessary. However, if the location of your server or token endpoint is not standard, use this method to register the location. - * + * */ registerServers(serverInfos: ServerInfo[]): void; /** * Registers the given OAuth 2.0 access token or ArcGIS Server token with the IdentityManager. See [registerOAuthInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#registerOAuthInfos) for additional information. The `registerToken` method is an advanced workflow for pre-registering long-term tokens for when you don't want users to sign in. See also [resource-proxy](https://github.com/Esri/resource-proxy) for another workflow to achieve this result. Once a user logs in, the access token is registered with the IdentityManager. Subsequently, every AJAX request made by the application forwards this token when accessing web maps and other items stored in ArcGIS Online, or resources on your server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#registerToken) - * + * * @param properties See the table below for the structure of the **properties** object. * @param properties.expires Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. * @param properties.server For ArcGIS Online or Portal, this is https://www.arcgis.com/sharing/rest or similar to https://www.example.com/portal/sharing/rest. For ArcGIS Server this is similar to https://www.example.com/arcgis/rest/services. * @param properties.ssl Set this to `true` if the user has an ArcGIS Online organizational account and the organization is configured to allow access to resources only through SSL. * @param properties.token The access token. * @param properties.userId The id of the user who owns the access token. - * + * */ registerToken(properties: IdentityManagerBaseRegisterTokenProperties): void; /** * When accessing secured resources, the IdentityManager may prompt for username and password and send them to the server using a secure connection. Due to potential browser limitations, it may not be possible to establish a secure connection with the server if the application is being run over HTTP protocol. In such cases, the Identity Manager will abort the request to fetch the secured resource. To resolve this issue, configure your web application server with HTTPS support and run the application over HTTPS. This is the recommended solution for production environments. However, for internal development environments that don't have HTTPS support, you can define a protocol error handler that allows the Identity Manager to continue with the process over HTTP protocol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setProtocolErrorHandler) - * + * * @param handlerFunction The function to call when the protocol is mismatched. * @param handlerFunction.resourceUrl The secure resource URL. * @param handlerFunction.serverInfo ServerInfo object describing the server where the secure resource is hosted. - * + * */ setProtocolErrorHandler(handlerFunction: IdentityManagerBaseSetProtocolErrorHandlerHandlerFunction): void; /** * If your application is on the same domain as *.arcgis.com or ArcGIS Enterprise Server, the IdentityManager will redirect the user to its sign-in page. For instance, let's say an application accesses secure resources from ArcGIS.com or one of its subdomains. Once the application attempts to access this resource, the IdentityManager redirects the user to the ArcGIS.com sign-in page. Once a user successfully logs in, they are redirected back to the application. The same holds true if the application accesses secure resources from ArcGIS Enterprise as the IdentityManager will redirect the user to its sign-in page. Use this method if the application needs to execute custom logic before the page is redirected by creating a custom redirection handler. The IdentityManager calls the custom handler function with an object containing the redirection properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setRedirectionHandler) - * + * * @param handlerFunction The function passed to setRedirectionHandler receives an object containing redirection properties. These properties are listed in the table below. * @param handlerFunction.resourceUrl The URL of the secure resource that triggers the redirection to the ArcGIS.com sign-in page. * @param handlerFunction.returnUrlParamName The application URL where the sign-in page redirects after a successful login. To create the return URL, append the application's URL to signInPage as a parameter. The *returnUrlParamName* contains the name of the parameter. * @param handlerFunction.serverInfo The ServerInfo object describing the server where the secure resource is hosted. * @param handlerFunction.signInPage URL of the sign-in page where users will be redirected. - * + * */ setRedirectionHandler(handlerFunction: IdentityManagerBaseSetRedirectionHandlerHandlerFunction): void; /** * Subclasses must implement this method to create and manage the user interface used to obtain a username and password from the end user. It should perform the following tasks: * * challenge the user for a username and password, * * generate a token and return it to the caller. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#signIn) - * + * * @param url URL for the secured resource. * @param serverInfo A ServerInfo object that contains the token service URL. * @param options See the table below for the structure of the **options** object. * @param options.error Error object returned by the server from a previous attempt to fetch the given URL. - * + * */ signIn(url: string, serverInfo: ServerInfo, options?: IdentityManagerBaseSignInOptions): IPromise; /** * Return properties of this object in JSON format. It can be stored in a cookie or persisted in HTML5 LocalStorage and later used to: * * Initialize the IdentityManager the next time a user opens your application. * * Share the state of the IdentityManager between multiple web pages of your website. This way users will not be asked to sign in repeatedly when they launch your app multiple times or when navigating between multiple web pages in your website. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -6034,7 +6034,7 @@ declare namespace __esri { interface IdentityManagerBaseConstructor { /** * This class provides the framework and helper methods required to implement a solution for managing user credentials. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html) */ @@ -6047,19 +6047,19 @@ declare namespace __esri { export interface IdentityManagerBaseGenerateTokenOptions extends Object { /** * The server URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#generateToken) */ serverUrl: string; /** * The server token. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#generateToken) */ token: string; /** * Indicates if the server requires SSL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#generateToken) */ ssl: boolean; @@ -6069,27 +6069,27 @@ declare namespace __esri { export interface IdentityManagerBaseGetCredentialOptions extends Object { /** * Error object returned by the server from a previous attempt to fetch the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#getCredential) */ error?: Error; /** * If set to *false*, the user will not be shown a dialog before the OAuth popup window is opened. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#getCredential) - * + * * @default true */ oAuthPopupConfirmation?: boolean; /** * Determines if the method should make additional attempts to get the credentials after a failure. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#getCredential) */ retry?: boolean; /** * Token used for a previous unsuccessful attempt to fetch the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#getCredential) */ token?: string; @@ -6099,21 +6099,21 @@ declare namespace __esri { export interface IdentityManagerBaseOAuthSignInOptions extends Object { /** * Error object returned by the server from a previous attempt to fetch the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#oAuthSignIn) */ error?: Error; /** * Indicates whether the user will be shown a dialog before the OAuth popup window is opened. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#oAuthSignIn) - * + * * @default true */ oAuthPopupConfirmation?: boolean; /** * Token used for previous unsuccessful attempts to fetch the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#oAuthSignIn) */ token?: string; @@ -6123,31 +6123,31 @@ declare namespace __esri { export interface IdentityManagerBaseRegisterTokenProperties extends Object { /** * Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. - * + * * [Read more...](properties.html) */ expires?: number; /** * For ArcGIS Online or Portal, this is https://www.arcgis.com/sharing/rest or similar to https://www.example.com/portal/sharing/rest. For ArcGIS Server this is similar to https://www.example.com/arcgis/rest/services. - * + * * [Read more...](properties.html) */ server: string; /** * Set this to `true` if the user has an ArcGIS Online organizational account and the organization is configured to allow access to resources only through SSL. - * + * * [Read more...](properties.html) */ ssl?: boolean; /** * The access token. - * + * * [Read more...](properties.html) */ token: string; /** * The id of the user who owns the access token. - * + * * [Read more...](properties.html) */ userId?: string; @@ -6157,13 +6157,13 @@ declare namespace __esri { export interface IdentityManagerBaseSetProtocolErrorHandlerHandlerFunction extends Object { /** * The secure resource URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setProtocolErrorHandler) */ resourceUrl: string; /** * ServerInfo object describing the server where the secure resource is hosted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setProtocolErrorHandler) */ serverInfo: ServerInfo; @@ -6173,25 +6173,25 @@ declare namespace __esri { export interface IdentityManagerBaseSetRedirectionHandlerHandlerFunction extends Object { /** * The URL of the secure resource that triggers the redirection to the ArcGIS.com sign-in page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setRedirectionHandler) */ resourceUrl: string; /** * The application URL where the sign-in page redirects after a successful login. To create the return URL, append the application's URL to signInPage as a parameter. The *returnUrlParamName* contains the name of the parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setRedirectionHandler) */ returnUrlParamName: string; /** * The ServerInfo object describing the server where the secure resource is hosted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setRedirectionHandler) */ serverInfo: ServerInfo; /** * URL of the sign-in page where users will be redirected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#setRedirectionHandler) */ signInPage: string; @@ -6201,7 +6201,7 @@ declare namespace __esri { export interface IdentityManagerBaseSignInOptions extends Object { /** * Error object returned by the server from a previous attempt to fetch the given URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManagerBase.html#signIn) */ error: Error; @@ -6210,81 +6210,81 @@ declare namespace __esri { interface OAuthInfo extends Accessor, JSONSupport { /** * The registered application id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#appId) */ appId: string; /** * Applications with the same value will share the stored token on the same host. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#authNamespace) - * + * * @default / (forward slash) */ authNamespace: string; /** * The number of minutes that the token is valid. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#expiration) - * + * * @default 20160 (two weeks) */ expiration: number; /** * The locale for the OAuth sign in page. The default locale is based on your browser/OS and the organization locale. You can use the locale property to change this. The locale needs to follow the language dash country code syntax supported by ArcGIS.com. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#locale) - * + * * @default Based on your browser/OS and the organization locale. */ locale: string; /** * The minimum time in minutes before a saved token is due to expire that it should still be considered valid for use. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#minTimeUntilExpiration) - * + * * @default 30 */ minTimeUntilExpiration: number; /** * Set to `true` to show the OAuth sign in page in a popup window. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) - * + * * @default false */ popup: boolean; /** * Applicable if working with the popup user-login workflow. This is a relative page URL that redirects the user back to the secured application after successful login. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupCallbackUrl) - * + * * @default "oauth-callback.html" */ popupCallbackUrl: string; /** * The window features passed to [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupWindowFeatures) - * + * * @default height=490,width=800,resizable,scrollbars,status */ popupWindowFeatures: string; /** * The ArcGIS Enterprise portal URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#portalUrl) - * + * * @default "https://www.arcgis.com" */ portalUrl: string; /** * Creates a copy of the OAuthInfo object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#clone) - * - * + * + * */ clone(): OAuthInfo; } @@ -6302,71 +6302,71 @@ declare namespace __esri { interface OAuthInfoProperties { /** * The registered application id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#appId) */ appId?: string; /** * Applications with the same value will share the stored token on the same host. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#authNamespace) - * + * * @default / (forward slash) */ authNamespace?: string; /** * The number of minutes that the token is valid. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#expiration) - * + * * @default 20160 (two weeks) */ expiration?: number; /** * The locale for the OAuth sign in page. The default locale is based on your browser/OS and the organization locale. You can use the locale property to change this. The locale needs to follow the language dash country code syntax supported by ArcGIS.com. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#locale) - * + * * @default Based on your browser/OS and the organization locale. */ locale?: string; /** * The minimum time in minutes before a saved token is due to expire that it should still be considered valid for use. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#minTimeUntilExpiration) - * + * * @default 30 */ minTimeUntilExpiration?: number; /** * Set to `true` to show the OAuth sign in page in a popup window. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popup) - * + * * @default false */ popup?: boolean; /** * Applicable if working with the popup user-login workflow. This is a relative page URL that redirects the user back to the secured application after successful login. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupCallbackUrl) - * + * * @default "oauth-callback.html" */ popupCallbackUrl?: string; /** * The window features passed to [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#popupWindowFeatures) - * + * * @default height=490,width=800,resizable,scrollbars,status */ popupWindowFeatures?: string; /** * The ArcGIS Enterprise portal URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-OAuthInfo.html#portalUrl) - * + * * @default "https://www.arcgis.com" */ portalUrl?: string; @@ -6375,31 +6375,31 @@ declare namespace __esri { interface ServerInfo extends Accessor, JSONSupport { /** * The token service URL used to generate tokens for ArcGIS Server Admin resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#adminTokenServiceUrl) */ adminTokenServiceUrl: string; /** * Version of the ArcGIS Server deployed on this server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#currentVersion) */ currentVersion: number; /** * The server URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) */ server: string; /** * Validity of short-lived token in minutes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#shortLivedTokenValidity) */ shortLivedTokenValidity: number; /** * The token service URL used to generate tokens for the secured resources on the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#tokenServiceUrl) */ tokenServiceUrl: string; @@ -6418,31 +6418,31 @@ declare namespace __esri { interface ServerInfoProperties { /** * The token service URL used to generate tokens for ArcGIS Server Admin resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#adminTokenServiceUrl) */ adminTokenServiceUrl?: string; /** * Version of the ArcGIS Server deployed on this server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#currentVersion) */ currentVersion?: number; /** * The server URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#server) */ server?: string; /** * Validity of short-lived token in minutes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#shortLivedTokenValidity) */ shortLivedTokenValidity?: number; /** * The token service URL used to generate tokens for the secured resources on the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-ServerInfo.html#tokenServiceUrl) */ tokenServiceUrl?: string; @@ -6451,7 +6451,7 @@ declare namespace __esri { interface kernel { /** - * Current version of the ArcGIS API for JavaScript. + * Current version of the ArcGIS API for JavaScript. * ```js * require([ * "esri/kernel" @@ -6459,7 +6459,7 @@ declare namespace __esri { * console.log(esriNS.version); * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-kernel.html#version) */ readonly version: string; @@ -6470,33 +6470,33 @@ declare namespace __esri { interface BaseDynamicLayer extends Layer, ScaleRangeLayer, RefreshableLayer { /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) chain. This is typically used in the [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#load) method to ensure that all [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) resources required for the layer to function are loaded prior to this layer resolving and becoming [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#addResolvingPromise) - * + * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` [status](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#loadStatus) to being [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#loaded). - * + * */ addResolvingPromise(promiseToLoad: IPromise): IPromise; /** * This method fetches the image for the specified extent and size. Override this method if the data returned from the server needs to be processed before it can be displayed. For example, if the server returns binary data, override this method to convert the binary data to an image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#fetchImage) - * + * * @param extent The extent of the view. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param width The width of the view in pixels. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param height The height of the view in pixels. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). - * + * */ fetchImage(extent: Extent, width: number, height: number): IPromise; /** * This method returns a URL to an image for a given extent, width, and height. Override this method to construct the URL for the image based on user interaction. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html#getImageUrl) - * + * * @param extent Extent of the view. This value is populated by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param width Width of the view in pixels. This value is populated by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param height Height of the view in pixels. This value is populated by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). - * + * */ getImageUrl(extent: Extent, width: number, height: number): IPromise | string; @@ -6509,7 +6509,7 @@ declare namespace __esri { interface BaseDynamicLayerConstructor { /** * This class may be extended to create dynamic map layers. Dynamic layers display an image dynamically generated on the server based on a request, including the extent and size of the image. The exported image covers the entire view extent. Each interaction on the view (e.g. panning, zooming) will result in an export of a new image on the server. Each export is unique so it cannot be cached in the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseDynamicLayer.html) */ @@ -6539,53 +6539,53 @@ declare namespace __esri { interface BaseElevationLayer extends Layer { /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#spatialReference) - * + * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} */ spatialReference: SpatialReference; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#tileInfo) */ tileInfo: TileInfo; /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) chain. This is typically used in the [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#load) method to ensure that all [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) resources required for the layer to function are loaded prior to this layer resolving and becoming [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#addResolvingPromise) - * + * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` [status](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#loadStatus) to being [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#loaded). - * + * */ addResolvingPromise(promiseToLoad: IPromise): IPromise; /** - * Fetches a tile at the given level, row, and column present in the view. This method must be overwritten to display custom elevation values in the [Map.ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground). Note that this method must return a promise that resolves to an object with the properties defined in [ElevationTileData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData). See the following samples for examples of how to overwrite this method: + * Fetches a tile at the given level, row, and column present in the view. This method must be overwritten to display custom elevation values in the [Map.ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground). Note that this method must return a promise that resolves to an object with the properties defined in [ElevationTileData](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData). See the following samples for examples of how to overwrite this method: * * [Sample - Custom ElevationLayer: Exaggerating elevation](https://developers.arcgis.com/javascript/latest/sample-code/layers-custom-elevation-exaggerated/index.html) * * [Sample - Custom ElevationLayer: Thematic data as elevation](https://developers.arcgis.com/javascript/latest/sample-code/layers-custom-elevation-thematic/index.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) - * + * * @param level The level of detail of the tile to fetch. * @param row The row (y) position of the tile to fetch. * @param column The column (x) position of the tile to fetch. * @param options Optional settings for the tile request. * @param options.noDataValue The value representing pixels in the tile that don't contain an elevation value. - * + * */ fetchTile(level: number, row: number, column: number, options?: BaseElevationLayerFetchTileOptions): IPromise; /** * Returns the bounds of the tile as an array of four numbers that can be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. See the table in the `returns` section below for more details about the values returned by this method. This function can be used inside [fetchTile()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) so you can get the bounds of the current tile, convert it to an extent object, and request the desired data for the given extent. See the [Custom ElevationLayer: Thematic data as elevation](https://developers.arcgis.com/javascript/latest/sample-code/layers-custom-elevation-thematic/index.html) sample for an example of how this method works. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#getTileBounds) - * + * * @param level The level of detail (LOD) of the tile. * @param row The tile's row (y) position in the dataset. * @param column The tiles column (x) position in the dataset. * @param out Array for storing the tile bounds or extent. - * + * */ getTileBounds(level: number, row: number, column: number, out?: number[]): number[]; @@ -6598,7 +6598,7 @@ declare namespace __esri { interface BaseElevationLayerConstructor { /** * BaseElevationLayer is intended to be extended for creating custom elevation layers. You create a custom [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) by calling [createSubclass()](https://dojotoolkit.org/reference-guide/1.10/dojo/_base/declare.html#createsubclass) on the `BaseElevationLayer`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html) */ @@ -6610,15 +6610,15 @@ declare namespace __esri { interface BaseElevationLayerProperties extends LayerProperties { /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#spatialReference) - * + * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; @@ -6628,7 +6628,7 @@ declare namespace __esri { export interface BaseElevationLayerFetchTileOptions extends Object { /** * The value representing pixels in the tile that don't contain an elevation value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#fetchTile) */ noDataValue?: number; @@ -6636,37 +6636,37 @@ declare namespace __esri { /** * Describes elevation contained in the pixels that comprise an elevation tile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ export interface ElevationTileData extends Object { /** * The elevation values of each pixel in the tile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ values: number[]; /** * The width of the tile in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ width: number; /** * The height of the tile in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ height: number; /** * The maximum allowed error of the Z-value for each value in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ maxZError: number; /** * Indicating the pixel values where no elevation data is present. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseElevationLayer.html#ElevationTileData) */ noDataValue: number; @@ -6689,69 +6689,69 @@ declare namespace __esri { interface BaseTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer { /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#spatialReference) - * + * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} */ spatialReference: SpatialReference; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * Adds a promise to the layer's [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) chain. This is typically used in the [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#load) method to ensure that all [loadable](https://developers.arcgis.com/javascript/latest/guide/loadable/index.html) resources required for the layer to function are loaded prior to this layer resolving and becoming [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#addResolvingPromise) - * + * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` [status](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#loadStatus) to being [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#loaded). - * + * */ addResolvingPromise(promiseToLoad: IPromise): IPromise; /** * This method fetches a tile for the given level, row and column present in the view. Override this method if the data or image returned from the server needs to be processed before it can be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#fetchTile) - * + * * @param level Level of detail of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param row The row (y) position of the tile fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param col The column (x) position of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param options Optional settings for the tile request. The options have the following properties. - * + * */ fetchTile(level: number, row: number, col: number, options?: any): IPromise; /** - * Returns the bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. The value for each item in the array is described in the following table: - * + * Returns the bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. The value for each item in the array is described in the following table: + * * Index | Value * ------|------ * 0 | Minimum x-value * 1 | Minimum y-value * 2 | Maximum x-value * 3 | Maximum y-value - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#getTileBounds) - * + * * @param level The level of detail (LOD) of the tile. * @param row The tile's row (y) position in the dataset. * @param column The tiles column (x) position in the dataset. * @param out Array for storing the tile bounds or extent. - * + * */ getTileBounds(level: number, row: number, column: number, out?: number[]): number[]; /** * This method returns a URL to an image for a given level, row and column. Override this method to construct the URL for the image based on user interaction. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#getTileUrl) - * + * * @param level Level of detail. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param row Tile row. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param col Tile column. This value is provided by the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). - * + * */ getTileUrl(level: number, row: number, col: number): string; @@ -6764,7 +6764,7 @@ declare namespace __esri { interface BaseTileLayerConstructor { /** * This class may be extended to create a custom [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html). Tile layers are composed of images, such as satellite imagery, that are composed of square tiles mosaicked together in columns and rows, giving the layer the appearance that it is one continuous image. These layers have several levels of detail (LOD) that permit users to zoom in to any region of the map and load additional tiles that depict features in higher resolution at larger map scales. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html) */ @@ -6776,15 +6776,15 @@ declare namespace __esri { interface BaseTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#spatialReference) - * + * * @default {@link module:esri/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BaseTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; @@ -6807,45 +6807,45 @@ declare namespace __esri { interface BingMapsLayer extends BaseTileLayer { /** * Expose Bing logo url. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#bingLogo) */ readonly bingLogo: string; /** * Copyright information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#copyright) */ readonly copyright: string; /** * Provides culture specific map labels. For more information visit: https://msdn.microsoft.com/en-us/library/ff701709.aspx For a list of supported culture codes please visit: https://msdn.microsoft.com/en-us/library/hh441729.aspx - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#culture) - * + * * @default "en-US" */ culture: string; /** * Bing Maps Key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#key) - * + * * @default null */ key: string; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. For more information on Bing's region setting please visit: https://msdn.microsoft.com/en-us/library/ff701704.aspx For a list of supported country codes please visit: see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#region) - * + * * @default null */ region: string; /** * The three supported maps are: `road` | `aerial` | `hybrid` For more information on Bing map styles please visit: https://msdn.microsoft.com/en-us/library/ff701716.aspx - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#style) - * + * * @default "road" */ style: string; @@ -6859,7 +6859,7 @@ declare namespace __esri { interface BingMapsLayerConstructor { /** * This layer supports Microsoft's Bing tiled map content. Three map styles are supported - `road`, `aerial` and `hybrid`. Please note that a valid [Bing Maps key](https://msdn.microsoft.com/en-us/library/ff428642.aspx) is required to use this layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html) */ @@ -6871,33 +6871,33 @@ declare namespace __esri { interface BingMapsLayerProperties extends BaseTileLayerProperties { /** * Provides culture specific map labels. For more information visit: https://msdn.microsoft.com/en-us/library/ff701709.aspx For a list of supported culture codes please visit: https://msdn.microsoft.com/en-us/library/hh441729.aspx - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#culture) - * + * * @default "en-US" */ culture?: string; /** * Bing Maps Key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#key) - * + * * @default null */ key?: string; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. For more information on Bing's region setting please visit: https://msdn.microsoft.com/en-us/library/ff701704.aspx For a list of supported country codes please visit: see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#region) - * + * * @default null */ region?: string; /** * The three supported maps are: `road` | `aerial` | `hybrid` For more information on Bing map styles please visit: https://msdn.microsoft.com/en-us/library/ff701716.aspx - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BingMapsLayer.html#style) - * + * * @default "road" */ style?: string; @@ -6920,19 +6920,19 @@ declare namespace __esri { interface CSVLayer extends Layer { /** * Copyright information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#copyright) */ copyright: string; /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#definitionExpression) */ definitionExpression: string; /** - * The column delimiter. See the table below for possible values. - * + * The column delimiter. See the table below for possible values. + * * | Value | Description| * | --- | --- | * | `,` | comma | @@ -6940,204 +6940,204 @@ declare namespace __esri { * | `;` | semicolon | * | `|` | pipe | * | `\t` | tab-delimited | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#delimiter) */ delimiter: string; /** * Specifies how graphics are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ elevationInfo: CSVLayerElevationInfo; /** * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. Currently this property is only supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) for point features with non-draped [Icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. ![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#featureReduction) */ featureReduction: CSVLayerFeatureReduction; /** * An array of fields in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) */ fields: Field[]; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) property of this layer must be set to `true`. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) property of this layer must be set to `true`. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). * > **Known Limitations** Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** - * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) property. - * > **Known Limitations** + * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) property. + * > **Known Limitations** * * Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Currently the `labelsVisible` property must be explicitly set to `true` for labels to be printed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * The latitude field name. If not specified, the API will look for following field names in the CSV source: "lat", "latitude", "y", "ycenter", "latitude83", "latdecdeg", "POINT-Y". - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#latitudeField) */ latitudeField: string; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The longitude field name. If not specified, the API will look for following field names in the CSV source: "lon", "lng", "long", "longitude", "x", "xcenter", "longitude83", "longdecdeg", "POINT-X". - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#longitudeField) */ longitudeField: string; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#maxScale) - * + * * @default 0 */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#minScale) - * + * * @default 0 */ minScale: number; /** * An array of field names to include in the CSVLayer. If not specified, the layer will include all fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#renderer) */ renderer: Renderer; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled: boolean; /** - * The spatial reference of the layer. The default value is WGS84. This property can be set explicitly to project the longitude and latitude coordinates when the layer parses the CSV file. While not required, explicitly setting the spatial reference of the layer will improve the performance when projecting to a spatial reference other than the one used by the coordinates in the raw data. + * The spatial reference of the layer. The default value is WGS84. This property can be set explicitly to project the longitude and latitude coordinates when the layer parses the CSV file. While not required, explicitly setting the spatial reference of the layer will improve the performance when projecting to a spatial reference other than the one used by the coordinates in the raw data. * > **Known Limitations** The browser must support [WebAssembly](https://caniuse.com/#feat=wasm) if a spatial reference other than WGS84 or Web Mercator is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#spatialReference) - * + * * @default SpatialReference.WGS84 */ spatialReference: SpatialReference; /** * The URL of the CSV file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#url) */ url: string; /** * Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#createQuery) - * - * + * + * */ createQuery(): Query; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. + * > **Known Limitations** * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): * * GDM 2000 (4742) – Malaysia * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryExtent) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryExtent(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns the number of features that satisfy the query. If no parameters are specified, then the total number of features satisfying the layer's configuration/filters is returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns the number of features that satisfy the query. If no parameters are specified, then the total number of features satisfying the layer's configuration/filters is returned. + * > **Known Limitations** * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): * * GDM 2000 (4742) – Malaysia * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatureCount) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatureCount(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). This array will not be populated if zero results are found. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). This array will not be populated if zero results are found. + * > **Known Limitations** * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): * * GDM 2000 (4742) – Malaysia * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatures) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatures(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the CSV data and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. + * > **Known Limitations** * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): * * GDM 2000 (4742) – Malaysia * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryObjectIds) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryObjectIds(params?: Query | QueryProperties): IPromise; @@ -7150,7 +7150,7 @@ declare namespace __esri { interface CSVLayerConstructor { /** * The CSVLayer is a point layer based on a CSV file (.csv, .txt). CSV is a plain-text file format used to represent tabular data, including geographic point features (latitude, longitude). Typically the latitude coordinate is the Y value, and the longitude coordinate is the X value. Features from the CSV file are accessible via the API so you can query features and use them as input to geometry or geoprocessing services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) */ @@ -7162,19 +7162,19 @@ declare namespace __esri { interface CSVLayerProperties extends LayerProperties { /** * Copyright information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#copyright) */ copyright?: string; /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#definitionExpression) */ definitionExpression?: string; /** - * The column delimiter. See the table below for possible values. - * + * The column delimiter. See the table below for possible values. + * * | Value | Description| * | --- | --- | * | `,` | comma | @@ -7182,130 +7182,130 @@ declare namespace __esri { * | `;` | semicolon | * | `|` | pipe | * | `\t` | tab-delimited | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#delimiter) */ delimiter?: string; /** * Specifies how graphics are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ elevationInfo?: CSVLayerElevationInfo; /** * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. Currently this property is only supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) for point features with non-draped [Icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. ![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#featureReduction) */ featureReduction?: CSVLayerFeatureReduction; /** * An array of fields in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#fields) */ fields?: FieldProperties[]; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) property of this layer must be set to `true`. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) property of this layer must be set to `true`. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). * > **Known Limitations** Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** - * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) property. - * > **Known Limitations** + * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelingInfo) property. + * > **Known Limitations** * * Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Currently the `labelsVisible` property must be explicitly set to `true` for labels to be printed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * The latitude field name. If not specified, the API will look for following field names in the CSV source: "lat", "latitude", "y", "ycenter", "latitude83", "latdecdeg", "POINT-Y". - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#latitudeField) */ latitudeField?: string; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The longitude field name. If not specified, the API will look for following field names in the CSV source: "lon", "lng", "long", "longitude", "x", "xcenter", "longitude83", "longdecdeg", "POINT-X". - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#longitudeField) */ longitudeField?: string; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#maxScale) - * + * * @default 0 */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#minScale) - * + * * @default 0 */ minScale?: number; /** * An array of field names to include in the CSVLayer. If not specified, the layer will include all fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#renderer) */ renderer?: RendererProperties; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled?: boolean; /** - * The spatial reference of the layer. The default value is WGS84. This property can be set explicitly to project the longitude and latitude coordinates when the layer parses the CSV file. While not required, explicitly setting the spatial reference of the layer will improve the performance when projecting to a spatial reference other than the one used by the coordinates in the raw data. + * The spatial reference of the layer. The default value is WGS84. This property can be set explicitly to project the longitude and latitude coordinates when the layer parses the CSV file. While not required, explicitly setting the spatial reference of the layer will improve the performance when projecting to a spatial reference other than the one used by the coordinates in the raw data. * > **Known Limitations** The browser must support [WebAssembly](https://caniuse.com/#feat=wasm) if a spatial reference other than WGS84 or Web Mercator is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#spatialReference) - * + * * @default SpatialReference.WGS84 */ spatialReference?: SpatialReferenceProperties; /** * The URL of the CSV file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#url) */ url?: string; @@ -7314,34 +7314,34 @@ declare namespace __esri { export interface CSVLayerElevationInfo extends Object { /** - * Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values. - * + * Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values. + * * Mode | Description * ------|------------ * on-the-ground | Graphics are draped on the terrain surface. This is the default value for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [ObjectSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). * relative-to-ground | Graphics are placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up the terrain elevation and the result of `featureExpressionInfo` (if defined). This is the default value for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [IconSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html). * absolute-height | Graphics are placed at an absolute height above sea level. This height is determined by the result of `featureExpressionInfo` (if defined). This mode doesn't take the elevation of the terrain into account. * relative-to-scene | Graphics are aligned to buildings and other objects part of 3D Object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) or [IntegratedMeshLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html), depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If defined, the result of `featureExpressionInfo` is added to the 3D Object/terrain surface elevation. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ mode: string; /** * An elevation offset, which is added to the vertical position of the graphic. If `unit` is not defined, the offset is in `meters`. When `mode = "on-the-ground"`, this property has no effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ offset?: number; /** * This object contains information about setting a custom height on the graphic. If this property is set, then z values are not considered for calculating graphic height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ featureExpressionInfo?: CSVLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ unit?: string; @@ -7351,7 +7351,7 @@ declare namespace __esri { export interface CSVLayerElevationInfoFeatureExpressionInfo extends Object { /** * An [Arcade expression](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) evaluating to a number that determines the height of the graphic. When `mode = "on-the-ground"`, this property has no effect. For line and polygon geometries the result of the expression is the same for all vertices of a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#elevationInfo) */ expression?: string; @@ -7361,7 +7361,7 @@ declare namespace __esri { export interface CSVLayerFeatureReduction extends Object { /** * Type of the decluttering method. The only supported type at the moment is `selection`. In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#featureReduction) */ type: string; @@ -7384,43 +7384,43 @@ declare namespace __esri { interface DynamicLayer { /** * The portal item from which the layer is loaded. This will load the layer along with any overridden properties (e.g. renderers, definition expressions, etc.) saved to the portal item, not the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#portalItem) */ portalItem: PortalItem; /** * The URL to the REST endpoint of the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#url) */ url: string; /** * This method fetches the image for the specified extent and size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#fetchImage) - * + * * @param extent The extent of the view. * @param width The width of the view in pixels. * @param height The height of the view in pixels. * @param options The parameter options is an object with the following properties. * @param options.rotation The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. * @param options.pixelRatio The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. - * + * */ fetchImage(extent: Extent, width: number, height: number, options?: DynamicLayerFetchImageOptions): IPromise; /** * This method returns a URL to an image for a given extent, width and height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#getImageUrl) - * + * * @param extent The extent of the exported image. * @param width The width of the view in pixels. * @param height The height of the view in pixels. * @param options The parameter options is an object with the following properties. * @param options.pixelRatio The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. * @param options.rotation The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. - * + * */ getImageUrl(extent: Extent, width: number, height: number, options?: DynamicLayerGetImageUrlOptions): IPromise | string; } @@ -7436,13 +7436,13 @@ declare namespace __esri { interface DynamicLayerProperties { /** * The portal item from which the layer is loaded. This will load the layer along with any overridden properties (e.g. renderers, definition expressions, etc.) saved to the portal item, not the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * The URL to the REST endpoint of the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#url) */ url?: string; @@ -7452,13 +7452,13 @@ declare namespace __esri { export interface DynamicLayerFetchImageOptions extends Object { /** * The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#fetchImage) */ rotation?: number; /** * The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#fetchImage) */ pixelRatio?: number; @@ -7468,13 +7468,13 @@ declare namespace __esri { export interface DynamicLayerGetImageUrlOptions extends Object { /** * The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#getImageUrl) */ pixelRatio?: number; /** * The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DynamicLayer.html#getImageUrl) */ rotation?: number; @@ -7483,64 +7483,64 @@ declare namespace __esri { interface ElevationLayer extends Layer, ArcGISCachedService, PortalLayer { /** * URL pointing to the Elevation layer resource on an ArcGIS Image Server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#url) */ url: string; /** * Creates an elevation sampler for the given [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) by querying the service layer for elevation data and caching it so values may be sampled quickly afterwards. The resolution of the cached data can be set using the `demResolution` option. In many cases, `auto` demResolution can be used to get high quality elevation samples without the need to know exactly where the data in the service is located. This is particularly useful for services which combine elevation data from many sources (such as the world elevation service). If more control, or higher quality samples are required, use either `finest-contiguous` or a fixed `{number}` resolution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) - * + * * @param extent The extent for which to create the sampler. * @param options Additional query options. See the table below. * @param options.demResolution Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) for more details. * @param options.noDataValue The value to use when there is no data available. - * + * */ createElevationSampler(extent: Extent, options?: ElevationLayerCreateElevationSamplerOptions): IPromise; /** - * Requests a tile from the service and decodes the data into a linear array of elevation values. The returned promise resolves with a plain object describing the obtained elevation data for the tile. The object has the following properties: - * + * Requests a tile from the service and decodes the data into a linear array of elevation values. The returned promise resolves with a plain object describing the obtained elevation data for the tile. The object has the following properties: + * * Property | Type | Description * ----------|--------------|------------ * values | Float32Array | The elevation values contained in the tile. * width | number | The number of elevation values in one row of the tile. * height | number | The number of elevation values in one column of the tile. * maxZError | number | The upper bound for the compression error on the elevation values. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#fetchTile) - * + * * @param level the tile level. * @param row the tile row. * @param column the tile column. * @param noDataValue the value to use when a tile is partially missing data. - * + * */ fetchTile(level: number, row: number, column: number, noDataValue?: number): IPromise; /** * This method returns a URL to a tile for a given level, row and column. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#getTileUrl) - * + * * @param level The requested tile's level. * @param row The requested tile's row. * @param col The requested tile's column. - * + * */ getTileUrl(level: number, row: number, col: number): string; /** * Queries the service layer for elevation values for the given geometry. The returned result contains a copy of the geometry with z-values sampled from elevation data from the service. The resolution from which the elevation is queried can be set using the `demResolution` option. In many cases, `auto` demResolution can be used to get high quality elevation samples without the need to know exactly where the data in the service is located. This is particularly useful for services which combine elevation data from many sources (such as the world elevation service). If more control, or higher quality samples are required, use either `finest-contiguous` or a fixed `{number}` resolution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) - * + * * @param geometry The geometry to use for sampling elevation data. * @param options Additional query options. See the table below. - * @param options.demResolution - * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See the table below for more details on the different settings. - * + * @param options.demResolution + * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See the table below for more details on the different settings. + * * demResolution | Description * -----------------------|------------- * `auto` | Automatically chooses an appropriate resolution for each coordinate of the input geometry. The current implementation will try to use the finest available resolution given that the total required number of tile requests does not exceed a certain maximum amount (currently 20). Note that this may result in values being sampled from different resolutions. @@ -7548,7 +7548,7 @@ declare namespace __esri { * `{number}` | Sample elevation from the resolution closest to the specified resolution (in meters). * @param options.returnSampleInfo Indicates whether to return additional sample information for each coordinate. * @param options.noDataValue The value to use when there is no data available. - * + * */ queryElevation(geometry: Point | Multipoint | Polyline, options?: ElevationLayerQueryElevationOptions): IPromise; @@ -7561,7 +7561,7 @@ declare namespace __esri { interface ElevationLayerConstructor { /** * ElevationLayer is a tile layer used for rendering elevations in [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A default [world elevation layer](https://www.arcgis.com/home/item.html?id=7029fb60158543ad845c7e1527af11e4) can be added to the map by setting the [map's ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) property to `world-elevation`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) */ @@ -7575,7 +7575,7 @@ declare namespace __esri { interface ElevationLayerProperties extends LayerProperties, ArcGISCachedServiceProperties, PortalLayerProperties { /** * URL pointing to the Elevation layer resource on an ArcGIS Image Server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#url) */ url?: string; @@ -7585,17 +7585,17 @@ declare namespace __esri { export interface ElevationLayerCreateElevationSamplerOptions extends Object { /** * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) - * + * * @default auto */ demResolution?: number | string; /** * The value to use when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) - * + * * @default 0 */ noDataValue?: number; @@ -7604,33 +7604,33 @@ declare namespace __esri { export interface ElevationLayerQueryElevationOptions extends Object { /** - * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See the table below for more details on the different settings. - * + * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`). See the table below for more details on the different settings. + * * demResolution | Description * -----------------------|------------- * `auto` | Automatically chooses an appropriate resolution for each coordinate of the input geometry. The current implementation will try to use the finest available resolution given that the total required number of tile requests does not exceed a certain maximum amount (currently 20). Note that this may result in values being sampled from different resolutions. * `finest-contiguous` | Sample elevation from the finest available resolution (cell size) across the entire geometry. * `{number}` | Sample elevation from the resolution closest to the specified resolution (in meters). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) - * + * * @default auto */ demResolution?: number | string; /** * Indicates whether to return additional sample information for each coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) - * + * * @default false */ returnSampleInfo?: boolean; /** * The value to use when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) - * + * * @default 0 */ noDataValue?: number; @@ -7638,25 +7638,25 @@ declare namespace __esri { /** * Object returned when [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) promise resolves: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ export interface ElevationLayerElevationQueryResult extends Object { /** * The geometry with sampled z-values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ geometry: Point | Multipoint | Polyline; /** * Contains additional information about how the geometry was sampled. This property is present depending on whether the user set `options.returnSampleInfo = true`, for each coordinate in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ sampleInfo?: ElevationLayerElevationQueryResultSampleInfo[]; /** * The value used when there is no data available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ noDataValue: number; @@ -7680,7 +7680,7 @@ declare namespace __esri { export interface ElevationLayerElevationQueryResultSampleInfo extends Object { /** * The resolution at which the z-value was sampled. If no data was available for sampling for a given coordinate, the dem resolution value will be -1 for that coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#ElevationQueryResult) */ demResolution: number; @@ -7689,375 +7689,375 @@ declare namespace __esri { interface FeatureLayer extends Layer, PortalLayer, ScaleRangeLayer, RefreshableLayer { /** * Indicates the layer's supported capabilities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ readonly capabilities: FeatureLayerCapabilities; /** * The copyright text as defined by the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#copyright) */ copyright: string; /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression) */ definitionExpression: string; /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#displayField) */ displayField: string; /** * An object that allows you to create a dynamic layer with data either from map service sublayers or data from a registered workspace. See [DynamicMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) for creating dynamic layers from map service layers for on the fly rendering, labeling, and filtering (definition expressions). To create dynamic layers from other sources in registered workspaces such as tables and table joins, see [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer). If you already have a [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) instance, you can call the [createFeatureLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createFeatureLayer) method on the Sublayer to construct the layer for you. This only applies to map services with [dynamic layers](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm) enabled. Therefore, the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) of the FeatureLayer instance must point to a map service url ending with `/dynamicLayer`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#dynamicDataSource) */ dynamicDataSource: DynamicMapLayer | DynamicDataLayer; /** * Specifies how features are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ elevationInfo: FeatureLayerElevationInfo; /** * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. Currently this property is only supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) for point features with non-draped [Icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. ![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) */ featureReduction: FeatureLayerFeatureReduction; /** * An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer. For example, a field named `POP_2015`, stores information about total population as a numeric value for each feature; this value represents the total number of people living within the geographic bounds of the feature. This property must be set in the constructor when creating a FeatureLayer from client-side [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). To create FeatureLayers from client-side features you must also set the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference), [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) */ fields: Field[]; /** * The version of the geodatabase of the feature service data. Read the [Overview of versioning](https://desktop.arcgis.com/en/arcmap/latest/manage-data/geodatabases/an-overview-of-versioning.htm) topic for more details about this capability. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#gdbVersion) */ readonly gdbVersion: string; /** * The geometry type of features in the layer. All features must be of the same type. This property is read-only when the layer is created from a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url). When creating a FeatureLayer from client-side features, this property is inferred by the geometryType of the features provided in the layer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) property. **Possible Values:** point | multipoint | polyline | polygon | extent | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType) */ geometryType: string; /** * Indicates if attachments are enabled on the feature layer. Use `FeatureLayer.capabilities.data.supportsAttachment` instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#hasAttachments) - * + * * @default false */ readonly hasAttachments: boolean; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. Use the `supportsM` property in the FeatureLayer's [capabilities.data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) object to verify if `M` values are supported on [feature service](https://developers.arcgis.com/rest/services-reference/feature-service.htm) features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#hasM) - * + * * @default undefined */ readonly hasM: boolean; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. Refer to [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) for details regarding placement and rendering of features with z-values in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Use the `supportsZ` property in the FeatureLayer's [capabilities.data](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) object to verify if `Z` values are supported on [feature service](https://developers.arcgis.com/rest/services-reference/feature-service.htm) features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#hasZ) - * + * * @default undefined */ readonly hasZ: boolean; /** * The historic moment to query. If historicMoment is not specified, the query will apply to the current features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#historicMoment) */ historicMoment: Date; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. The [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) property of this layer must be set to `true` for labels to display in the view. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). - * > **Known Limitations** + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. The [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) property of this layer must be set to `true` for labels to display in the view. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). + * > **Known Limitations** * * Currently only FeatureLayers with point and polygon geometries are supported. * * Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** - * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) property. - * > **Known Limitations** + * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) property. + * > **Known Limitations** * * Currently only FeatureLayers with point and polygon geometries are supported. * * Currently 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) only support one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) per feature. * * Currently the `labelsVisible` property must be explicitly set to `true` for labels to be printed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** - * The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single FeatureLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: + * The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single FeatureLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: * * When loading the layer via the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property. * * When pointing the layer [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) directly to the Feature Service. - * - * + * + * * If a layerId is not specified in either of the above scenarios, then the first layer in the service (`layerId = 0`) is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) */ layerId: number; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) containing a unique value or identifier for each feature in the layer. This is required when constructing a FeatureLayer from a collection of client-side [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField) */ objectIdField: string; /** * An array of field names from the service to include in the FeatureLayer. If not specified, the layer will only return the `OBJECTID` field. To fetch the values from all fields in the layer, use `["*"]`. This is particularly useful when editing features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields) */ outFields: string[]; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Array of [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) set up for the layer. Each object in the array describes the layer's [relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html) with another layer or table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#relationships) */ readonly relationships: Relationship; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. However, when creating a FeatureLayer from client-side features, this property must be specified in the layer's constructor along with the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source), [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) */ renderer: Renderer; /** * When `true`, indicates that M values will be returned. When `false`, indicates that M values will never be returned. The layer view determines whether to include M values in feature queries when the property value is `undefined`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#returnM) - * + * * @default undefined */ returnM: boolean; /** * When `true`, indicates that Z values will always be returned. When `false`, indicates that Z values will never be returned. The layer view determines whether to include Z values in feature queries when the property value is `undefined`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#returnZ) - * + * * @default undefined */ returnZ: boolean; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled: boolean; /** * A collection of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) objects used to create a FeatureLayer. The geometry of each feature all must have a matching [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType). This property should only be used when creating a FeatureLayer from client-side features. When creating a FeatureLayer from client-side features, the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) properties must also be set. Use [applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) method to add, remove, and update features from a layer at runtime. Once `applyEdits()` resolves successfully, use [queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) to return updated features. The [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference) and [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType) properties are determined based on the features provided to this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) */ source: Collection; /** * The spatial reference of the layer. When creating the layer from a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url), the spatial reference is read from the service. When creating a FeatureLayer from client-side features, this property is inferred from the geometries of the features provided in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * An array of feature templates defined in the feature layer. See [ArcGIS Pro subtypes document](https://pro.arcgis.com/en/pro-app/help/data/geodatabases/overview/an-overview-of-subtypes.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#templates) */ templates: FeatureTemplate[]; /** * Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use [IdentityManager.registerToken()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#token) */ readonly token: string; /** * The name of the field holding the type ID or subtypes for the features. See [ArcGIS Pro subtypes document](https://pro.arcgis.com/en/pro-app/help/data/geodatabases/overview/an-overview-of-subtypes.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#typeIdField) */ readonly typeIdField: string; /** * An array of subtypes defined in the feature service exposed by ArcGIS REST API. Each item includes information about the type, such as the type ID, name, and definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#types) */ types: FeatureType[]; /** * The URL of the REST endpoint of the layer or service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. If the url points directly to a service, then the layer must be specified in the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) property. If no [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) is given, then the first layer in the service will be loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) */ url: string; /** * The version of ArcGIS Server in which the layer is published. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#version) */ readonly version: number; /** * Adds an attachment to a feature. This operation is available only if the layer's [capabilities.data.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#addAttachment) - * + * * @param feature Feature to which the attachment is to be added. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. - * + * */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): IPromise; /** - * Applies edits to features in a layer. New features can be created and existing features can be updated or deleted. Feature geometries and/or attributes may be modified. Only applicable to layers in a [feature service](https://developers.arcgis.com/rest/services-reference/feature-service.htm) and client-side features set through the layer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source). + * Applies edits to features in a layer. New features can be created and existing features can be updated or deleted. Feature geometries and/or attributes may be modified. Only applicable to layers in a [feature service](https://developers.arcgis.com/rest/services-reference/feature-service.htm) and client-side features set through the layer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source). * > **Known Limitations** FeatureLayer.applyEdits() is not supported for client-side features in [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) - * + * * @param edits Object containing features to be added, updated or deleted. * @param edits.addFeatures Array of features to be added. Values of non nullable fields must be provided when adding new features. Date fields must have [numeric](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime) values representing universal time. * @param edits.updateFeatures Array of features to be updated. Each feature must have valid [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField). Values of non nullable fields must be provided when updating features. Date fields must have [numeric](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime) values representing universal time. * @param edits.deleteFeatures An array of features or objects to be deleted. When an array of features is passed, each feature must have a valid [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField). When an array of objects is used, each object must have a valid `objectId` property. - * + * */ applyEdits(edits: FeatureLayerApplyEditsEdits): IPromise; /** * Creates query parameters that can be used to fetch features that satisfy the layer's current filters, and definitions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#createQuery) - * - * + * + * */ createQuery(): Query; /** * Deletes attachments from a feature. This operation is available only if the layer's [capabilities.data.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#deleteAttachments) - * + * * @param feature Feature containing attachments to be deleted. * @param attachmentIds Ids of the attachments to be deleted. - * + * */ deleteAttachments(feature: Graphic, attachmentIds: number[]): IPromise; /** * Returns a [FeatureType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html) describing the feature's type. This is applicable if the layer containing the feature has a [typeIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#typeIdField). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#getFeatureType) - * + * * @param feature A feature from this layer. - * + * */ getFeatureType(feature: Graphic): FeatureType; /** * Returns the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) associated with the given field name. The domain can be either a [CodedValueDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#getFieldDomain) - * + * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * @param options.feature The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. - * + * */ getFieldDomain(fieldName: string, options?: FeatureLayerGetFieldDomainOptions): Domain; /** - * Query information about attachments associated with features. It will return an error if the layer's [capabilities.data.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property is `false`. Attachments for multiple features can be queried if the layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is `true`. + * Query information about attachments associated with features. It will return an error if the layer's [capabilities.data.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property is `false`. Attachments for multiple features can be queried if the layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is `true`. * > **Known Limitations** When the layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property is `false`, [AttachmentQuery.objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds) property only accepts a single `objectId`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttachments) - * + * * @param attachmentQuery Specifies the attachment parameters for query. - * + * */ queryAttachments(attachmentQuery: AttachmentQuery | AttachmentQueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. This is valid only for [hosted feature services](http://doc.arcgis.com/en/arcgis-online/share-maps/hosted-web-layers.htm) on [arcgis.com](http://arcgis.com) and for ArcGIS Server 10.3.1 and later. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. This is valid only for [hosted feature services](http://doc.arcgis.com/en/arcgis-online/share-maps/hosted-web-layers.htm) on [arcgis.com](http://arcgis.com) and for ArcGIS Server 10.3.1 and later. * > To query for the extent of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) on the client rather than making a server-side query, you must use the [FeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryExtent) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryExtent) - * + * * @param params Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. - * + * */ queryExtent(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns the number of features that satisfy the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns the number of features that satisfy the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * > To query for the count of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) on the client rather than making a server-side query, you must use the [FeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryFeatureCount) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatureCount) - * + * * @param params Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. - * + * */ queryFeatureCount(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). This array will not be populated if zero results are found. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which can be accessed using the `.then()` method once the promise resolves. A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). This array will not be populated if zero results are found. * > To query features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) on the client rather than making a server-side query, you must use the [FeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryFeatures) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) - * + * * @param params Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. - * + * */ queryFeatures(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the feature service and returns an array of Object IDs for features that satisfy the input query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * > To query for ObjectIDs of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) on the client rather than making a server-side query, you must use the [FeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryObjectIds) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryObjectIds) - * + * * @param params Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. - * + * */ queryObjectIds(params?: Query | QueryProperties): IPromise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html) against the feature service and returns [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) grouped by source layer or table objectIds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryRelatedFeatures) - * + * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. - * + * */ queryRelatedFeatures(relationshipQuery: RelationshipQuery | RelationshipQueryProperties): IPromise; /** * Updates an existing attachment for a feature. This operation is available only if the layer's [capabilities.data.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#updateAttachment) - * + * * @param feature The feature containing the attachment to be updated. * @param attachmentId Id of the attachment to be updated. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. - * + * */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): IPromise; @@ -8070,7 +8070,7 @@ declare namespace __esri { interface FeatureLayerConstructor { /** * A FeatureLayer is a single layer that can be created from a [Map Service](http://server.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm) or [Feature Service](http://server.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm); ArcGIS Online or ArcGIS Enterprise portal items; or from an array of client-side features. It is composed of discrete features, each of which has a [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that allows it to be rendered in either a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) as a [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) with spatial context. Features also contain data [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes) that provide additional information about the real-world feature it represents; attributes may be viewed in [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) windows and used for [rendering](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) the layer. FeatureLayers may be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures), [analyzed](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html), and [rendered](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) to visualize data in a spatial context. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) */ @@ -8084,182 +8084,182 @@ declare namespace __esri { interface FeatureLayerProperties extends LayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * The copyright text as defined by the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#copyright) */ copyright?: string; /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when the dataset is large and you don't want to bring all features to the client for analysis. Definition expressions may be set when a layer is constructed prior to it loading in the view or after it has been added to the map. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression) */ definitionExpression?: string; /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#displayField) */ displayField?: string; /** * An object that allows you to create a dynamic layer with data either from map service sublayers or data from a registered workspace. See [DynamicMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) for creating dynamic layers from map service layers for on the fly rendering, labeling, and filtering (definition expressions). To create dynamic layers from other sources in registered workspaces such as tables and table joins, see [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer). If you already have a [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) instance, you can call the [createFeatureLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createFeatureLayer) method on the Sublayer to construct the layer for you. This only applies to map services with [dynamic layers](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm) enabled. Therefore, the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) of the FeatureLayer instance must point to a map service url ending with `/dynamicLayer`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#dynamicDataSource) */ dynamicDataSource?: DynamicMapLayer | DynamicDataLayer; /** * Specifies how features are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ elevationInfo?: FeatureLayerElevationInfo; /** * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. Currently this property is only supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) for point features with non-draped [Icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. ![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) */ featureReduction?: FeatureLayerFeatureReduction; /** * An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer. For example, a field named `POP_2015`, stores information about total population as a numeric value for each feature; this value represents the total number of people living within the geographic bounds of the feature. This property must be set in the constructor when creating a FeatureLayer from client-side [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). To create FeatureLayers from client-side features you must also set the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference), [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. All features must be of the same type. This property is read-only when the layer is created from a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url). When creating a FeatureLayer from client-side features, this property is inferred by the geometryType of the features provided in the layer's [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) property. **Possible Values:** point | multipoint | polyline | polygon | extent | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType) */ geometryType?: string; /** * The historic moment to query. If historicMoment is not specified, the query will apply to the current features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#historicMoment) */ historicMoment?: DateProperties; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. The [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) property of this layer must be set to `true` for labels to display in the view. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). - * > **Known Limitations** + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. The [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) property of this layer must be set to `true` for labels to display in the view. Multiple Label classes with different `where` clauses can be used to define several labels with varying styles on the same feature. Likewise, multiple label classes may be used to label different types of features (for example blue labels for lakes and green labels for parks). + * > **Known Limitations** * * Currently only FeatureLayers with point and polygon geometries are supported. * * Currently only one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) is supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** - * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) property. - * > **Known Limitations** + * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) property. + * > **Known Limitations** * * Currently only FeatureLayers with point and polygon geometries are supported. * * Currently 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) only support one [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) per feature. * * Currently the `labelsVisible` property must be explicitly set to `true` for labels to be printed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** - * The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single FeatureLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: + * The layer ID, or layer index, of a Feature Service layer. This is particularly useful when loading a single FeatureLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: * * When loading the layer via the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#portalItem) property. * * When pointing the layer [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) directly to the Feature Service. - * - * + * + * * If a layerId is not specified in either of the above scenarios, then the first layer in the service (`layerId = 0`) is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) */ layerId?: number; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The name of an `oid` [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields) containing a unique value or identifier for each feature in the layer. This is required when constructing a FeatureLayer from a collection of client-side [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField) */ objectIdField?: string; /** * An array of field names from the service to include in the FeatureLayer. If not specified, the layer will only return the `OBJECTID` field. To fetch the values from all fields in the layer, use `["*"]`. This is particularly useful when editing features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields) */ outFields?: string[]; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. However, when creating a FeatureLayer from client-side features, this property must be specified in the layer's constructor along with the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source), [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) */ renderer?: RendererProperties; /** * When `true`, indicates that M values will be returned. When `false`, indicates that M values will never be returned. The layer view determines whether to include M values in feature queries when the property value is `undefined`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#returnM) - * + * * @default undefined */ returnM?: boolean; /** * When `true`, indicates that Z values will always be returned. When `false`, indicates that Z values will never be returned. The layer view determines whether to include Z values in feature queries when the property value is `undefined`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#returnZ) - * + * * @default undefined */ returnZ?: boolean; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled?: boolean; /** * A collection of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) objects used to create a FeatureLayer. The geometry of each feature all must have a matching [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType). This property should only be used when creating a FeatureLayer from client-side features. When creating a FeatureLayer from client-side features, the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields), [objectIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#renderer) properties must also be set. Use [applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) method to add, remove, and update features from a layer at runtime. Once `applyEdits()` resolves successfully, use [queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) to return updated features. The [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference) and [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#geometryType) properties are determined based on the features provided to this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) */ source?: CollectionProperties; /** * The spatial reference of the layer. When creating the layer from a [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url), the spatial reference is read from the service. When creating a FeatureLayer from client-side features, this property is inferred from the geometries of the features provided in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#source) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * An array of feature templates defined in the feature layer. See [ArcGIS Pro subtypes document](https://pro.arcgis.com/en/pro-app/help/data/geodatabases/overview/an-overview-of-subtypes.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#templates) */ templates?: FeatureTemplateProperties[]; /** * An array of subtypes defined in the feature service exposed by ArcGIS REST API. Each item includes information about the type, such as the type ID, name, and definition expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#types) */ types?: FeatureTypeProperties[]; /** * The URL of the REST endpoint of the layer or service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. If the url points directly to a service, then the layer must be specified in the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) property. If no [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#layerId) is given, then the first layer in the service will be loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#url) */ url?: string; @@ -8267,19 +8267,19 @@ declare namespace __esri { /** * FeatureEditResult represents the result of adding, updating or deleting a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ export interface FeatureEditResult extends Object { /** * Object Id of the feature that was edited. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ objectId: number; /** * If the edit failed, the edit result includes an error. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ error: FeatureEditResultError; @@ -8289,19 +8289,19 @@ declare namespace __esri { export interface FeatureLayerApplyEditsEdits extends Object { /** * Array of features to be added. Values of non nullable fields must be provided when adding new features. Date fields must have [numeric](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime) values representing universal time. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) */ addFeatures?: Graphic[]; /** * Array of features to be updated. Each feature must have valid [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField). Values of non nullable fields must be provided when updating features. Date fields must have [numeric](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime) values representing universal time. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) */ updateFeatures?: Graphic[]; /** * An array of features or objects to be deleted. When an array of features is passed, each feature must have a valid [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#objectIdField). When an array of objects is used, each object must have a valid `objectId` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) */ deleteFeatures?: Graphic[] | any[]; @@ -8311,31 +8311,31 @@ declare namespace __esri { export interface FeatureLayerCapabilities extends Object { /** * Indicates data capabilities that can be performed on features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ data: FeatureLayerCapabilitiesData; /** * Indicates editing capabilities that can be performed on the features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ editing: FeatureLayerCapabilitiesEditing; /** * Indicates operations that can be performed on features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ operations: FeatureLayerCapabilitiesOperations; /** * Indicates query operations that can be performed on features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ query: FeatureLayerCapabilitiesQuery; /** * Indicates if the layer's query operation supports querying features or records related to features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ queryRelated: FeatureLayerCapabilitiesQueryRelated; @@ -8345,19 +8345,19 @@ declare namespace __esri { export interface FeatureLayerCapabilitiesData extends Object { /** * Indicates if the attachment is enabled on the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsAttachment: boolean; /** * Indicates if the features in the layer support M values. Requires ArcGIS Server service 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsM: boolean; /** * Indicates if the features in the layer support Z values. Requires ArcGIS Server service 10.1 or greater. See [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) for details regarding placement and rendering of features with z-values in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsZ: boolean; @@ -8367,55 +8367,55 @@ declare namespace __esri { export interface FeatureLayerCapabilitiesEditing extends Object { /** * Indicates if anonymous users can delete features created by others. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsDeleteByAnonymous: boolean; /** * Indicates if logged in users can delete features created by others. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsDeleteByOthers: boolean; /** * Indicates if the geometry of the features in the layer can be edited. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsGeometryUpdate: boolean; /** * Indicates if the `globalid` values provided by the client are used in [applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsGlobalId: boolean; /** * Indicates if the `rollbackOnFailure` parameter can be set to `true` or `false` when running the synchronizeReplica operation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsRollbackOnFailure: boolean; /** * Indicates if anonymous users can update features created by others. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsUpdateByAnonymous: boolean; /** * Indicates if logged in users can update features created by others. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsUpdateByOthers: boolean; /** * Indicates if `m-values` must be provided when updating features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsUpdateWithoutM: boolean; /** * Indicates if the layer supports uploading attachments by [UploadId](https://developers.arcgis.com/rest/services-reference/item.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsUploadWithItemId: boolean; @@ -8425,49 +8425,49 @@ declare namespace __esri { export interface FeatureLayerCapabilitiesOperations extends Object { /** * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) to the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsAdd: boolean; /** * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits) from the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsDelete: boolean; /** * Indicates if features in the layer can be [updated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsUpdate: boolean; /** * Indicates if features in the layer can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits). Use `supportsAdd`, `supportsUpdate` and `supportsDelete` to determine which editing operations are supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsEditing: boolean; /** * Indicates if values of one or more field values in the layer can be updated. See the [Calculate REST operation](https://developers.arcgis.com/rest/services-reference/calculate-feature-service-layer-.htm) document for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsCalculate: boolean; /** * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the layer supports a SQL-92 expression or where clause. This operation is only supported in ArcGIS Online hosted feature services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsValidateSql: boolean; /** * Indicates if resized attachments are supported in the feature layer. This is useful for showing thumbnails in [Popups](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsResizeAttachments: boolean; @@ -8477,91 +8477,91 @@ declare namespace __esri { export interface FeatureLayerCapabilitiesQuery extends Object { /** * Indicates if the layer supports [queryAttachments()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttachments) operation. If `false`, [queryAttachments()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttachments) can only return attachments for one feature at a time. If `true`, `queryAttachments()` can return attachments for array of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsAttachments: boolean; /** * Indicates if the geometry centroid associated with each polygon feature can be returned. This operation is only supported in ArcGIS Online hosted feature services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsCentroid: boolean; /** * Indicates if the layer's query operation supports a buffer distance for input geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsDistance: boolean; /** * Indicates if the layer supports queries for distinct values based on fields specified in the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#outFields). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsDistinct: boolean; /** * Indicates if the layer's query response includes the extent of features. At 10.3, this option is only available for hosted feature services. At 10.3.1, it is available for hosted and non-hosted feature services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsExtent: boolean; /** * Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. This operation is only supported in ArcGIS Online hosted feature services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsGeometryProperties: boolean; /** * Indicates if the layer supports the [having](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#having) clause on the service. Requires an ArcGIS Server service 10.6.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsHavingClause: boolean; /** * Indicates if features returned in the query response can be ordered by one or more fields. Requires an ArcGIS Server service 10.3 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsPagination: boolean; /** * Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.3 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsQuantization: boolean; /** * Indicates if the number of features returned by the query operation can be controlled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsResultType: boolean; /** * Indicates if the query operation supports SQL expressions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsSqlExpression: boolean; /** * Indicates if the query operation supports using standardized queries. Learn more about [standardized queries here](http://server.arcgis.com/en/server/latest/administer/linux/about-standardized-queries.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsStandardizedQueriesOnly: boolean; /** * Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsStatistics: boolean; /** * Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsHistoricMoment: boolean; @@ -8571,19 +8571,19 @@ declare namespace __esri { export interface FeatureLayerCapabilitiesQueryRelated extends Object { /** * Indicates if the layer's query response includes the number of features or records related to features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsCount: boolean; /** * Indicates if the related features or records returned in the query response can be ordered by one or more fields. Requires ArcGIS Server service 10.3 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsOrderBy: boolean; /** * Indicates if the query response supports pagination for related features or records. Requires ArcGIS Server service 10.3 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) */ supportsPagination: boolean; @@ -8592,34 +8592,34 @@ declare namespace __esri { export interface FeatureLayerElevationInfo extends Object { /** - * Defines how the feature is placed with respect to the terrain surface. If the geometry consists of multiple points (e.g. lines or polygons), the elevation is evaluated separately for each point. See the table below for a list of possible values. - * + * Defines how the feature is placed with respect to the terrain surface. If the geometry consists of multiple points (e.g. lines or polygons), the elevation is evaluated separately for each point. See the table below for a list of possible values. + * * Mode | Description * ------|------------ * on-the-ground | Features are draped on the terrain surface. This is the default value for features with [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) or [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries and features with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [ObjectSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). * relative-to-ground | Features are placed at an elevation relative to the terrain surface. The feature's elevation is determined by summing up the terrain elevation and the geometry's z-value (if present). If `featureExpressionInfo` is defined, the result of the expression is used instead of the geometry’s z-value. `relative-to-ground` is the default value for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [IconSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html). * absolute-height | Features are placed at an absolute height above sea level. This height is determined by the geometry's z-value (if present). If `featureExpressionInfo` is defined, the result of the expression is used instead of the geometry’s z-value. This mode doesn't take the elevation of the terrain into account. This is the default value of features with any geometry type where [hasZ](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#hasZ) is `true`. * relative-to-scene | Features are aligned to buildings and other objects part of 3D Object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) or [IntegratedMeshLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html), depending on which has higher elevation. If the feature is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If defined, the result of `featureExpressionInfo` is added to the 3D Object/terrain surface elevation. In this mode z-values are ignored. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ mode: string; /** * An elevation offset, which is added to the vertical position of the feature. If `unit` is not defined, the offset is in `meters`. When `mode = "on-the-ground"`, this property has no effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ offset?: number; /** * This object contains information about setting a custom height on the feature. If this property is set, then z values are not considered for calculating feature height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ featureExpressionInfo?: FeatureLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. It doesn't apply to z-values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ unit?: string; @@ -8629,7 +8629,7 @@ declare namespace __esri { export interface FeatureLayerElevationInfoFeatureExpressionInfo extends Object { /** * An [Arcade expression](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) evaluating to a number that determines the height of the feature. If the geometry has z-values, they will be ignored and only `featureExpressionInfo` is used to calculate the vertical position of the feature. When `mode = "on-the-ground"`, this property has no effect. For line and polygon geometries the result of the expression is the same for all vertices of a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) */ expression?: string; @@ -8639,7 +8639,7 @@ declare namespace __esri { export interface FeatureLayerFeatureReduction extends Object { /** * Type of the decluttering method. The only supported type at the moment is `"selection"`. In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) */ type: string; @@ -8649,7 +8649,7 @@ declare namespace __esri { export interface FeatureLayerGetFieldDomainOptions extends Object { /** * The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#getFieldDomain) */ feature: Graphic; @@ -8673,13 +8673,13 @@ declare namespace __esri { export interface FeatureEditResultError extends Object { /** * Error name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ name: string; /** * Message describing the error. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#FeatureEditResult) */ message: string; @@ -8688,25 +8688,25 @@ declare namespace __esri { interface GeoRSSLayer extends Layer, ScaleRangeLayer { /** * Symbol used to represent line features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#lineSymbol) */ lineSymbol: SimpleLineSymbol; /** * Symbol used to represent point features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#pointSymbol) */ pointSymbol: PictureMarkerSymbol; /** * Symbol used to represent polygon features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#polygonSymbol) */ polygonSymbol: SimpleFillSymbol; /** * The URL pointing to a GeoRSS file. This must be publicly available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#url) */ url: string; @@ -8720,7 +8720,7 @@ declare namespace __esri { interface GeoRSSLayerConstructor { /** * The GeoRSSLayer class is used to create a layer based on [GeoRSS](http://www.georss.org/). GeoRSS is a way to add geographic information to an RSS feed. The GeoRSSLayer supports both `GeoRSS-Simple` and `GeoRSS GML` encodings, and multiple geometry types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html) */ @@ -8732,25 +8732,25 @@ declare namespace __esri { interface GeoRSSLayerProperties extends LayerProperties, ScaleRangeLayerProperties { /** * Symbol used to represent line features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#lineSymbol) */ lineSymbol?: SimpleLineSymbolProperties; /** * Symbol used to represent point features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#pointSymbol) */ pointSymbol?: PictureMarkerSymbolProperties; /** * Symbol used to represent polygon features from the GeoRSS feed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#polygonSymbol) */ polygonSymbol?: SimpleFillSymbolProperties; /** * The URL pointing to a GeoRSS file. This must be publicly available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html#url) */ url?: string; @@ -8773,74 +8773,74 @@ declare namespace __esri { interface GraphicsLayer extends Layer, ScaleRangeLayer { /** * Specifies how graphics are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ elevationInfo: GraphicsLayerElevationInfo; /** * A collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the layer. Each graphic is a vector representation of the location of a real-world feature. Each graphic in a single GraphicsLayer may contain either a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), or [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry). In addition, each [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the collection may contain its own [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes), [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html), and [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). To add a graphic to the GraphicsLayer use [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#add), or [GraphicsLayer.graphics.add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) */ graphics: Collection; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled: boolean; /** * For [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) the type is `graphics`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#type) */ readonly type: "graphics"; /** * Adds a graphic to the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#add) - * + * * @param graphic The graphic to add to the layer. - * + * */ add(graphic: Graphic): void; /** * Adds an array of graphics to the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#addMany) - * + * * @param graphics The graphic(s) to add to the layer. - * + * */ addMany(graphics: Graphic[]): void; /** * Removes a graphic from the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#remove) - * + * * @param graphic The graphic to remove from the layer. - * + * */ remove(graphic: Graphic): void; /** * Clears all the graphics from the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#removeAll) - * - * + * + * */ removeAll(): void; /** * Removes an array of graphics from the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#removeMany) - * + * * @param graphics The graphics to remove from the layer. - * + * */ removeMany(graphics: Graphic[]): void; @@ -8853,7 +8853,7 @@ declare namespace __esri { interface GraphicsLayerConstructor { /** * A GraphicsLayer contains one or more client-side [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Each [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) in the GraphicsLayer is rendered in a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) inside either a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). The [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) contain discrete vector [geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that represent real-world phenomena. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) */ @@ -8865,22 +8865,22 @@ declare namespace __esri { interface GraphicsLayerProperties extends LayerProperties, ScaleRangeLayerProperties { /** * Specifies how graphics are placed on the vertical axis (z). This property may only be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ elevationInfo?: GraphicsLayerElevationInfo; /** * A collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the layer. Each graphic is a vector representation of the location of a real-world feature. Each graphic in a single GraphicsLayer may contain either a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), or [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#geometry). In addition, each [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the collection may contain its own [attributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#attributes), [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html), and [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). To add a graphic to the GraphicsLayer use [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#add), or [GraphicsLayer.graphics.add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#graphics) */ graphics?: CollectionProperties; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled?: boolean; @@ -8889,33 +8889,33 @@ declare namespace __esri { export interface GraphicsLayerElevationInfo extends Object { /** - * Defines how the graphic is placed with respect to the terrain surface. If the geometry consists of multiple points (e.g. lines or polygons), the elevation is evaluated separately for each point. See the table below for a list of possible values. - * + * Defines how the graphic is placed with respect to the terrain surface. If the geometry consists of multiple points (e.g. lines or polygons), the elevation is evaluated separately for each point. See the table below for a list of possible values. + * * Mode | Description * ------|------------ * on-the-ground | Graphics are placed on the terrain surface. * relative-to-ground | Graphics are placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up * the terrain elevation, and the geometry's z-value (if present). In case `featureExpressionInfo` is defined, the result of the expression is used * instead of the geometry’s z-value. absolute-height | Graphics are placed at an absolute height above sea level. This height is determined by the geometry's z-value (if present). If `featureExpressionInfo` is defined, the result of the expression is used instead of the geometry’s z-value. It doesn't take the elevation of the terrain into account. relative-to-scene | Graphics are aligned to buildings and other objects part of 3D Object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) or [IntegratedMeshLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html), depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If defined, the result of `featureExpressionInfo` is added to the 3D Object/terrain surface elevation. In this mode z-values are ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ mode: string; /** * An elevation offset, which is added to the vertical position of the graphic. If `unit` is not defined, the offset is in `meters`. When `mode = "on-the-ground"`, this property has no effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ offset?: number; /** * This object contains information about setting a custom height on the graphic. If this property is set, then z values are not considered for calculating graphic height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ featureExpressionInfo?: GraphicsLayerElevationInfoFeatureExpressionInfo; /** * The unit for `featureExpressionInfo` and `offset` values. It doesn't apply to z-values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ unit?: string; @@ -8925,7 +8925,7 @@ declare namespace __esri { export interface GraphicsLayerElevationInfoFeatureExpressionInfo extends Object { /** * An [Arcade expression](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) evaluating to a number that determines the height of the graphic. If the geometry has z-values, they will be ignored and only `featureExpressionInfo` is used to calculate the vertical position of the graphic. When `mode = "on-the-ground"`, this property has no effect. For line and polygon geometries the result of the expression is the same for all vertices of a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#elevationInfo) */ expression?: string; @@ -8947,15 +8947,15 @@ declare namespace __esri { interface GroupLayer extends Layer, LayersMixin, PortalLayer { /** - * Indicates how to manage the visibility of the children layers. Possible values are described in the table below. - * + * Indicates how to manage the visibility of the children layers. Possible values are described in the table below. + * * Value | Description * ------|------------ * independent | Each child layer manages its visibility independent from other layers. * inherited | Each child layer's visibility matches the [GroupLayer’s visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visible). * exclusive | Only one child layer is visible at a time. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visibilityMode) */ visibilityMode: string; @@ -8969,7 +8969,7 @@ declare namespace __esri { interface GroupLayerConstructor { /** * GroupLayer provides the ability to organize several sublayers into one common layer. Suppose there are several [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) that all represent water features in different dimensions. For example, wells (points), streams (lines), and lakes (polygons). The GroupLayer provides the functionality to treat them as one layer called "Water Features" even though they are stored as separate feature layers. To accomplish this, create a new GroupLayer and use the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#add) method to add each of the water layers to the GroupLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) */ @@ -8982,15 +8982,15 @@ declare namespace __esri { interface GroupLayerProperties extends LayerProperties, LayersMixinProperties, PortalLayerProperties { /** - * Indicates how to manage the visibility of the children layers. Possible values are described in the table below. - * + * Indicates how to manage the visibility of the children layers. Possible values are described in the table below. + * * Value | Description * ------|------------ * independent | Each child layer manages its visibility independent from other layers. * inherited | Each child layer's visibility matches the [GroupLayer’s visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visible). * exclusive | Only one child layer is visible at a time. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#visibilityMode) */ visibilityMode?: string; @@ -9013,37 +9013,37 @@ declare namespace __esri { interface ImageryLayer extends Layer, ArcGISImageService, ScaleRangeLayer, RefreshableLayer { /** * A function that processes [pixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData). The `pixelData` object contains a [pixelBlock](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html) property that gives you access to all of the pixels in the raster on the client. Inside the `pixelFilter` you may loop through all the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) found in the `pixelBlock` property of the `pixelData` object and process them. This function may be used to hide some pixels from the view, alter their values, and change their color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) */ pixelFilter: Function; /** * Indicates whether to display popups when the layer is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * The portal item from which the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#portalItem) */ portalItem: PortalItem; /** * Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use [IdentityManager.registerToken()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#token) */ readonly token: string; /** * Executes the [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function and redraws the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#redraw) - * - * + * + * */ redraw(): void; @@ -9056,7 +9056,7 @@ declare namespace __esri { interface ImageryLayerConstructor { /** * Represents an image service resource as a layer. An ImageryLayer retrieves and displays data from image services. ImageryLayer allows you to and apply client side [pixel filtering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter), server defined or client-defined [rendering rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#renderingRule) (e.g. remap, colormap), and [mosaic rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#mosaicRule). This layer is particularly useful when you need to interactively change pixel manipulation criteria and get an immediate response on the client. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) */ @@ -9070,21 +9070,21 @@ declare namespace __esri { interface ImageryLayerProperties extends LayerProperties, ArcGISImageServiceProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * A function that processes [pixelData](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData). The `pixelData` object contains a [pixelBlock](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html) property that gives you access to all of the pixels in the raster on the client. Inside the `pixelFilter` you may loop through all the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) found in the `pixelBlock` property of the `pixelData` object and process them. This function may be used to hide some pixels from the view, alter their values, and change their color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) */ pixelFilter?: Function; /** * Indicates whether to display popups when the layer is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * The portal item from which the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#portalItem) */ portalItem?: PortalItemProperties; @@ -9107,7 +9107,7 @@ declare namespace __esri { interface IntegratedMeshLayer extends Layer, SceneService, PortalLayer { /** * Specifies how the mesh is placed on the vertical axis (z). This property only affects [IntegratedMeshLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html) when using the `absolute-height` mode. Integrated mesh layers always render in front of the ground surface, so setting negative offset values will not render them below the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ elevationInfo: IntegratedMeshLayerElevationInfo; @@ -9121,7 +9121,7 @@ declare namespace __esri { interface IntegratedMeshLayerConstructor { /** * The IntegratedMeshLayer is designed for visualizing accurate representations in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) of infrastructure and natural landscapes that are difficult to access. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html) */ @@ -9135,7 +9135,7 @@ declare namespace __esri { interface IntegratedMeshLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties { /** * Specifies how the mesh is placed on the vertical axis (z). This property only affects [IntegratedMeshLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html) when using the `absolute-height` mode. Integrated mesh layers always render in front of the ground surface, so setting negative offset values will not render them below the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ elevationInfo?: IntegratedMeshLayerElevationInfo; @@ -9144,29 +9144,29 @@ declare namespace __esri { export interface IntegratedMeshLayerElevationInfo extends Object { /** - * Defines how the mesh is placed on the vertical axis (z). Currently only `absolute-height` is supported. - * + * Defines how the mesh is placed on the vertical axis (z). Currently only `absolute-height` is supported. + * * Mode | Description * ------|------------ * absolute-height | The mesh is placed at an absolute height above sea level. This height is determined by summing up the `offset` value and the mesh's z-value. It doesn't take the elevation of the terrain into account. This is the only supported elevation mode for an IntegratedMeshLayer. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) */ mode: string; /** * An elevation offset, which is added to the vertical position of the mesh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) - * + * * @default 0 */ offset?: number; /** * The unit for `offset` values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html#elevationInfo) - * + * * @default meters */ unit?: string; @@ -9189,13 +9189,13 @@ declare namespace __esri { interface KMLLayer extends Layer, PortalLayer, ScaleRangeLayer { /** * A collection of [KMLSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#sublayers) */ sublayers: Collection; /** * The publicly accessible URL for a .kml or .kmz file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#url) */ url: string; @@ -9209,7 +9209,7 @@ declare namespace __esri { interface KMLLayerConstructor { /** * The KMLLayer class is used to create a layer based on a KML file (.kml, .kmz). KML is an XML-based file format used to represent geographic features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) */ @@ -9223,13 +9223,13 @@ declare namespace __esri { interface KMLLayerProperties extends LayerProperties, PortalLayerProperties, ScaleRangeLayerProperties { /** * A collection of [KMLSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The publicly accessible URL for a .kml or .kmz file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html#url) */ url?: string; @@ -9252,74 +9252,74 @@ declare namespace __esri { interface Layer extends Accessor, Loadable, Evented { /** * The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) */ id: string; /** - * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. The possible values are listed below. - * + * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. The possible values are listed below. + * * Value | Description * ------|------------ * show | The layer is visible in the table of contents. * hide | The layer is hidden in the table of contents. * hide-children | If the layer is a [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html), hide the children layers from the table of contents. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) - * + * * @default show */ listMode: string; /** * Indicates whether the layer's resources have loaded. When `true`, all the properties of the object can be accessed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The opacity of the layer. This value can range between `1` and `0`, where `0` is 100 percent transparent and `1` is completely opaque. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity) - * + * * @default 1 */ opacity: number; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widgets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#title) */ title: string; /** * The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules. **Possible values:** base-dynamic | base-elevation | base-tile | bing-maps | elevation | feature | graphics | group | imagery | integrated-mesh | map-image | open-street-map | point-cloud | scene | stream | tile | unknown | unsupported | vector-tile | web-tile - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#type) */ readonly type: string; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). When `false`, the layer may still be added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance that is referenced in a view, but its features will not be visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible) - * + * * @default true */ visible: boolean; /** * Fetches custom attribution data for the layer when it becomes available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fetchAttributionData) - * - * + * + * */ fetchAttributionData(): IPromise; } @@ -9327,7 +9327,7 @@ declare namespace __esri { interface LayerConstructor { /** * The layer is the most fundamental component of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). It is a collection of spatial data in the form of vector graphics or raster images that represent real-world phenomena. Layers may contain discrete features that store vector data or continuous cells/pixels that store raster data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) */ @@ -9336,23 +9336,23 @@ declare namespace __esri { /** * Creates a new layer instance from an ArcGIS Server URL. Depending on the URL, the returned layer type may be a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html), [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html). This is useful when you work with various ArcGIS Server URLs, but you don't necessarily know which layer type(s) they create. This method creates the appropriate layer type for you. In case of a feature service or a scene service, when the URL points to the service and the service has multiple layers, the returned promise will resolve to a [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromArcGISServerUrl) - * + * * @param params Input parameters for creating the layer. * @param params.url The ArcGIS Server URL used to create the layer. * @param params.properties Set any of the layer's properties here for constructing the layer instance (e.g. popupTemplate, renderer, etc.). - * + * */ fromArcGISServerUrl(params: LayerFromArcGISServerUrlParams): IPromise; /** * Creates a new layer instance of the appropriate layer class from an ArcGIS Online or ArcGIS Enterprise [portal item](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). If the item points to a feature service with multiple layers, then a [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) is created. If the item points to a service with a single layer, then it resolves to a layer of the same type of class as the service. See also: [isLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#isLayer) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromPortalItem) - * + * * @param params The parameters for loading the portal item. * @param params.portalItem The object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the layer. - * + * */ fromPortalItem(params: LayerFromPortalItemParams): IPromise; } @@ -9362,50 +9362,50 @@ declare namespace __esri { interface LayerProperties extends LoadableProperties { /** * The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) */ id?: string; /** - * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. The possible values are listed below. - * + * Indicates how the layer should display in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. The possible values are listed below. + * * Value | Description * ------|------------ * show | The layer is visible in the table of contents. * hide | The layer is hidden in the table of contents. * hide-children | If the layer is a [GroupLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html), hide the children layers from the table of contents. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode) - * + * * @default show */ listMode?: string; /** * The opacity of the layer. This value can range between `1` and `0`, where `0` is 100 percent transparent and `1` is completely opaque. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity) - * + * * @default 1 */ opacity?: number; /** * The title of the layer used to identify it in places such as the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widgets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#title) */ title?: string; /** * Indicates if the layer is visible in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). When `false`, the layer may still be added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance that is referenced in a view, but its features will not be visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible) - * + * * @default true */ visible?: boolean; @@ -9415,13 +9415,13 @@ declare namespace __esri { export interface LayerFromArcGISServerUrlParams extends Object { /** * The ArcGIS Server URL used to create the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromArcGISServerUrl) */ url: string; /** * Set any of the layer's properties here for constructing the layer instance (e.g. popupTemplate, renderer, etc.). - * + * * [Read more...](properties.html) */ properties?: any; @@ -9431,7 +9431,7 @@ declare namespace __esri { export interface LayerFromPortalItemParams extends Object { /** * The object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fromPortalItem) */ portalItem: PortalItem; @@ -9440,13 +9440,13 @@ declare namespace __esri { interface MapImageLayer extends Layer, SublayersOwner, ArcGISMapService, ArcGISDynamicMapService, DynamicLayer, ScaleRangeLayer, RefreshableLayer { /** * A flat [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of all the [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) in the MapImageLayer including the sublayers of its sublayers. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#allSublayers) */ readonly allSublayers: Collection; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects that allow you to alter the properties of one or more sublayers of the MapImageLayer. If this property is not specified, all the sublayers from the service are displayed as defined in the service. If an empty array is passed to this property then none of the sublayers from the service are displayed in the layer. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). They may be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add), [removed](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#remove), or [reordered](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#reorder) using the [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) methods. Because [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) extends [Accessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html), its properties may be [watched](https://developers.arcgis.com/javascript/latest/guide/working-with-props/index.html#watchProperties). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) */ sublayers: Collection; @@ -9460,7 +9460,7 @@ declare namespace __esri { interface MapImageLayerConstructor { /** * MapImageLayer allows you to display and analyze data from [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) defined in a [map service](http://server.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm), exporting images instead of features. Map service images are dynamically generated on the server based on a request, which includes an LOD (level of detail), a bounding box, dpi, spatial reference and other options. The exported image is of the entire map extent specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) */ @@ -9474,7 +9474,7 @@ declare namespace __esri { interface MapImageLayerProperties extends LayerProperties, ArcGISMapServiceProperties, ArcGISDynamicMapServiceProperties, DynamicLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects that allow you to alter the properties of one or more sublayers of the MapImageLayer. If this property is not specified, all the sublayers from the service are displayed as defined in the service. If an empty array is passed to this property then none of the sublayers from the service are displayed in the layer. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). They may be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add), [removed](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#remove), or [reordered](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#reorder) using the [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) methods. Because [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) extends [Accessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html), its properties may be [watched](https://developers.arcgis.com/javascript/latest/guide/working-with-props/index.html#watchProperties). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#sublayers) */ sublayers?: CollectionProperties; @@ -9504,7 +9504,7 @@ declare namespace __esri { interface MapNotesLayerConstructor { /** * The MapNotesLayer is used to create layers based on Map Notes within a WebMap or PortalItem. Map notes are part of web maps, and are typically created with ArcGIS Online MapViewer. For additional information, please refer to the ArcGIS Online documentation on how to [Add Map notes](http://doc.arcgis.com/en/arcgis-online/create-maps/add-layers.htm#ESRI_SECTION1_0C90A3B63ABD49D5B9535055991F4684). Within the [web map specification](https://developers.arcgis.com/web-map-specification/), map notes are a special type of [FeatureCollections](https://developers.arcgis.com/web-map-specification/objects/featureCollection/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html) */ @@ -9536,19 +9536,19 @@ declare namespace __esri { interface ArcGISCachedService { /** * The copyright text as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#copyright) */ copyright: string; /** * The spatial reference of the layer as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Contains information about the tiling scheme for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#tileInfo) */ tileInfo: TileInfo; @@ -9567,13 +9567,13 @@ declare namespace __esri { interface ArcGISCachedServiceProperties { /** * The copyright text as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#copyright) */ copyright?: string; /** * Contains information about the tiling scheme for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISCachedService.html#tileInfo) */ tileInfo?: TileInfoProperties; @@ -9582,62 +9582,62 @@ declare namespace __esri { interface ArcGISDynamicMapService { /** * The output dots per inch (DPI) of the MapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#dpi) - * + * * @default 96 */ dpi: number; /** * The version of the geodatabase of the map service data. Read the [Overview of versioning](https://desktop.arcgis.com/en/arcmap/latest/manage-data/geodatabases/an-overview-of-versioning.htm) topic for more details about this capability. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#gdbVersion) */ gdbVersion: string; /** * The output image type. **Possible Values:** png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svg | pngjpg - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageFormat) - * + * * @default png24 */ imageFormat: string; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageMaxHeight) - * + * * @default 2048 */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageMaxWidth) - * + * * @default 2048 */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageTransparency) - * + * * @default true */ imageTransparency: boolean; /** * Gets the parameters of the exported image to use when calling the [export REST operation](https://developers.arcgis.com/rest/services-reference/export-map.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#createExportImageParameters) - * + * * @param extent The extent of the exported image * @param width The width of the exported image * @param height The height of the exported image * @param options The parameter options is an object with the following properties. * @param options.rotation The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. - * + * */ createExportImageParameters(extent: Extent, width: number, height: number, options?: ArcGISDynamicMapServiceCreateExportImageParametersOptions): any; } @@ -9653,47 +9653,47 @@ declare namespace __esri { interface ArcGISDynamicMapServiceProperties { /** * The output dots per inch (DPI) of the MapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#dpi) - * + * * @default 96 */ dpi?: number; /** * The version of the geodatabase of the map service data. Read the [Overview of versioning](https://desktop.arcgis.com/en/arcmap/latest/manage-data/geodatabases/an-overview-of-versioning.htm) topic for more details about this capability. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#gdbVersion) */ gdbVersion?: string; /** * The output image type. **Possible Values:** png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svg | pngjpg - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageFormat) - * + * * @default png24 */ imageFormat?: string; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageMaxHeight) - * + * * @default 2048 */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageMaxWidth) - * + * * @default 2048 */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#imageTransparency) - * + * * @default true */ imageTransparency?: boolean; @@ -9703,7 +9703,7 @@ declare namespace __esri { export interface ArcGISDynamicMapServiceCreateExportImageParametersOptions extends Object { /** * The rotation in degrees of the exported image. Available since ArcGIS Server 10.3. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISDynamicMapService.html#createExportImageParameters) */ rotation?: number; @@ -9712,162 +9712,162 @@ declare namespace __esri { interface ArcGISImageService { /** * The compression quality value. This controls how much loss the image will be subjected to. Only valid when using `jpg` [image format](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionQuality) */ compressionQuality: number; /** * The output image compression tolerance value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionTolerance) - * + * * @default 0.01 */ compressionTolerance: number; /** * The copyright text as defined by the image service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#copyright) */ copyright: string; /** * The SQL where clause used to filter rasters on the client. Only the rasters that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#definitionExpression) */ definitionExpression: string; /** * An array of fields in the layer for which a [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) has been defined. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#domainFields) */ domainFields: Field[]; /** * An array of fields in the layer. Each field represents an attribute that may contain a value for each raster in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) */ fields: Field[]; /** * The output image type. The default value is `lerc` if a [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelFilter) is set on the layer. **Possible Values:** png | png8 | png24 | png32 | jpg | bmp | gif | jpgpng | lerc - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format) - * + * * @default jpgpng */ format: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fullExtent) */ fullExtent: Extent; /** * Indicates if the Image Service has [multidimensionalInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasMultidimensions) */ hasMultidimensions: boolean; /** * Indicates if the Image Service has a [raster attribute table](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable). If `true`, the raster attribute table can be accessed with the [rasterAttributeTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable) property after the layer has [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasRasterAttributeTable) */ hasRasterAttributeTable: boolean; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxHeight) - * + * * @default 4100 */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxWidth) - * + * * @default 15000 */ imageMaxWidth: number; /** * Defines how overlapping images should be mosaicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule) */ mosaicRule: MosaicRule; /** * The multidimensional information associated with the service. This will have a value if `serviceInfo` has `hasMultidimensionalInfo = true`. If defined, multidimensional information contains various "dimensions" of data for a particular value, such as time, depth, altitude, etc. Defining slices of particular dimensions in the layer is handled with the [multidimensionalDefinition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) property of the [mosaicRule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo) */ multidimensionalInfo: any; /** * The pixel type. **Possible Values:** s8 | s16 | s32 | u8 | u16 | u32 | f32 | f64 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelType) */ pixelType: string; /** * The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values using text and/or charts in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a pixel is clicked. See [this sample](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-popup/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The raster attribute table associated with the service. To access the raster attribute table, the layer must be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable) */ rasterAttributeTable: any; /** * Prefix used to define the fields from the raster attribute table. It's primarily used for [popups](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTableFieldPrefix) - * + * * @default Raster. */ rasterAttributeTableFieldPrefix: string; /** * A complete list of fields that consists of fields from the layer, pixel value fields and the attribute table fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFields) */ rasterFields: Field[]; /** * Specifies the rule for how the requested image should be rendered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderingRule) */ renderingRule: RasterFunction; /** * The spatial reference of the image service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * The URL to the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#url) */ url: string; /** * The version of ArcGIS Server in which the image service is published. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#version) */ readonly version: number; /** * Returns an image using the [export REST operation](https://developers.arcgis.com/rest/services-reference/export-image.htm) that displays data from an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fetchImage) - * + * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. - * + * */ fetchImage(extent: Extent, width: number, height: number): IPromise; } @@ -9885,137 +9885,137 @@ declare namespace __esri { interface ArcGISImageServiceProperties { /** * The compression quality value. This controls how much loss the image will be subjected to. Only valid when using `jpg` [image format](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionQuality) */ compressionQuality?: number; /** * The output image compression tolerance value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#compressionTolerance) - * + * * @default 0.01 */ compressionTolerance?: number; /** * The copyright text as defined by the image service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#copyright) */ copyright?: string; /** * The SQL where clause used to filter rasters on the client. Only the rasters that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#definitionExpression) */ definitionExpression?: string; /** * An array of fields in the layer for which a [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) has been defined. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#domainFields) */ domainFields?: FieldProperties[]; /** * An array of fields in the layer. Each field represents an attribute that may contain a value for each raster in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fields) */ fields?: FieldProperties[]; /** * The output image type. The default value is `lerc` if a [pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelFilter) is set on the layer. **Possible Values:** png | png8 | png24 | png32 | jpg | bmp | gif | jpgpng | lerc - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#format) - * + * * @default jpgpng */ format?: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#fullExtent) */ fullExtent?: ExtentProperties; /** * Indicates if the Image Service has [multidimensionalInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasMultidimensions) */ hasMultidimensions?: boolean; /** * Indicates if the Image Service has a [raster attribute table](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable). If `true`, the raster attribute table can be accessed with the [rasterAttributeTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable) property after the layer has [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#hasRasterAttributeTable) */ hasRasterAttributeTable?: boolean; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxHeight) - * + * * @default 4100 */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#imageMaxWidth) - * + * * @default 15000 */ imageMaxWidth?: number; /** * Defines how overlapping images should be mosaicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * The multidimensional information associated with the service. This will have a value if `serviceInfo` has `hasMultidimensionalInfo = true`. If defined, multidimensional information contains various "dimensions" of data for a particular value, such as time, depth, altitude, etc. Defining slices of particular dimensions in the layer is handled with the [multidimensionalDefinition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) property of the [mosaicRule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#mosaicRule). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#multidimensionalInfo) */ multidimensionalInfo?: any; /** * The pixel type. **Possible Values:** s8 | s16 | s32 | u8 | u16 | u32 | f32 | f64 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#pixelType) */ pixelType?: string; /** * The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values using text and/or charts in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a pixel is clicked. See [this sample](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-popup/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The raster attribute table associated with the service. To access the raster attribute table, the layer must be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#loaded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTable) */ rasterAttributeTable?: any; /** * Prefix used to define the fields from the raster attribute table. It's primarily used for [popups](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterAttributeTableFieldPrefix) - * + * * @default Raster. */ rasterAttributeTableFieldPrefix?: string; /** * A complete list of fields that consists of fields from the layer, pixel value fields and the attribute table fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#rasterFields) */ rasterFields?: FieldProperties[]; /** * Specifies the rule for how the requested image should be rendered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#renderingRule) */ renderingRule?: RasterFunctionProperties; /** * The URL to the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISImageService.html#url) */ url?: string; @@ -10024,45 +10024,45 @@ declare namespace __esri { interface ArcGISMapService { /** * Indicates the layer's supported capabilities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ readonly capabilities: ArcGISMapServiceCapabilities; /** * The copyright text as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#copyright) */ copyright: string; /** * The full extent of the layer as defined by the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#fullExtent) */ fullExtent: Extent; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The spatial reference of the layer as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#spatialReference) */ readonly spatialReference: SpatialReference; /** * Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use [IdentityManager.registerToken()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#token) */ readonly token: string; /** * The version of ArcGIS Server in which the map service is published. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#version) */ readonly version: number; @@ -10081,21 +10081,21 @@ declare namespace __esri { interface ArcGISMapServiceProperties { /** * The copyright text as defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#copyright) */ copyright?: string; /** * The full extent of the layer as defined by the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#fullExtent) */ fullExtent?: ExtentProperties; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; @@ -10105,19 +10105,19 @@ declare namespace __esri { export interface ArcGISMapServiceCapabilities extends Object { /** * Indicates options supported by the exportMap operation. Will be `null` if the `supportsExportMap` is `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ exportMap: ArcGISMapServiceCapabilitiesExportMap; /** * Indicates options supported by the exportTiles operation. Will be `null` if the `supportsExportTiles` is `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ exportTiles: ArcGISMapServiceCapabilitiesExportTiles; /** * Indicates operations that can be performed on the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ operations: ArcGISMapServiceCapabilitiesOperations; @@ -10127,25 +10127,25 @@ declare namespace __esri { export interface ArcGISMapServiceCapabilitiesExportMap extends Object { /** * Indicates if sublayers can be added, removed, or reordered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayersChanges: boolean; /** * Indicates if sublayers rendering can be modified or added using dynamic layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsDynamicLayers: boolean; /** * Indicates if sublayers [visibility](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) can be changed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayerVisibility: boolean; /** * Indicates if sublayers [definition expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) can be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsSublayerDefinitionExpression: boolean; @@ -10155,7 +10155,7 @@ declare namespace __esri { export interface ArcGISMapServiceCapabilitiesExportTiles extends Object { /** * Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ maxExportTilesCount: number; @@ -10165,25 +10165,25 @@ declare namespace __esri { export interface ArcGISMapServiceCapabilitiesOperations extends Object { /** * Indicates if features in the sublayers can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsQuery: boolean; /** * Indicates if the service can generate images. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsExportMap: boolean; /** * Indicates if the tiles from the service can be exported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsExportTiles: boolean; /** * Indicates if the service exposes a tile map that describes the presence of tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ArcGISMapService.html#capabilities) */ supportsTileMap: boolean; @@ -10192,7 +10192,7 @@ declare namespace __esri { interface PortalLayer { /** * The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#layerId) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#portalItem) */ portalItem: PortalItem; @@ -10211,7 +10211,7 @@ declare namespace __esri { interface PortalLayerProperties { /** * The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#layerId) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-PortalLayer.html#portalItem) */ portalItem?: PortalItemProperties; @@ -10220,19 +10220,19 @@ declare namespace __esri { interface RefreshableLayer { /** * Refresh interval of the layer in minutes. Minimum refresh interval is 0.1 minute (6 seconds). Value of `0` indicates no refresh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval) - * + * * @default 0 */ refreshInterval: number; /** * Fetches all the data for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refresh) - * - * + * + * */ refresh(): void; } @@ -10248,9 +10248,9 @@ declare namespace __esri { interface RefreshableLayerProperties { /** * Refresh interval of the layer in minutes. Minimum refresh interval is 0.1 minute (6 seconds). Value of `0` indicates no refresh. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval) - * + * * @default 0 */ refreshInterval?: number; @@ -10259,17 +10259,17 @@ declare namespace __esri { interface ScaleRangeLayer { /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) - * + * * @default 0 */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) - * + * * @default 0 */ minScale: number; @@ -10286,17 +10286,17 @@ declare namespace __esri { interface ScaleRangeLayerProperties { /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) - * + * * @default 0 */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale) - * + * * @default 0 */ minScale?: number; @@ -10305,42 +10305,42 @@ declare namespace __esri { interface SceneService { /** * The copyright text as defined by the scene service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#copyright) */ copyright: string; /** - * The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: + * The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: * * When loading the layer via the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property. * * When pointing the layer [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) directly to the Scene Service. - * - * + * + * * If a layerId is not specified in either of the above scenarios, then the first layer in the service (`layerId = 0`) is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) */ layerId: number; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#spatialReference) */ spatialReference: SpatialReference; /** * Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use [IdentityManager.registerToken()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#token) */ readonly token: string; /** * The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. The layer may be specified using the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) property when the url points directly to a service and not a specific layer. If [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) is not specified, then it will default to the first layer in the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) */ url: string; /** * The version of the scene service specification used for this service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ readonly version: SceneServiceVersion; @@ -10359,30 +10359,30 @@ declare namespace __esri { interface SceneServiceProperties { /** * The copyright text as defined by the scene service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#copyright) */ copyright?: string; /** - * The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: + * The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer with the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property from a service containing multiple layers. You can specify this value in one of two scenarios: * * When loading the layer via the [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#portalItem) property. * * When pointing the layer [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) directly to the Scene Service. - * - * + * + * * If a layerId is not specified in either of the above scenarios, then the first layer in the service (`layerId = 0`) is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) */ layerId?: number; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. The layer may be specified using the [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) property when the url points directly to a service and not a specific layer. If [layerId](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#layerId) is not specified, then it will default to the first layer in the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#url) */ url?: string; @@ -10392,19 +10392,19 @@ declare namespace __esri { export interface SceneServiceVersion extends Object { /** * The major version of the scene layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ major: number; /** * The minor version of the scene layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ minor: number; /** * The complete version string of the scene layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SceneService.html#version) */ versionString: string; @@ -10413,19 +10413,19 @@ declare namespace __esri { interface SublayersOwner { /** * Returns a deep clone of a map service's [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) as defined by the service. This is useful for scenarios when the developer is unfamiliar with the service sublayers and needs to "reset" the layer's sublayers to match those defined by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SublayersOwner.html#createServiceSublayers) - * - * + * + * */ createServiceSublayers(): Collection; /** * Returns the sublayer with the given layerId. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-SublayersOwner.html#findSublayerById) - * + * * @param id The [id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) of the sublayer. - * + * */ findSublayerById(id: number): Sublayer; } @@ -10474,27 +10474,27 @@ declare namespace __esri { interface PointCloudLayer extends Layer, SceneService, PortalLayer { /** * Specifies how points are placed on the vertical axis (z). This property only affects [PointCloudLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) when using the `absolute-height` mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ elevationInfo: PointCloudLayerElevationInfo; /** * An array of fields accessible in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#fields) */ fields: Field[]; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The renderer assigned to the layer. The renderer defines how to visualize each point in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#renderer) */ renderer: PointCloudRenderer; @@ -10508,7 +10508,7 @@ declare namespace __esri { interface PointCloudLayerConstructor { /** * The PointCloudLayer is designed for visualizing large collections of points in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) */ @@ -10522,27 +10522,27 @@ declare namespace __esri { interface PointCloudLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties { /** * Specifies how points are placed on the vertical axis (z). This property only affects [PointCloudLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) when using the `absolute-height` mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ elevationInfo?: PointCloudLayerElevationInfo; /** * An array of fields accessible in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#fields) */ fields?: FieldProperties[]; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The renderer assigned to the layer. The renderer defines how to visualize each point in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#renderer) */ renderer?: PointCloudRendererProperties; @@ -10565,29 +10565,29 @@ declare namespace __esri { export interface PointCloudLayerElevationInfo extends Object { /** - * Defines how the points are placed on the vertical axis (z). Currently only `absolute-height` mode is supported. - * + * Defines how the points are placed on the vertical axis (z). Currently only `absolute-height` mode is supported. + * * Mode | Description * ------|------------ * absolute-height | Points are placed at an absolute height above sea level. This height is determined by summing up the `offset` value and the point's z-value. It doesn't take the elevation of the terrain into account. This is the only supported elevation mode for a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) */ mode: string; /** * An elevation offset, which is added to the vertical position of each point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) - * + * * @default 0 */ offset?: number; /** * The unit for `offset` values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#elevationInfo) - * + * * @default meters */ unit?: string; @@ -10596,153 +10596,153 @@ declare namespace __esri { interface SceneLayer extends Layer, SceneService, PortalLayer { /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when only a subset of the data in the layer should be displayed. Setting the definition expression of a layer automatically updates all layer views. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. Important to note is that the initial loading time of the features remains unchanged, even if they are filtered. This happens because, as opposed to Feature Layers, feature filtering is done client-side. As a result all features need to be downloaded always for filter evaluation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#definitionExpression) */ definitionExpression: string; /** * Specifies how graphics are placed on the vertical axis (z). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. This property only affects 3D Object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) when using the `absolute-height` mode. [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries support all the elevation modes listed below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ elevationInfo: SceneLayerElevationInfo; /** - * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. This property is only supported for point scene layers with non-draped [Icon](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. [![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-point-styles/index.html) + * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. This property is only supported for point scene layers with non-draped [Icon](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. [![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-point-styles/index.html) * > **Known Limitation** When applying featureReduction on a point SceneLayer layer updates are slow. This will be addressed in upcoming releases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#featureReduction) */ featureReduction: SceneLayerFeatureReduction; /** * An array of fields accessible in the layer. Depending on the scene service, fields may have limited support for certain capabilities. Use [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) to query the contexts (rendering, labeling, popups or querying) for which a particular field may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fields) */ fields: Field[]; /** * The geometry type of features in the layer. **Possible Values:** point | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) */ geometryType: string; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) property of this layer must be set to `true`. + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) property of this layer must be set to `true`. * > **Known Limitations** This property is only relevant to SceneLayers with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries. This property has no effect on SceneLayers with other geometry types. Each point can have only one label. Multiple [Label classes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) with different [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) clauses can be used to have different label styles on different features that belong to the same layer (for example blue labels for lakes and green labels for parks). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) property. This property is only relevant to SceneLayers with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries. This property has no effect on SceneLayers with other geometry types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The name of the field containing each graphic's Object ID. If this is not explicitly specified, this is automatically derived from the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fields) of the service by taking the first field of type `oid`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#objectIdField) */ objectIdField: string; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). Setting a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) on this layer type is done in the same way as a FeatureLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) */ renderer: Renderer; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled: boolean; /** * Creates a query object that can be used to fetch features that satisfy the layer's current definition expression. The query should only be used on the layer and not on the layer view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#createQuery) - * - * + * + * */ createQuery(): Query; /** - * Gets field usage information. The usage of a field depends on whether it is stored as part of the scene service cache. The returned object contains the following usage information: - * + * Gets field usage information. The usage of a field depends on whether it is stored as part of the scene service cache. The returned object contains the following usage information: + * * Property | Type | Description * ----------------------|---------|------------ * supportsRenderer | boolean | Indicates that a field can be used in a renderer (e.g. in visual variables), [see renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer). * supportsLabelingInfo | boolean | Indicates that a field can be used for labeling, [see labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo). * supportsPopupTemplate | boolean | Indicates that a field can be used in a popup template, [see popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupTemplate). * supportsLayerQuery | boolean | Indicates that a field can be used in layer queries, [see queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) - * + * * @param fieldName The name of the field to get usage info for. - * + * */ getFieldUsageInfo(fieldName: string): any; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the service and returns the 2D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. At the moment the 3D Extent can be returned by using [SceneLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryExtent), but this will return the 3D extent only for features currently in the view. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the Query section of the class description above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryExtent) - * + * * @param params Specifies the query parameters. - * + * */ queryExtent(params?: Query): IPromise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the service and returns the number of the features that satisfy the query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the Query section of the class description above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatureCount) - * + * * @param params Specifies the query parameters. - * + * */ queryFeatureCount(params?: Query): IPromise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the service and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the Query section of the class description above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures) - * + * * @param params Specifies the query parameters. - * + * */ queryFeatures(params?: Query): IPromise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the service and returns an array of the ObjectIDs of features that satisfy the input query. The query succeeds only if the layer's `supportsLayerQuery` capability is enabled. Use the [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method to check if the layer supports queries. If querying is not enabled, then an error with the name `scenelayer:query-not-available` is thrown. Read more about queries in the Query section of the class description above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryObjectIds) - * + * * @param params Specifies the query parameters. - * + * */ queryObjectIds(params?: Query): IPromise; @@ -10755,7 +10755,7 @@ declare namespace __esri { interface SceneLayerConstructor { /** * The SceneLayer is a layer type designed for on-demand streaming and displaying large amounts of data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). SceneLayers support two geometry types: [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) and 3D Objects (e.g. Buildings). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) */ @@ -10769,90 +10769,90 @@ declare namespace __esri { interface SceneLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties { /** * The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Setting a definition expression is useful when only a subset of the data in the layer should be displayed. Setting the definition expression of a layer automatically updates all layer views. If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression. Important to note is that the initial loading time of the features remains unchanged, even if they are filtered. This happens because, as opposed to Feature Layers, feature filtering is done client-side. As a result all features need to be downloaded always for filter evaluation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#definitionExpression) */ definitionExpression?: string; /** * Specifies how graphics are placed on the vertical axis (z). See the [ElevationInfo sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-elevationinfo/index.html) for an example of how this property may be used. This property only affects 3D Object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) when using the `absolute-height` mode. [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries support all the elevation modes listed below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ elevationInfo?: SceneLayerElevationInfo; /** - * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. This property is only supported for point scene layers with non-draped [Icon](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. [![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-point-styles/index.html) + * Configures the method for decluttering overlapping features in the view. If this property is not set (or set to `null`), every feature is drawn individually. This property is only supported for point scene layers with non-draped [Icon](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) or [Text](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) symbol layers. [![declutter](https://developers.arcgis.com/javascript/assets/img/samples/city-points-declutter.gif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-point-styles/index.html) * > **Known Limitation** When applying featureReduction on a point SceneLayer layer updates are slow. This will be addressed in upcoming releases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#featureReduction) */ featureReduction?: SceneLayerFeatureReduction; /** * An array of fields accessible in the layer. Depending on the scene service, fields may have limited support for certain capabilities. Use [getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) to query the contexts (rendering, labeling, popups or querying) for which a particular field may be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. **Possible Values:** point | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) */ geometryType?: string; /** - * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) property of this layer must be set to `true`. + * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) property of this layer must be set to `true`. * > **Known Limitations** This property is only relevant to SceneLayers with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries. This property has no effect on SceneLayers with other geometry types. Each point can have only one label. Multiple [Label classes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) with different [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) clauses can be used to have different label styles on different features that belong to the same layer (for example blue labels for lakes and green labels for parks). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates whether to display labels for this layer. If `true`, labels will appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelingInfo) property. This property is only relevant to SceneLayers with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries. This property has no effect on SceneLayers with other geometry types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The name of the field containing each graphic's Object ID. If this is not explicitly specified, this is automatically derived from the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#fields) of the service by taking the first field of type `oid`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#objectIdField) */ objectIdField?: string; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * The popup template for the layer. When set on the layer, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when a feature is selected using text and/or charts. See the [PopupTemplate sample](https://developers.arcgis.com/javascript/latest/sample-code/intro-popuptemplate/index.html) for an example of how [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) interacts with a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). Setting a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) on this layer type is done in the same way as a FeatureLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * The renderer assigned to the layer. The renderer defines how to visualize each feature in the layer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#renderer) */ renderer?: RendererProperties; /** - * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) + * Apply perspective scaling to screen-size point symbols in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When `true`, screen sized objects such as [icons](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) or [callouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) integrate better in the 3D scene by applying a certain perspective projection to the sizing of features. This only applies when using a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). `layer.screenSizePerspectiveEnabled = true` ![screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-screenSize-perspective.png) `layer.screenSizePerspectiveEnabled = false` ![no-screen-size-perspective](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-no-screenSize-perspective.png) * > **Known Limitations** Screen size perspective is currently not optimized for situations where the camera is very near the ground, or for scenes with point features located far from the ground surface. In these cases it may be better to turn off screen size perspective. As screen size perspective changes the size based on distance to the camera, it should be set to false when using {@link module:esri/renderers/Renderer#SizeVisualVariable size visual variables}. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#screenSizePerspectiveEnabled) - * + * * @default true */ screenSizePerspectiveEnabled?: boolean; @@ -10875,32 +10875,32 @@ declare namespace __esri { export interface SceneLayerElevationInfo extends Object { /** - * Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values. - * + * Defines how the graphic is placed with respect to the terrain surface. See the table below for a list of possible values. + * * Mode | Description * ------|------------ * on-the-ground | Graphics are draped on the terrain surface. This is the default value for features with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [ObjectSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). * relative-to-ground | The graphic is placed at an elevation relative to the terrain surface. The graphic's elevation is determined by summing up the terrain elevation, the `offset` value and the geometry's z-value (if present). This is the default value for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries rendered with [IconSymbol3DLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html). * absolute-height | Graphics are placed at an absolute height above sea level. This height is determined by summing up the `offset` value and the geometry's z-value (if present). It doesn't take the elevation of the terrain into account. This is the default value for features with 3D Object geometries and [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries where [hasZ](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#hasZ) is `true`. * relative-to-scene | Graphics are aligned to buildings and other objects part of 3D Object [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) or [IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html), depending on which has higher elevation. If the graphic is not directly above a building or any other feature, it is aligned to the terrain surface elevation. If present, z-values will be ignored. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) */ mode: string; /** * An elevation offset which is added to the vertical position of the graphic. When `mode = "on-the-ground"`, this property has no effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) - * + * * @default 0 */ offset?: number; /** * The unit for `offset` values. **Possible Values:** feet | meters | kilometers | miles | us-feet | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#elevationInfo) - * + * * @default meters */ unit?: string; @@ -10910,7 +10910,7 @@ declare namespace __esri { export interface SceneLayerFeatureReduction extends Object { /** * Type of the decluttering method. The only supported type at the moment is `"selection"`. In this method, some of the overlapping features are hidden such that none of the remaining features intersect on screen. Label deconfliction also respects this option and hides labels that would overlap with the features of this layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#featureReduction) */ type: string; @@ -10919,38 +10919,38 @@ declare namespace __esri { interface StreamLayer extends FeatureLayer { /** * Contains the attribute and spatial filters used to filter messages sent to the client by a Stream Service. This property can be set in the constructor but is `read-only` after the layer is created. To change the filter after the layer is created, use the [updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) */ readonly filter: StreamLayerFilter; /** * An extent object used to filter features. Only features intersecting the extent are displayed in the view. Instead of using this property, use [StreamLayer.filter.geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) when creating the service or [StreamLayer.updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) when changing the spatial filter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryDefinition) */ geometryDefinition: Extent; /** * Maximum number of features to show per [trackId](https://enterprise.arcgis.com/en/geoevent/latest/get-started/essential-geoevent-server-vocabulary.htm#ESRI_SECTION1_F45BBCE9ADFA4E57AF38DD225921EFCD). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maximumTrackPoints) */ maximumTrackPoints: number; /** * Options for purging stale features. Use these options to avoid overloading the browser with graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ purgeOptions: StreamLayerPurgeOptions; /** * Updates the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) on the layer. The filter is updated on all views that contain the layer. If the input `filterChanges` object is `undefined` or `null`, the spatial and attribute filters are removed. To update the filter on a single layer view associated with the layer, use the [StreamLayerView.updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#updateFilter) method after getting the layer view object. Filter changes only apply to incoming features. Features already displayed in the view will be removed automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) - * + * * @param filterChanges Updates the spatial and attribute [filters](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) on the layer and all of its associated views. If `null`, all filters are cleared. * @param filterChanges.geometry A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view(s). If `null`, the spatial filter is cleared. * @param filterChanges.where A SQL where clause used to filter features by attributes. If `null`, the attribute filter is cleared. - * + * */ updateFilter(filterChanges: StreamLayerUpdateFilterFilterChanges): IPromise; @@ -10963,7 +10963,7 @@ declare namespace __esri { interface StreamLayerConstructor { /** * The stream layer extends the feature layer to add the ability to connect to a stream of data using HTML5 WebSockets. It connects to a server that emits geographic features continuously. While the feature layer is used to map relatively static data, the stream layer is suitable when you would like to map dynamic streams of data that are unbounded and continuous. When a stream layer is added to a map, users are able to see real-time updates pushed out by the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) */ @@ -10977,25 +10977,25 @@ declare namespace __esri { interface StreamLayerProperties extends FeatureLayerProperties { /** * Contains the attribute and spatial filters used to filter messages sent to the client by a Stream Service. This property can be set in the constructor but is `read-only` after the layer is created. To change the filter after the layer is created, use the [updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) */ filter?: StreamLayerFilter; /** * An extent object used to filter features. Only features intersecting the extent are displayed in the view. Instead of using this property, use [StreamLayer.filter.geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) when creating the service or [StreamLayer.updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) when changing the spatial filter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#geometryDefinition) */ geometryDefinition?: ExtentProperties; /** * Maximum number of features to show per [trackId](https://enterprise.arcgis.com/en/geoevent/latest/get-started/essential-geoevent-server-vocabulary.htm#ESRI_SECTION1_F45BBCE9ADFA4E57AF38DD225921EFCD). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#maximumTrackPoints) */ maximumTrackPoints?: number; /** * Options for purging stale features. Use these options to avoid overloading the browser with graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ purgeOptions?: StreamLayerPurgeOptions; @@ -11019,13 +11019,13 @@ declare namespace __esri { export interface StreamLayerFilter extends Object { /** * A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) */ geometry?: Extent; /** * A SQL where clause used to filter features by attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#filter) */ where?: string; @@ -11035,13 +11035,13 @@ declare namespace __esri { export interface StreamLayerPurgeOptions extends Object { /** * The maximum number of features to display. Excess features are purged from the beginning of the graphics array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ displayCount: number; /** * The maximum time in minutes that a feature should be kept. After this time, the feature is removed from the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#purgeOptions) */ age: number; @@ -11051,13 +11051,13 @@ declare namespace __esri { export interface StreamLayerUpdateFilterFilterChanges extends Object { /** * A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view(s). If `null`, the spatial filter is cleared. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) */ geometry: Extent; /** * A SQL where clause used to filter features by attributes. If `null`, the attribute filter is cleared. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) */ where: string; @@ -11066,24 +11066,24 @@ declare namespace __esri { interface CodedValueDomain extends Domain { /** * An array of the coded values in the domain. See the object specification table below for the properties each item in the array should contain. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ codedValues: CodedValueDomainCodedValues[]; /** * The domain type. This value is always `coded-value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#type) */ readonly type: "coded-value"; /** * Returns the name of the coded-value associated with the specified code. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#getName) - * + * * @param code The code associated with the desired name. - * + * */ getName(code: string | number): string; } @@ -11101,7 +11101,7 @@ declare namespace __esri { interface CodedValueDomainProperties extends DomainProperties { /** * An array of the coded values in the domain. See the object specification table below for the properties each item in the array should contain. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ codedValues?: CodedValueDomainCodedValues[]; @@ -11111,13 +11111,13 @@ declare namespace __esri { export interface CodedValueDomainCodedValues extends Object { /** * The name of the coded value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ name: string; /** * The value of the code. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html#codedValues) */ code: string | number; @@ -11126,37 +11126,37 @@ declare namespace __esri { interface DimensionalDefinition { /** * The dimension associated with the variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#dimensionName) */ dimensionName: string; /** * Indicates whether the values indicate slices (rather than ranges). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#isSlice) - * + * * @default false */ isSlice: boolean; /** * An array of tuples [min, max] each defining a range of valid values along the specified dimension. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#values) */ values: any[]; /** * The variable name by which to filter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#variableName) */ variableName: string; /** * Returns a serialized JSON object representation of the dimensional definition in the format of the ArcGIS Platform. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -11164,7 +11164,7 @@ declare namespace __esri { interface DimensionalDefinitionConstructor { /** * A dimensional definition defines a filter based on one variable and one dimension. You can filter with one or multiple dimensional slices. Instances of this class are typically used when filtering data based on [slices](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html#isSlice) or ranges in one or more dimensions with [MosaicRule](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-DimensionalDefinition.html) */ @@ -11177,13 +11177,13 @@ declare namespace __esri { interface Domain extends Accessor, JSONSupport { /** * The domain name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#name) */ name: string; /** * The domain type. **Possible Values:** range | coded-value | inherited - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#type) */ type: string; @@ -11202,13 +11202,13 @@ declare namespace __esri { interface DomainProperties { /** * The domain name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#name) */ name?: string; /** * The domain type. **Possible Values:** range | coded-value | inherited - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html#type) */ type?: string; @@ -11217,21 +11217,21 @@ declare namespace __esri { interface ElevationSampler { /** * Registers an event handler on the instance. Call this method to hook an event with a listener. See the [Events summary table](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#events-summary) for a list of listened events. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#on) - * + * * @param type The name of the event or the events to listen for. * @param handler? The function to call when the event is fired, if modifiers were specified. - * + * */ on(type: string | string[], handler?: Function): any; /** * Query elevation for a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) or [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry. A query will return a new geometry for which the z-values for each coordinate in the geometry are obtained from the elevation sampler. If the geometry used for the query is outside of the elevation sampler extent, then the returned geometry has `0` as z-values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#queryElevation) - * + * * @param geometry The geometry to use for sampling elevation data. - * + * */ queryElevation(geometry: Point | Multipoint | Polyline): Point | Multipoint | Polyline; @@ -11242,7 +11242,7 @@ declare namespace __esri { interface ElevationSamplerConstructor { /** * A cache of elevation values created from an elevation service or the [GroundView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html) used for synchronously querying elevation information for geometries. This class does not have a constructor. You can create an instance of this class by using [ElevationLayer.createElevationSampler()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler) or [Ground.createElevationSampler()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#createElevationSampler) methods. The elevation sampler created from the [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) will sample data from the first elevation layer that has data available. To control the layer used for elevation sampling and the sampling resolution, use [ElevationLayer.createElevationSampler()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#createElevationSampler). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html) */ @@ -11257,31 +11257,31 @@ declare namespace __esri { interface FeatureTemplate extends Accessor, JSONSupport { /** * Description of the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#description) */ description: string; /** * Name of the default drawing tool defined for the template to create a feature. **Possible Values:** auto-complete-polygon | circle | ellipse | freehand | line | none | point | polygon | rectangle | arrow | triangle | left-arrow | right-arrow | up-arrow | down-arrow - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#drawingTool) */ drawingTool: string; /** * Name of the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#name) */ name: string; /** * An instance of the prototypical feature described by the [feature template](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html). It specifies default values for the attribute fields and does not contain geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#prototype) */ prototype: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ thumbnail: FeatureTemplateThumbnail; @@ -11300,31 +11300,31 @@ declare namespace __esri { interface FeatureTemplateProperties { /** * Description of the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#description) */ description?: string; /** * Name of the default drawing tool defined for the template to create a feature. **Possible Values:** auto-complete-polygon | circle | ellipse | freehand | line | none | point | polygon | rectangle | arrow | triangle | left-arrow | right-arrow | up-arrow | down-arrow - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#drawingTool) */ drawingTool?: string; /** * Name of the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#name) */ name?: string; /** * An instance of the prototypical feature described by the [feature template](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html). It specifies default values for the attribute fields and does not contain geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#prototype) */ prototype?: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ thumbnail?: FeatureTemplateThumbnail; @@ -11334,25 +11334,25 @@ declare namespace __esri { export interface FeatureTemplateThumbnail extends Object { /** * The MIME type of the image. **Possible Values:** image | png | jpg | jpeg - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ contentType: any; /** * The [base64EncodedImageData](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding) presenting the thumbnail image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ imageData: string; /** * The height of the thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ height: number; /** * The width of the thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html#thumbnail) */ width: number; @@ -11361,25 +11361,25 @@ declare namespace __esri { interface FeatureType extends Accessor, JSONSupport { /** * Domains associated with the feature type. It is an object where the name of each property corresponds with the name of a field containing a domain. If a field's domain is an instance of [InheritedDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-InheritedDomain.html), the application will use the domain defined for the field from the layer. If the domain is an instance of [CodedValueDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) then the domain is defined specifically for the given feature type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#domains) */ domains: any; /** * The feature type identifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#id) */ id: number | string; /** * The feature type name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#name) */ name: string; /** * Array of [feature templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the feature type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#templates) */ templates: FeatureTemplate[]; @@ -11398,25 +11398,25 @@ declare namespace __esri { interface FeatureTypeProperties { /** * Domains associated with the feature type. It is an object where the name of each property corresponds with the name of a field containing a domain. If a field's domain is an instance of [InheritedDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-InheritedDomain.html), the application will use the domain defined for the field from the layer. If the domain is an instance of [CodedValueDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-CodedValueDomain.html) or [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) then the domain is defined specifically for the given feature type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#domains) */ domains?: any; /** * The feature type identifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#id) */ id?: number | string; /** * The feature type name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#name) */ name?: string; /** * Array of [feature templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) associated with the feature type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureType.html#templates) */ templates?: FeatureTemplateProperties[]; @@ -11425,65 +11425,65 @@ declare namespace __esri { interface Field extends Accessor, JSONSupport { /** * The display name for the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) - * + * * @default null */ alias: string; /** * The default value set for the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#defaultValue) - * + * * @default undefined */ defaultValue: number | string | any | any; /** * The domain associated with the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#domain) - * + * * @default null */ domain: Domain; /** * Indicates whether the field is editable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable) - * + * * @default true */ editable: boolean; /** * The field length. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#length) - * + * * @default -1 */ length: number; /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#name) - * + * * @default null */ name: string; /** * Indicates if the field can accept `null` values. *Requires ArcGIS Server version 10.1 or greater.* - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#nullable) - * + * * @default true */ nullable: boolean; /** * The data type of the field. **Possible Values:** small-integer | integer | single | double | long | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) - * + * * @default null */ type: string; @@ -11502,65 +11502,65 @@ declare namespace __esri { interface FieldProperties { /** * The display name for the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) - * + * * @default null */ alias?: string; /** * The default value set for the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#defaultValue) - * + * * @default undefined */ defaultValue?: number | string | any | any; /** * The domain associated with the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#domain) - * + * * @default null */ domain?: DomainProperties; /** * Indicates whether the field is editable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable) - * + * * @default true */ editable?: boolean; /** * The field length. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#length) - * + * * @default -1 */ length?: number; /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#name) - * + * * @default null */ name?: string; /** * Indicates if the field can accept `null` values. *Requires ArcGIS Server version 10.1 or greater.* - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#nullable) - * + * * @default true */ nullable?: boolean; /** * The data type of the field. **Possible Values:** small-integer | integer | single | double | long | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) - * + * * @default null */ type?: string; @@ -11569,77 +11569,77 @@ declare namespace __esri { interface ImageParameters extends Accessor { /** * Dots per inch setting for an module:esri/layersMapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#dpi) - * + * * @default 96 */ dpi: number; /** * Extent of map to be exported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#extent) */ extent: Extent; /** * Map image format. **Possible Values:** png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svg - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#format) - * + * * @default png8 */ format: string; /** * Requested image height in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#height) */ height: number; /** * Spatial reference of exported map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#imageSpatialReference) */ imageSpatialReference: SpatialReference; /** * Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10 or later. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerDefinitions) */ layerDefinitions: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. Use in combination with [layerOption](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerOption) to specify how layer visibility is handled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerIds) */ layerIds: number[]; /** * The option for displaying or hiding the layer. **Possible Values:** show | hide | include | exclude - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerOption) */ layerOption: string; /** * Indicates whether or not the background of the dynamic image is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#transparent) - * + * * @default true */ transparent: boolean; /** * Requested image width in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#width) */ width: number; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -11655,67 +11655,67 @@ declare namespace __esri { interface ImageParametersProperties { /** * Dots per inch setting for an module:esri/layersMapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#dpi) - * + * * @default 96 */ dpi?: number; /** * Extent of map to be exported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#extent) */ extent?: ExtentProperties; /** * Map image format. **Possible Values:** png | png8 | png24 | png32 | jpg | pdf | bmp | gif | svg - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#format) - * + * * @default png8 */ format?: string; /** * Requested image height in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#height) */ height?: number; /** * Spatial reference of exported map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#imageSpatialReference) */ imageSpatialReference?: SpatialReferenceProperties; /** * Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10 or later. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerDefinitions) */ layerDefinitions?: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. Use in combination with [layerOption](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerOption) to specify how layer visibility is handled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerIds) */ layerIds?: number[]; /** * The option for displaying or hiding the layer. **Possible Values:** show | hide | include | exclude - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#layerOption) */ layerOption?: string; /** * Indicates whether or not the background of the dynamic image is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#transparent) - * + * * @default true */ transparent?: boolean; /** * Requested image width in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageParameters.html#width) */ width?: number; @@ -11724,7 +11724,7 @@ declare namespace __esri { interface InheritedDomain extends Domain { /** * The domain type. This value is always `inherited`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-InheritedDomain.html#type) */ readonly type: "inherited"; @@ -11747,43 +11747,43 @@ declare namespace __esri { interface KMLSublayer extends Accessor, JSONSupport { /** * Description for the KML sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#description) */ description: string; /** * The id for the KML sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#id) */ id: number; /** * The [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#layer) */ layer: KMLLayer; /** * Network link info for the current layer. A link info object with properties that describe the network link. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#networkLink) */ networkLink: any; /** * A collection of [KMLSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sublayers) */ sublayers: Collection; /** * The title of the KML sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#title) */ title: string; /** * Indicates if the sublayer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#visible) */ visible: boolean; @@ -11802,43 +11802,43 @@ declare namespace __esri { interface KMLSublayerProperties { /** * Description for the KML sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#description) */ description?: string; /** * The id for the KML sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#id) */ id?: number; /** * The [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#layer) */ layer?: KMLLayerProperties; /** * Network link info for the current layer. A link info object with properties that describe the network link. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#networkLink) */ networkLink?: any; /** * A collection of [KMLSublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the KML sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#title) */ title?: string; /** * Indicates if the sublayer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-KMLSublayer.html#visible) */ visible?: boolean; @@ -11847,70 +11847,70 @@ declare namespace __esri { interface LabelClass extends Accessor, JSONSupport { /** * Defines the content of label text for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). If working with [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), use [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) instead. Attribute values may be included in labels using SQL syntax. To include an attribute value in a label, wrap the name of the field in square brackets `[]`. See the example snippet below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) */ labelExpression: string; /** * Defines the content of label text for [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). If working with [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), use [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ labelExpressionInfo: LabelClassLabelExpressionInfo; /** - * The position of the label. Possible values are based on the feature type. This property requires a value. **Possible Values (Points):** above-center | above-left | above-right | below-center | below-left | below-right | center-center | center-left | center-right **Possible Values (Polylines):** above-after | above-along | above-before | above-start | above-end | below-after | below-along | below-before | below-start | below-end | center-after | center-along | center-before | center-start | center-end **Possible Values (Polygons):** always-horizontal - * > **Known Limitations** + * The position of the label. Possible values are based on the feature type. This property requires a value. **Possible Values (Points):** above-center | above-left | above-right | below-center | below-left | below-right | center-center | center-left | center-right **Possible Values (Polylines):** above-after | above-along | above-before | above-start | above-end | below-after | below-along | below-before | below-start | below-end | center-after | center-along | center-before | center-start | center-end **Possible Values (Polygons):** always-horizontal + * > **Known Limitations** * * Currently, if the label has a [line callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html) in a 3D SceneView, then only `above-center` is supported. * * Label placement only applies to [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) layers in 3D SceneViews. * * FeatureLayers only support labeling for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) and [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPlacement) - * + * * @default null */ labelPlacement: string; /** * The maximum scale (most zoomed in) at which labels are visible in the view. A value of `0` means the label's visibility does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) - * + * * @default 0 */ maxScale: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. A value of `0` means the label's visibility does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) - * + * * @default 0 */ minScale: number; /** * Defines the symbol used for rendering the label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#symbol) */ symbol: TextSymbol | LabelSymbol3D; /** * Indicates whether to use domain names if the fields in the [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) or [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) have domains. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#useCodedValues) */ useCodedValues: boolean; /** - * A SQL where clause used to determine the features to which the label class should be applied. When specified, only features evaluating to `true` based on this expression will be labeled. - * > **Known Limitations** Only very basic SQL is currently supported. - * + * A SQL where clause used to determine the features to which the label class should be applied. When specified, only features evaluating to `true` based on this expression will be labeled. + * > **Known Limitations** Only very basic SQL is currently supported. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) */ where: string; /** * Creates a deep clone of the LabelClass. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#clone) - * - * + * + * */ clone(): LabelClass; } @@ -11918,7 +11918,7 @@ declare namespace __esri { interface LabelClassConstructor { /** * Defines label expressions, symbols, scale ranges, label priorities, and label placement options for labels on a layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) */ @@ -11932,60 +11932,60 @@ declare namespace __esri { interface LabelClassProperties { /** * Defines the content of label text for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). If working with [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), use [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) instead. Attribute values may be included in labels using SQL syntax. To include an attribute value in a label, wrap the name of the field in square brackets `[]`. See the example snippet below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) */ labelExpression?: string; /** * Defines the content of label text for [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). If working with [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), use [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ labelExpressionInfo?: LabelClassLabelExpressionInfo; /** - * The position of the label. Possible values are based on the feature type. This property requires a value. **Possible Values (Points):** above-center | above-left | above-right | below-center | below-left | below-right | center-center | center-left | center-right **Possible Values (Polylines):** above-after | above-along | above-before | above-start | above-end | below-after | below-along | below-before | below-start | below-end | center-after | center-along | center-before | center-start | center-end **Possible Values (Polygons):** always-horizontal - * > **Known Limitations** + * The position of the label. Possible values are based on the feature type. This property requires a value. **Possible Values (Points):** above-center | above-left | above-right | below-center | below-left | below-right | center-center | center-left | center-right **Possible Values (Polylines):** above-after | above-along | above-before | above-start | above-end | below-after | below-along | below-before | below-start | below-end | center-after | center-along | center-before | center-start | center-end **Possible Values (Polygons):** always-horizontal + * > **Known Limitations** * * Currently, if the label has a [line callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html) in a 3D SceneView, then only `above-center` is supported. * * Label placement only applies to [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) layers in 3D SceneViews. * * FeatureLayers only support labeling for [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) and [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelPlacement) - * + * * @default null */ labelPlacement?: string; /** * The maximum scale (most zoomed in) at which labels are visible in the view. A value of `0` means the label's visibility does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) - * + * * @default 0 */ maxScale?: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. A value of `0` means the label's visibility does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#minScale) - * + * * @default 0 */ minScale?: number; /** * Defines the symbol used for rendering the label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#symbol) */ symbol?: TextSymbolProperties | LabelSymbol3DProperties; /** * Indicates whether to use domain names if the fields in the [labelExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpression) or [labelExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) have domains. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#useCodedValues) */ useCodedValues?: boolean; /** - * A SQL where clause used to determine the features to which the label class should be applied. When specified, only features evaluating to `true` based on this expression will be labeled. - * > **Known Limitations** Only very basic SQL is currently supported. - * + * A SQL where clause used to determine the features to which the label class should be applied. When specified, only features evaluating to `true` based on this expression will be labeled. + * > **Known Limitations** Only very basic SQL is currently supported. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#where) */ where?: string; @@ -11995,13 +11995,13 @@ declare namespace __esri { export interface LabelClassLabelExpressionInfo extends Object { /** * The SQL expression defining the content of the label text. **Deprecated as of v4.5. Use `expression` instead.** - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ value?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that evaluates to a string used to label features in the layer. The most simple expressions return field values. For example, to label a layer of cities with their names, simply reference the field value with the global variable: `$feature.CITY_NAME`. Expressions can be more sophisticated and use logical functions. This may be useful if you want to use classed labels. For example, the following expression appends `city` to the end of the label if the feature's population field contains a number greater than 10,000. Otherwise, `town` is appended to the end of the label. Additionally, you can use `TextFormatting.NewLine` to add a new line to the label. `IIF($feature.POPULATION > 10000, $feature.NAME + ' city', $feature.NAME + ' town')` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#labelExpressionInfo) */ expression: string; @@ -12010,25 +12010,25 @@ declare namespace __esri { interface LOD extends Accessor, JSONSupport { /** * ID for each level. The top most level is `0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#level) */ level: number; /** * String to be used when constructing a URL to access a tile from this LOD. If `levelValue` is not defined, level will be used for the tile access URL. This property is useful when an LOD object represents a WMTS TileMatrix with non-numeric matrix identifiers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#levelValue) */ levelValue: string; /** * Resolution in map units of each pixel in a tile for each level. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#resolution) */ resolution: number; /** * Scale for each level. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#scale) */ scale: number; @@ -12047,25 +12047,25 @@ declare namespace __esri { interface LODProperties { /** * ID for each level. The top most level is `0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#level) */ level?: number; /** * String to be used when constructing a URL to access a tile from this LOD. If `levelValue` is not defined, level will be used for the tile access URL. This property is useful when an LOD object represents a WMTS TileMatrix with non-numeric matrix identifiers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#levelValue) */ levelValue?: string; /** * Resolution in map units of each pixel in a tile for each level. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#resolution) */ resolution?: number; /** * Scale for each level. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html#scale) */ scale?: number; @@ -12074,47 +12074,47 @@ declare namespace __esri { interface MapImage extends Accessor, JSONSupport { /** * The extent of the exported map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#extent) */ extent: Extent; /** * The requested image height in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#height) */ height: number; /** * URL to the returned image. The image format must be of a type supported by the HTML `` tag. **Possible Values:** gif | jpg | png | bmp - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#href) */ href: string; /** * The opacity of the image. Value can be any number between `0` and `1` where `0` is 100% transparent, `0.5` is 50% transparent and `1` is fully opaque. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#opacity) - * + * * @default 1 */ opacity: number; /** * Scale of the requested dynamic map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#scale) */ scale: number; /** * Indicates if the requested image is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#visible) - * + * * @default true */ visible: boolean; /** * The requested image width in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#width) */ width: number; @@ -12133,47 +12133,47 @@ declare namespace __esri { interface MapImageProperties { /** * The extent of the exported map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#extent) */ extent?: ExtentProperties; /** * The requested image height in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#height) */ height?: number; /** * URL to the returned image. The image format must be of a type supported by the HTML `` tag. **Possible Values:** gif | jpg | png | bmp - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#href) */ href?: string; /** * The opacity of the image. Value can be any number between `0` and `1` where `0` is 100% transparent, `0.5` is 50% transparent and `1` is fully opaque. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#opacity) - * + * * @default 1 */ opacity?: number; /** * Scale of the requested dynamic map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#scale) */ scale?: number; /** * Indicates if the requested image is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#visible) - * + * * @default true */ visible?: boolean; /** * The requested image width in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MapImage.html#width) */ width?: number; @@ -12182,63 +12182,63 @@ declare namespace __esri { interface MosaicRule extends Accessor, JSONSupport { /** * Indicates whether the sort should be ascending. This property applies to all mosaic [methods](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) where an ordering is defined except `seamline`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#ascending) - * + * * @default true */ ascending: boolean; /** * An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#lockRasterIds) */ lockRasterIds: number[]; /** * The mosaic method determines how the selected rasters are ordered. **Possible Values:** none | center | nadir | viewpoint | attribute | lock-raster | northwest | seamline - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) */ method: string; /** * A multiple dimensional service can have multiple dimensions for one or more variables. Use multiDimensionalDefinitions to filter data based on a slice or range of data. For example, a single ImageryLayer may have a `depth` dimension storing sea temperatures for the same pixel location at various depths. Another dimension could be `time`, where the same pixel stores multiple values based on a window of time. This property can be used to filter and display ImageryLayer pixels for specific "slices" in those dimensions (e.g. display sea temperature at 1000m below sea level for a specific week in the year). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) */ multidimensionalDefinition: DimensionalDefinition[]; /** * Defines a selection using a set of ObjectIDs. This property applies to all mosaic methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#objectIds) */ objectIds: number[]; /** * Defines the mosaic operation used to resolve overlapping pixels. **Possible Values:** first | last | min | max | mean | blend - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#operation) */ operation: string; /** * The name of the attribute field that is used with a constant sortValue to define the mosaicking order when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. The ordering is defined by the absolute value of the difference between the specified sort field value and the sort base value. For example, if the sort field is `Month` and the sort value is `7 (July)`, then the ordering is defined by `ABS(Month -7)`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortField) */ sortField: string; /** * A constant value defining a reference or base value for the sort field when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortValue) */ sortValue: string; /** * Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#viewpoint) */ viewpoint: Point; /** * The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#where) */ where: string; @@ -12247,7 +12247,7 @@ declare namespace __esri { interface MosaicRuleConstructor { /** * Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset. A mosaic rule is used to define: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html) */ @@ -12261,63 +12261,63 @@ declare namespace __esri { interface MosaicRuleProperties { /** * Indicates whether the sort should be ascending. This property applies to all mosaic [methods](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) where an ordering is defined except `seamline`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#ascending) - * + * * @default true */ ascending?: boolean; /** * An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#lockRasterIds) */ lockRasterIds?: number[]; /** * The mosaic method determines how the selected rasters are ordered. **Possible Values:** none | center | nadir | viewpoint | attribute | lock-raster | northwest | seamline - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) */ method?: string; /** * A multiple dimensional service can have multiple dimensions for one or more variables. Use multiDimensionalDefinitions to filter data based on a slice or range of data. For example, a single ImageryLayer may have a `depth` dimension storing sea temperatures for the same pixel location at various depths. Another dimension could be `time`, where the same pixel stores multiple values based on a window of time. This property can be used to filter and display ImageryLayer pixels for specific "slices" in those dimensions (e.g. display sea temperature at 1000m below sea level for a specific week in the year). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#multidimensionalDefinition) */ multidimensionalDefinition?: DimensionalDefinition[]; /** * Defines a selection using a set of ObjectIDs. This property applies to all mosaic methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#objectIds) */ objectIds?: number[]; /** * Defines the mosaic operation used to resolve overlapping pixels. **Possible Values:** first | last | min | max | mean | blend - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#operation) */ operation?: string; /** * The name of the attribute field that is used with a constant sortValue to define the mosaicking order when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. The ordering is defined by the absolute value of the difference between the specified sort field value and the sort base value. For example, if the sort field is `Month` and the sort value is `7 (July)`, then the ordering is defined by `ABS(Month -7)`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortField) */ sortField?: string; /** * A constant value defining a reference or base value for the sort field when the mosaic [method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#method) is set to `attribute`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#sortValue) */ sortValue?: string; /** * Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#viewpoint) */ viewpoint?: PointProperties; /** * The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-MosaicRule.html#where) */ where?: string; @@ -12326,37 +12326,37 @@ declare namespace __esri { interface PixelBlock extends Accessor { /** * The height (or number of rows) of the PixelBlock in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) */ height: number; /** * An array of numbers representing pixels to show and pixels to hide from the view. The length of this array is [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) * [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width). It's arranged row by row in this format: `[p_00, p_10, p_20, ... p_10, p_11, .....]` where `p_xy` is the pixel value at the column `x` and row `y`. The mask is per pixel, not per band. Items in the mask array with a value of `0` indicates [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) to not display in the view at that index. Items with a value of `1` indicate to display the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) at there corresponding indices. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#mask) */ mask: number[]; /** * A two dimensional array representing the pixels from the Image Service displayed on the client. The length of the first dimension is the same as the number of bands in the layer. The length of the second dimension is [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) * [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width). The length of each band is the same. The pixels in each band are arranged row by row in this format: `[p_00, p_10, p_20, ... p_10, p_11, ...]` where `p_xy` is the pixel value at the column `x` and row `y`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) */ pixels: number[][]; /** * The pixel type. **Possible Values:** s8 | s16 | s32 | u8 | u16 | u32 | f32 | f64 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixelType) */ pixelType: string; /** * An array of objects containing numeric statistical properties. Each object has the following specification if defined: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ statistics: PixelBlockStatistics[]; /** * The width (or number of columns) of the PixelBlock in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width) */ width: number; @@ -12373,37 +12373,37 @@ declare namespace __esri { interface PixelBlockProperties { /** * The height (or number of rows) of the PixelBlock in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) */ height?: number; /** * An array of numbers representing pixels to show and pixels to hide from the view. The length of this array is [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) * [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width). It's arranged row by row in this format: `[p_00, p_10, p_20, ... p_10, p_11, .....]` where `p_xy` is the pixel value at the column `x` and row `y`. The mask is per pixel, not per band. Items in the mask array with a value of `0` indicates [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) to not display in the view at that index. Items with a value of `1` indicate to display the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) at there corresponding indices. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#mask) */ mask?: number[]; /** * A two dimensional array representing the pixels from the Image Service displayed on the client. The length of the first dimension is the same as the number of bands in the layer. The length of the second dimension is [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#height) * [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width). The length of each band is the same. The pixels in each band are arranged row by row in this format: `[p_00, p_10, p_20, ... p_10, p_11, ...]` where `p_xy` is the pixel value at the column `x` and row `y`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) */ pixels?: number[][]; /** * The pixel type. **Possible Values:** s8 | s16 | s32 | u8 | u16 | u32 | f32 | f64 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixelType) */ pixelType?: string; /** * An array of objects containing numeric statistical properties. Each object has the following specification if defined: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ statistics?: PixelBlockStatistics[]; /** * The width (or number of columns) of the PixelBlock in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#width) */ width?: number; @@ -12413,19 +12413,19 @@ declare namespace __esri { export interface PixelBlockStatistics extends Object { /** * The maximum pixel value in the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ maxValue?: number; /** * The minimum pixel value in the [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ minValue?: number; /** * Value representing areas of no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#statistics) */ noDataValue?: number; @@ -12434,19 +12434,19 @@ declare namespace __esri { interface RangeDomain extends Domain { /** * The maximum valid value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#maxValue) */ maxValue: number; /** * The minimum valid value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#minValue) */ minValue: number; /** * The domain type. This value is always `range`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#type) */ readonly type: "range"; @@ -12465,13 +12465,13 @@ declare namespace __esri { interface RangeDomainProperties extends DomainProperties { /** * The maximum valid value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#maxValue) */ maxValue?: number; /** * The minimum valid value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html#minValue) */ minValue?: number; @@ -12480,27 +12480,27 @@ declare namespace __esri { interface RasterFunction extends Accessor, JSONSupport { /** * The arguments for the raster function. The structure depends on the function specified. See [raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for a list of functions and their arguments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionArguments) */ functionArguments: any; /** * The raster function name. See [raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for a list of functions and their arguments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionName) */ functionName: string; /** * Defines the pixel type of the output image. **Possible Values:** c128 | c64 | f32 | f64 | s16 | s32 | s8 | u1 | u16 | u2 | u32 | u4 | u8 | unknown - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#outputPixelType) - * + * * @default unknown */ outputPixelType: string; /** * The variable name for the raster function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#variableName) */ variableName: any; @@ -12509,7 +12509,7 @@ declare namespace __esri { interface RasterFunctionConstructor { /** * Specifies processing to be done to the image service. See [raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for a list of functions and their [arguments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionArguments). The following image shows a landcover ImageryLayer rendered with two chained client-side raster functions used to reclass pixel values (Remap) and assign each pixel a new color (Colormap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html) */ @@ -12523,27 +12523,27 @@ declare namespace __esri { interface RasterFunctionProperties { /** * The arguments for the raster function. The structure depends on the function specified. See [raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for a list of functions and their arguments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionArguments) */ functionArguments?: any; /** * The raster function name. See [raster functions](https://developers.arcgis.com/documentation/common-data-types/raster-function-objects.htm) for a list of functions and their arguments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#functionName) */ functionName?: string; /** * Defines the pixel type of the output image. **Possible Values:** c128 | c64 | f32 | f64 | s16 | s32 | s8 | u1 | u16 | u2 | u32 | u4 | u8 | unknown - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#outputPixelType) - * + * * @default unknown */ outputPixelType?: string; /** * The variable name for the raster function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RasterFunction.html#variableName) */ variableName?: any; @@ -12552,31 +12552,31 @@ declare namespace __esri { interface Relationship extends Accessor { /** * The cardinality which specifies the number of objects in the origin [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) related to the number of objects in the destination [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). Please see the [Desktop help](http://desktop.arcgis.com/en/arcmap/10.3/manage-data/relationships/relationship-class-properties.htm#GUID-989CB1D1-AC51-4A4C-8D9D-0AB9E647FFFD) for additional information on cardinality. **Possible values:** one-to-one | one-to-many | many-to-many - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality) */ cardinality: string; /** * The unique ID for the relationship. These ids for the relationships the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) participates in are listed in the ArcGIS Services directory. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#id) */ id: number; /** * The field used to establish the relate within the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField) */ keyField: string; /** * The name of the relationship. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#name) */ name: string; /** * The unique ID of the related [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relatedTableId) */ relatedTableId: number; @@ -12593,31 +12593,31 @@ declare namespace __esri { interface RelationshipProperties { /** * The cardinality which specifies the number of objects in the origin [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) related to the number of objects in the destination [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). Please see the [Desktop help](http://desktop.arcgis.com/en/arcmap/10.3/manage-data/relationships/relationship-class-properties.htm#GUID-989CB1D1-AC51-4A4C-8D9D-0AB9E647FFFD) for additional information on cardinality. **Possible values:** one-to-one | one-to-many | many-to-many - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#cardinality) */ cardinality?: string; /** * The unique ID for the relationship. These ids for the relationships the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) participates in are listed in the ArcGIS Services directory. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#id) */ id?: number; /** * The field used to establish the relate within the [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#keyField) */ keyField?: string; /** * The name of the relationship. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#name) */ name?: string; /** * The unique ID of the related [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Relationship.html#relatedTableId) */ relatedTableId?: number; @@ -12626,149 +12626,149 @@ declare namespace __esri { interface Sublayer extends Accessor { /** * A SQL where clause used to filter features in the image. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Definition expressions may be set when a sublayer is constructed prior to it loading in the view or after it has been added to the MapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) */ definitionExpression: string; /** * The sublayer's layer ID. When a [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) is not defined on the layer, this value represents the id of the sublayer defined by the map service. If creating a [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) or a [MapDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#MapDataLayer) and adding it to the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) property of the sublayer, the value of this property can be anything set by the developer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) */ id: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects. Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) property of the sublayer must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo) */ labelingInfo: LabelClass[]; /** * Indicates if labels for the sublayer will be visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * The [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#layer) */ layer: MapImageLayer | TileLayer; /** * Indicates whether the layer will be included in the legend. When `false`, the layer will be excluded from the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) */ minScale: number; /** * The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where `0` is fully transparent and `1.0` is fully opaque. If the [MapImageLayer.opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity) is set, the actual opacity value of the sublayer will be the value of [MapImageLayer.opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity) multiplied by the sublayer's opacity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#opacity) */ opacity: number; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** - * The popup template for the sublayer. When set, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when the user clicks the image. Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) cannot be queried and therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). - * > **Known Limitations** + * The popup template for the sublayer. When set, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when the user clicks the image. Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) cannot be queried and therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). + * > **Known Limitations** * * [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions are not supported in PopupTemplates set on MapImageLayer sublayers or TileLayer sublayers unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) */ popupTemplate: PopupTemplate; /** - * The renderer to apply to the sublayer. This value overrides the renderer read from the map service. - * > **Known Limitations** + * The renderer to apply to the sublayer. This value overrides the renderer read from the map service. + * > **Known Limitations** * * [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) are not currently supported in renderers set on sublayers. * * [Visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) and [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions are not supported in renderers set on MapImageLayer sublayers unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer) */ renderer: Renderer; /** * An object that allows you to create a dynamic layer with data either from the map service sublayers or data from a registered workspace. See [DynamicMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) for creating dynamic layers from map service layers for on the fly rendering, labeling, and filtering (definition expressions). To create dynamic layers from other sources in registered workspaces such as tables and table joins, see [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) */ source: DynamicMapLayer | DynamicDataLayer; /** * If a sublayer contains sublayers, this property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects belonging to the given sublayer with sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sublayers) */ sublayers: Collection; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This value can be defined in the map service or programmatically by the developer. It can also be useful for finding a specific sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title) */ title: string; /** * The URL to the REST endpoint of the sublayer. This allows you to view the schema of fields and query tables located in registered workspaces. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#url) */ readonly url: string; /** * Indicates if the layer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) */ visible: boolean; /** * Creates a deep clone of the sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#clone) - * - * + * + * */ clone(): Sublayer; /** * A convenient method for creating a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) instance based on the Sublayer's configuration, including [dynamic sources](https://enterprise.arcgis.com/en/server/latest/publish-services/linux/about-dynamic-layers.htm). This allows you to take advantage of FeatureLayer capabilities not supported in Sublayer, such as the [Smart Mapping creator functions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createFeatureLayer) - * - * + * + * */ createFeatureLayer(): FeatureLayer; /** * Creates a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) object with default values representing the layer's state, including filters (definition expression) on the layer's features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#createQuery) - * - * + * + * */ createQuery(): Query; /** * Executes a [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html) against features in the sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#queryFeatures) - * + * * @param params Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. - * + * */ queryFeatures(params?: Query | QueryProperties): IPromise; } @@ -12776,7 +12776,7 @@ declare namespace __esri { interface SublayerConstructor { /** * Represents a sublayer in a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or a [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html). MapImageLayer allows you to display, query, and analyze layers from data defined in a [map service](http://server.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm). Map services contain sublayers with properties such as [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer), [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo), and [definitionExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression), and others that are defined on the server. The properties of each MapImageLayer sublayer on the map service may be dynamically changed by the user or developer. The properties of each TileLayer sublayer are read-only, and cannot be modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) */ @@ -12788,142 +12788,142 @@ declare namespace __esri { interface SublayerProperties { /** * A SQL where clause used to filter features in the image. Only the features that satisfy the definition expression are displayed in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Definition expressions may be set when a sublayer is constructed prior to it loading in the view or after it has been added to the MapImageLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#definitionExpression) */ definitionExpression?: string; /** * The sublayer's layer ID. When a [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) is not defined on the layer, this value represents the id of the sublayer defined by the map service. If creating a [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) or a [MapDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#MapDataLayer) and adding it to the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) property of the sublayer, the value of this property can be anything set by the developer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) */ id?: number; /** * The label definition for this layer, specified as an array of [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) objects. Use this property to specify labeling properties for the layer such as label expression, placement, and size. For labels to display in the view, the [labelsVisible](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) property of the sublayer must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelingInfo) */ labelingInfo?: LabelClassProperties[]; /** * Indicates if labels for the sublayer will be visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * The [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) or [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#layer) */ layer?: MapImageLayerProperties | TileLayerProperties; /** * Indicates whether the layer will be included in the legend. When `false`, the layer will be excluded from the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a maximum scale. The maxScale value should always be smaller than the [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) value, and greater than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of `0` means the layer does not have a minimum scale. The minScale value should always be larger than the [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#maxScale) value, and lesser than or equal to the service specification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#minScale) */ minScale?: number; /** * The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where `0` is fully transparent and `1.0` is fully opaque. If the [MapImageLayer.opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity) is set, the actual opacity value of the sublayer will be the value of [MapImageLayer.opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#opacity) multiplied by the sublayer's opacity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#opacity) */ opacity?: number; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** - * The popup template for the sublayer. When set, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when the user clicks the image. Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) cannot be queried and therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). - * > **Known Limitations** + * The popup template for the sublayer. When set, the `popupTemplate` allows users to access attributes and display their values in the [view's popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#popup) when the user clicks the image. Sublayers with a [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) cannot be queried and therefore do not support [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). + * > **Known Limitations** * * [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions are not supported in PopupTemplates set on MapImageLayer sublayers or TileLayer sublayers unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** - * The renderer to apply to the sublayer. This value overrides the renderer read from the map service. - * > **Known Limitations** + * The renderer to apply to the sublayer. This value overrides the renderer read from the map service. + * > **Known Limitations** * * [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) are not currently supported in renderers set on sublayers. * * [Visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) and [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions are not supported in renderers set on MapImageLayer sublayers unless they reference ArcGIS Enterprise 10.6 map services (or later) created from ArcGIS Pro. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#renderer) */ renderer?: RendererProperties; /** * An object that allows you to create a dynamic layer with data either from the map service sublayers or data from a registered workspace. See [DynamicMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) for creating dynamic layers from map service layers for on the fly rendering, labeling, and filtering (definition expressions). To create dynamic layers from other sources in registered workspaces such as tables and table joins, see [DynamicDataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#source) */ source?: DynamicMapLayer | DynamicDataLayer; /** * If a sublayer contains sublayers, this property is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) objects belonging to the given sublayer with sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This value can be defined in the map service or programmatically by the developer. It can also be useful for finding a specific sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title) */ title?: string; /** * Indicates if the layer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#visible) */ visible?: boolean; } /** - * A dynamic data layer is a layer created on-the-fly with data stored in a [registered workspace](https://server.arcgis.com/en/server/latest/publish-services/windows/overview-register-data-with-arcgis-server.htm). This is data that can be rendered and queried on the fly, but that isn't explicitly exposed as a service sublayer. Depending on the type of data source, these layers are classified as one of the following: - * + * A dynamic data layer is a layer created on-the-fly with data stored in a [registered workspace](https://server.arcgis.com/en/server/latest/publish-services/windows/overview-register-data-with-arcgis-server.htm). This is data that can be rendered and queried on the fly, but that isn't explicitly exposed as a service sublayer. Depending on the type of data source, these layers are classified as one of the following: + * * Data source | Description * ------------|------------ * [TableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) | A feature class with geometries or table without geometries. When a table data source does not contain geometries, it may be used as one of the sources in a [join operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource). Feature class tables may be used on their own since they contain a geometry field. * [QueryTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) | A feature class or table that may be queried on the fly with a SQL where clause. This data source is useful for scenarios where you have a table containing unique geometries and another table with multiple records that match to each geometry. You can use the QueryTableDataSource to select only a subset of those matching records (so records in both tables have a one-to-one relationship with each other) and join them to the table with geometries. * [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) | A raster dataset used for visualization purposes only. * [JoinTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) | This data source consists of two data sources joined by a common attribute or key. The left table data source typically contains geometries, while the right source may be a table or query table without geometries. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ export interface DynamicDataLayer extends Object { /** * This value is always `data-layer` and is inferred when the `dataSource` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ type: string; /** * A table, feature class, or raster that resides in a registered workspace (either a folder or geodatabase). The data sources are not visible in the Services Directory by default. They may be viewed, published, and configured using the ArcGIS Server Manager. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ dataSource: TableDataSource | QueryTableDataSource | RasterDataSource | JoinTableDataSource; /** * Controls field visibility in the layer. Only specified fields will be visible. If `null`, all fields are visible in the dynamic layer. The specification for a field object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ fields: DynamicDataLayerFields[]; @@ -12931,25 +12931,25 @@ declare namespace __esri { /** * A dynamic map layer refers to a layer published in a map service that has dynamic layers enabled. This layer type may be used to create multiple [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#sublayers) that point to the same service layer, but are assigned different definition expressions, renderers, and other properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ export interface DynamicMapLayer extends Object { /** * This value is always `map-layer` and is inferred when the `mapLayerId` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ type: string; /** * The [id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) of the service sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ mapLayerId: number; /** * An optional property for specifying the GDB version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicMapLayer) */ gdbVersion: string; @@ -12957,49 +12957,49 @@ declare namespace __esri { /** * The result of an on-the-fly join operation at runtime. Nested joins are supported. To use nested joins, set either `leftTableSource` or `rightTableSource` to `join-table`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ export interface JoinTableDataSource extends Object { /** * This value is always `join-table` and is inferred when other join table properties of this object are set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ type: string; /** * The field name used for joining or matching records in the left table to records in the right table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ leftTableKey: string; /** * The field name used for joining or matching records in the right table to records in the left table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ rightTableKey: string; /** * The left table for joining to the right table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ leftTableSource: DynamicMapLayer | DynamicDataLayer; /** * The right table for joining to the left table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ rightTableSource: DynamicMapLayer | DynamicDataLayer; /** - * The type of join that will be performed. - * + * The type of join that will be performed. + * * Possible Value | Description * ---------------|------------ * left-outer-join | Unmatched records in the left table source are preserved and joined with `null` values in the right table source. * left-inner-join | Records in the left table source are discarded if they are unmatched with records in the right table source. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinTableDataSource) */ joinType: string; @@ -13007,43 +13007,43 @@ declare namespace __esri { /** * A query table is a feature class or table defined by a SQL query on the fly. Query layers allow both spatial and nonspatial information stored in a database to be easily integrated into map service operations. Since a query table uses SQL to directly query database tables and views, spatial information used by a query table is not required to be in a geodatabase. This data source is useful for scenarios where you have a table containing multiple records that match to a single geometry in either another table or a map service layer. You can use the QueryTableDataSource to select only a subset of those matching records and join them to the table with geometries so records in both tables have a one-to-one relationship with each other. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ export interface QueryTableDataSource extends Object { /** * This value is always `query-table` and is inferred when the `query` property of this object is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ type: string; /** * The workspace where the data resides (defined in ArcGIS Server Manager). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ workspaceId: string; /** * The SQL query used to filter records. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ query: string; /** * The field name(s) containing the unique IDs for each record in the table. This can be a comma separated list if the query table is used in a [JoinTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#JoinDataTableSource). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ oidFields: string; /** * The spatial reference of the geometry of each feature in the table source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ spatialReference: SpatialReference; /** * The geometry type of each record in the table. **Possible Values:** point | multipoint | polyline | polygon | multipatch - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#QueryTableDataSource) */ geometryType: string; @@ -13051,25 +13051,25 @@ declare namespace __esri { /** * A file-based raster that resides in a registered raster workspace. The raster may only be displayed in the view, not queried or assigned a renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ export interface RasterDataSource extends Object { /** * This value is always `raster`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ type: string; /** * The workspace where the raster resides as defined in the ArcGIS Server Manager. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ workspaceId: string; /** * The name of the raster in the registered workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#RasterDataSource) */ dataSourceName: string; @@ -13077,31 +13077,31 @@ declare namespace __esri { /** * A table or feature class that resides in a registered workspace (either a folder or geodatabase). In the case of a geodatabase, if versioned, use `version` to switch to an alternate geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ export interface TableDataSource extends Object { /** * This value is always `table`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ type: string; /** * The workspace where the table resides as defined in the ArcGIS Server Manager. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ workspaceId: string; /** * The name of the table in the registered workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ dataSourceName: string; /** * References the geodatabase version if multiple versions exist in the geodatabase. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#TableDataSource) */ gdbVersion: string; @@ -13111,13 +13111,13 @@ declare namespace __esri { export interface DynamicDataLayerFields extends Object { /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ name: string; /** * The alias of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#DynamicDataLayer) */ alias: string; @@ -13126,63 +13126,63 @@ declare namespace __esri { interface TileInfo extends Accessor, JSONSupport { /** * The dots per inch (DPI) of the tiling scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#dpi) */ dpi: number; /** * Image format of the cached tiles. **Possible Values:** png | png24 | png32 | jpg | dib | tiff | emf | ps | pdf | gif | svg | svgz | mixed | lerc - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#format) */ format: string; /** * Indicates if the tiling scheme supports wrap around. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#isWrappable) */ isWrappable: boolean; /** * An array of levels of detail that define the tiling scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods) */ lods: LOD[]; /** * The tiling scheme origin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#origin) */ origin: Point; /** * Size of tiles in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#size) */ size: number[]; /** * The spatial reference of the tiling schema. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#spatialReference) */ spatialReference: SpatialReference; /** * Utility method used to convert a scale value to its corresponding zoom value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#scaleToZoom) - * + * * @param scale The scale value to convert. - * + * */ scaleToZoom(scale: number): number; /** * Utility method used to convert a zoom value to its corresponding scale value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#zoomToScale) - * + * * @param zoom The zoom value to convert. - * + * */ zoomToScale(zoom: number): number; } @@ -13195,14 +13195,14 @@ declare namespace __esri { /** * A convenience method used to create a new TileInfo instance with preset properties like [LODs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods). Optionally, properties such as `size`, `scales[]`, and a `[SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html)` can also be set to calculate [LODs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods) for each TileInfo. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) - * + * * @param options An object that contains the size, scales, and/or [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to compute the new TileInfo instance. * @param options.size The size of each tile in pixels. * @param options.spatialReference The spatial reference for the new TileInfo instance. If the spatial reference is not WGS84 nor WebMercator, the origin of the TileInfo is `0.0`. * @param options.scales An array of scale values to use for the TileInfo. If none are specified, the scales from the [ArcGIS Online basemaps](https://www.arcgis.com/home/group.html?id=702026e41f6641fb85da88efe79dc166#overview) are used from level 0 through 24. - * + * */ create(options?: TileInfoCreateOptions): TileInfo; @@ -13214,43 +13214,43 @@ declare namespace __esri { interface TileInfoProperties { /** * The dots per inch (DPI) of the tiling scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#dpi) */ dpi?: number; /** * Image format of the cached tiles. **Possible Values:** png | png24 | png32 | jpg | dib | tiff | emf | ps | pdf | gif | svg | svgz | mixed | lerc - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#format) */ format?: string; /** * Indicates if the tiling scheme supports wrap around. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#isWrappable) */ isWrappable?: boolean; /** * An array of levels of detail that define the tiling scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#lods) */ lods?: LODProperties[]; /** * The tiling scheme origin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#origin) */ origin?: PointProperties; /** * Size of tiles in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#size) */ size?: number[]; /** * The spatial reference of the tiling schema. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; @@ -13260,25 +13260,25 @@ declare namespace __esri { export interface TileInfoCreateOptions extends Object { /** * The size of each tile in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) - * + * * @default 256 */ size?: number; /** * The spatial reference for the new TileInfo instance. If the spatial reference is not WGS84 nor WebMercator, the origin of the TileInfo is `0.0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) - * + * * @default WebMercator */ spatialReference?: SpatialReference; /** * An array of scale values to use for the TileInfo. If none are specified, the scales from the [ArcGIS Online basemaps](https://www.arcgis.com/home/group.html?id=702026e41f6641fb85da88efe79dc166#overview) are used from level 0 through 24. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html#create) - * + * * @default The scales provided by ArcGIS Online basemaps */ scales?: number[]; @@ -13287,29 +13287,29 @@ declare namespace __esri { interface TileMatrixSet extends Accessor, JSONSupport { /** * The full extent of the TileMatrixSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the TileMatrixSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#id) */ id: string; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#tileInfo) */ tileInfo: TileInfo; /** * Creates a deep clone of this TileMatrixSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#clone) - * - * + * + * */ clone(): TileMatrixSet; } @@ -13327,19 +13327,19 @@ declare namespace __esri { interface TileMatrixSetProperties { /** * The full extent of the TileMatrixSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the TileMatrixSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#id) */ id?: string; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html#tileInfo) */ tileInfo?: TileInfoProperties; @@ -13348,95 +13348,95 @@ declare namespace __esri { interface WMSSublayer extends Accessor { /** * Description for the WMS sublayer. This defaults to the value of the Abstract property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#description) */ description: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#fullExtent) */ fullExtent: Extent; /** * The id for the WMS sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#id) */ id: number; /** * The [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#layer) */ layer: WMSLayer; /** * Indicates whether the layer will be included in the legend. When `false`, the layer will be excluded from the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * A string url pointing to a legend image for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendUrl) */ legendUrl: string; /** * Name of the WMS sublayer. This defaults to the value of the Name property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#name) */ name: string; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#popupEnabled) - * + * * @default false */ popupEnabled: boolean; /** * Indicates if the layer can be queried, i.e. the service supports GetFeatureInfo with either text/html or text/plain formats. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#queryable) - * + * * @default false */ queryable: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#spatialReferences) */ spatialReferences: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#sublayers) */ sublayers: Collection; /** * The title of the WMS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This defaults to the value of the Title property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#title) */ title: string; /** * Indicates if the layer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#visible) */ visible: boolean; /** * Creates a deep clone of the WMS sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#clone) - * - * + * + * */ clone(): WMSSublayer; } @@ -13452,85 +13452,85 @@ declare namespace __esri { interface WMSSublayerProperties { /** * Description for the WMS sublayer. This defaults to the value of the Abstract property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#description) */ description?: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The id for the WMS sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#id) */ id?: number; /** * The [WMSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#layer) */ layer?: WMSLayerProperties; /** * Indicates whether the layer will be included in the legend. When `false`, the layer will be excluded from the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * A string url pointing to a legend image for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#legendUrl) */ legendUrl?: string; /** * Name of the WMS sublayer. This defaults to the value of the Name property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#name) */ name?: string; /** * Indicates whether to display popups when features in the layer are clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#popupEnabled) - * + * * @default false */ popupEnabled?: boolean; /** * Indicates if the layer can be queried, i.e. the service supports GetFeatureInfo with either text/html or text/plain formats. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#queryable) - * + * * @default false */ queryable?: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#spatialReferences) */ spatialReferences?: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The title of the WMS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This defaults to the value of the Title property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#title) */ title?: string; /** * Indicates if the layer is visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#visible) */ visible?: boolean; @@ -13539,35 +13539,35 @@ declare namespace __esri { interface WMTSStyle extends Accessor, JSONSupport { /** * Description for the WMTS style. This defaults to the value of the Abstract property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#description) */ description: string; /** * The unique ID assigned to the style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#id) */ id: string; /** * The URL to the legend which gets used in [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. This defaults to the value of the LegendURL property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#legendUrl) */ legendUrl: string; /** * The title of the WMTS style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#title) */ title: string; /** * Creates a deep clone of the WMTSStyle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#clone) - * - * + * + * */ clone(): WMTSStyle; } @@ -13585,25 +13585,25 @@ declare namespace __esri { interface WMTSStyleProperties { /** * Description for the WMTS style. This defaults to the value of the Abstract property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#description) */ description?: string; /** * The unique ID assigned to the style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#id) */ id?: string; /** * The URL to the legend which gets used in [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. This defaults to the value of the LegendURL property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#legendUrl) */ legendUrl?: string; /** * The title of the WMTS style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html#title) */ title?: string; @@ -13612,83 +13612,83 @@ declare namespace __esri { interface WMTSSublayer extends Accessor, JSONSupport { /** * Description for the WMTS sublayer. This defaults to the value of the Abstract property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#description) */ description: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#fullExtent) */ fullExtent: Extent; /** * The unique ID assigned to the sublayer. If not set by the developer, it is automatically generated when the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#id) */ id: string; /** * The map image format (MIME type) to request. Defaults to the first item in [imageFormats](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats). Must be one of the supported [imageFormats](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormat) */ imageFormat: string; /** * Supported image formats as retrieved from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats) */ imageFormats: string[]; /** * The [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#layer) */ layer: WMTSLayer; /** * The [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html) to request. Defaults to the id of the first item in [styles](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles). Should be one of the supported [styles](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styleId) */ styleId: string; /** * A collection of supported [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html)s as retrieved from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles) */ styles: Collection; /** * The [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. Defaults to the first item in [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) that matches the spatialReference of the view. Must be one of the supported [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) */ tileMatrixSet: TileMatrixSet; /** * The id of the [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. Defaults to the id of the first item in [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) that matches the spatialReference of the view. Must be one of the supported [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSetId) */ tileMatrixSetId: string; /** * A collection of supported [TileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSets) */ tileMatrixSets: Collection; /** * The title of the WMTS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This defaults to the value of the Title property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#title) */ title: string; /** * Creates a deep clone of the WMTS sublayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#clone) - * - * + * + * */ clone(): WMTSSublayer; } @@ -13706,73 +13706,73 @@ declare namespace __esri { interface WMTSSublayerProperties { /** * Description for the WMTS sublayer. This defaults to the value of the Abstract property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#description) */ description?: string; /** * The full extent of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#fullExtent) */ fullExtent?: ExtentProperties; /** * The unique ID assigned to the sublayer. If not set by the developer, it is automatically generated when the layer is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#id) */ id?: string; /** * The map image format (MIME type) to request. Defaults to the first item in [imageFormats](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats). Must be one of the supported [imageFormats](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormat) */ imageFormat?: string; /** * Supported image formats as retrieved from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#imageFormats) */ imageFormats?: string[]; /** * The [WMTSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html) to which the sublayer belongs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#layer) */ layer?: WMTSLayerProperties; /** * The [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html) to request. Defaults to the id of the first item in [styles](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles). Should be one of the supported [styles](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styleId) */ styleId?: string; /** * A collection of supported [WMTSStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSStyle.html)s as retrieved from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#styles) */ styles?: CollectionProperties; /** * The [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. Defaults to the first item in [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) that matches the spatialReference of the view. Must be one of the supported [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) */ tileMatrixSet?: TileMatrixSetProperties; /** * The id of the [TileMatrixSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html) to request. Defaults to the id of the first item in [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet) that matches the spatialReference of the view. Must be one of the supported [tileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSet). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSetId) */ tileMatrixSetId?: string; /** * A collection of supported [TileMatrixSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileMatrixSet.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#tileMatrixSets) */ tileMatrixSets?: CollectionProperties; /** * The title of the WMTS sublayer used to identify it in places such as the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) and [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widgets. This defaults to the value of the Title property from the WMTS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#title) */ title?: string; @@ -13781,19 +13781,19 @@ declare namespace __esri { interface TileLayer extends Layer, SublayersOwner, ArcGISMapService, ArcGISCachedService, RefreshableLayer, ScaleRangeLayer, PortalLayer { /** * A flat [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of all the [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sublayers) in the TileLayer including the sublayers of its sublayers. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#allSublayers) */ readonly allSublayers: Collection; /** * The URL that points to the location of the layer's attribution data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#attributionDataUrl) */ readonly attributionDataUrl: string; /** * Indicates if the layer has attribution data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#hasAttributionData) */ readonly hasAttributionData: boolean; @@ -13803,51 +13803,51 @@ declare namespace __esri { * * [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled) * * [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupTemplate) * * [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#title) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#sublayers) */ readonly sublayers: Collection; /** * An array of tile servers used for changing map tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#tileServers) */ tileServers: string[]; /** * For [TileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) the type is `tile`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#type) */ readonly type: "tile"; /** * The URL of the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#url) */ url: string; /** * This method fetches a tile for the given level, row and column present in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#fetchTile) - * + * * @param level Level of detail of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param row The row(y) position of the tile fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param col The column(x) position of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param options Optional settings for the tile request. The options have the following properties. * @param options.timestamp Number to append to the tile request to prevent fetching the tile from the browser cache. - * + * */ fetchTile(level: number, row: number, col: number, options?: TileLayerFetchTileOptions): IPromise; /** * This method returns a URL to a tile for a given level, row and column. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#getTileUrl) - * + * * @param level The requested tile's level. * @param row The requested tile's row. * @param col The requested tile's column. - * + * */ getTileUrl(level: number, row: number, col: number): string; @@ -13860,7 +13860,7 @@ declare namespace __esri { interface TileLayerConstructor { /** * The TileLayer allows you work with a cached [map service](http://server.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm) exposed by the ArcGIS Server REST API and add it to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) as a tile layer. A cached service accesses tiles from a cache instead of dynamically rendering images. Because they are cached, tiled layers render faster than [MapImageLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). To create an instance of TileLayer, you must reference the URL of the cached map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) */ @@ -13874,13 +13874,13 @@ declare namespace __esri { interface TileLayerProperties extends LayerProperties, ArcGISMapServiceProperties, ArcGISCachedServiceProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, PortalLayerProperties { /** * An array of tile servers used for changing map tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#tileServers) */ tileServers?: string[]; /** * The URL of the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#url) */ url?: string; @@ -13904,7 +13904,7 @@ declare namespace __esri { export interface TileLayerFetchTileOptions extends Object { /** * Number to append to the tile request to prevent fetching the tile from the browser cache. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html#fetchTile) */ timestamp?: boolean; @@ -13920,7 +13920,7 @@ declare namespace __esri { interface UnknownLayerConstructor { /** * Represents a layer whose type could not be determined. For example, when loading a layer from a URL and the layer type cannot be determined, then it is represented as an instance of this class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-UnknownLayer.html) */ @@ -13983,66 +13983,66 @@ declare namespace __esri { interface VectorTileLayer extends Layer, ScaleRangeLayer { /** * The URL that points to the location of the layer's attribution data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#attributionDataUrl) */ readonly attributionDataUrl: string; /** * Indicates the layer's supported capabilities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ readonly capabilities: VectorTileLayerCapabilities; /** * The current style information of the VectorTileLayer. See the object specification below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ readonly currentStyleInfo: VectorTileLayerCurrentStyleInfo; /** * The portal item from which the layer is loaded. This will load the layer from the portal item, not the vector tile service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#portalItem) */ portalItem: PortalItem; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * A style JSON object of vector tiles that will be used to render the layer. If initializing the layer with a style JSON object, the tiles are fetched from the tile servers specified in the style object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#style) */ style: any; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use [IdentityManager.registerToken()](https://developers.arcgis.com/javascript/latest/api-reference/esri-identity-IdentityManager.html#registerToken). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#token) */ readonly token: string; /** * The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer. If specifying a URL to a style, the tiles are fetched from the tile servers specified in the style object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#url) */ url: string; /** * Loads a style to render a layer from the specified URL to a style resource or style JSON object. It is equivalent of changing the entire CSS style sheet for web page. When loading a style, it is the developer's responsibility to make sure that any relative urls in the style resolve correctly. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#loadStyle) - * + * * @param style The URL to a style of vector tiles or style JSON object. - * + * */ loadStyle(style: string | any): IPromise; @@ -14055,7 +14055,7 @@ declare namespace __esri { interface VectorTileLayerConstructor { /** * A VectorTileLayer accesses cached tiles of data and renders it in vector format. It is similar to a [WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) in the context of caching; however, a [WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) renders as a series of images, not vector data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) */ @@ -14069,31 +14069,31 @@ declare namespace __esri { interface VectorTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties { /** * The portal item from which the layer is loaded. This will load the layer from the portal item, not the vector tile service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#portalItem) */ portalItem?: PortalItemProperties; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * A style JSON object of vector tiles that will be used to render the layer. If initializing the layer with a style JSON object, the tiles are fetched from the tile servers specified in the style object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#style) */ style?: any; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; /** * The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer. If specifying a URL to a style, the tiles are fetched from the tile servers specified in the style object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#url) */ url?: string; @@ -14117,7 +14117,7 @@ declare namespace __esri { export interface VectorTileLayerCapabilities extends Object { /** * Indicates options supported by the exportTiles operation. Will be `null` if the `supportsExportTiles` is `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ exportTiles: any; @@ -14125,7 +14125,7 @@ declare namespace __esri { exportMap: VectorTileLayerCapabilitiesExportMap; /** * Indicates operations that can be performed on the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ operations: VectorTileLayerCapabilitiesOperations; @@ -14135,7 +14135,7 @@ declare namespace __esri { export interface VectorTileLayerCapabilitiesExportMap extends Object { /** * Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ maxExportTilesCount: number; @@ -14145,13 +14145,13 @@ declare namespace __esri { export interface VectorTileLayerCapabilitiesOperations extends Object { /** * Indicates if the tiles from the service can be exported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ supportsExportTiles: boolean; /** * Indicates if the service exposes a tile map that describes the presence of tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#capabilities) */ supportsTileMap: boolean; @@ -14161,37 +14161,37 @@ declare namespace __esri { export interface VectorTileLayerCurrentStyleInfo extends Object { /** * Absolute URL for a vector tile service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ serviceUrl: string; /** * Absolute URL for vector tile service style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ styleUrl: string; /** * Absolute URL for sprites included in a style. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ spriteUrl: string; /** * Absolute template URL for font sets included in a style. The URL includes `{fontstack}` and `{range}` tokens. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ glyphsUrl: string; /** * Style JSON object for vector tiles. Style object includes `version` of the style specification, `sprite` and `glyphs` properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ style: any; /** * Vector tile service information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo) */ layerDefinition: any; @@ -14200,71 +14200,71 @@ declare namespace __esri { interface WebTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer { /** * The attribution information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#copyright) */ copyright: string; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#spatialReference) - * + * * @default Web Mercator Auxiliary Sphere (wkid: 3857) */ readonly spatialReference: SpatialReference; /** * A string of subDomain names where tiles are served to speed up tile retrieval. If subDomains are specified, the [urlTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) should include a `{subDomain}` place holder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) */ subDomains: string[]; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileInfo) */ tileInfo: TileInfo; /** * The list of tile server urls for the layer. It's computed from the [urlTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) and the list of [subDomains](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileServers) */ readonly tileServers: string[]; /** * For [WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) the type is `web-tile`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#type) */ readonly type: "web-tile"; /** * URL template for the hosted tiles. The `urlTemplate` should contain a `{subDomain}` place holder if [subDomains](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) are specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) */ urlTemplate: string; /** * This method fetches a tile for the given level, row and column present in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#fetchTile) - * + * * @param level Level of detail of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param row The row(y) position of the tile fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param column The column(x) position of the tile to fetch. This value is provided by [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html). * @param options Optional settings for the tile request. The options have the following properties. * @param options.timestamp A timestamp to append to the tile url to avoid loading a cached version of the tile. - * + * */ fetchTile(level: number, row: number, column: number, options?: WebTileLayerFetchTileOptions): IPromise; /** * This method returns a URL to a tile for a given level, row and column. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#getTileUrl) - * + * * @param level The requested tile's level. * @param row The requested tile's row. * @param column The requested tile's column. - * + * */ getTileUrl(level: number, row: number, column: number): string; @@ -14277,7 +14277,7 @@ declare namespace __esri { interface WebTileLayerConstructor { /** * WebTileLayer provides a simple way to add non-ArcGIS Server map tiles as a layer to a map. The constructor takes a URL template that usually follows a pattern of `http://some.domain.com/{level}/{col}/{row}/` where `level` corresponds to a zoom level, and `column` and `row` represent tile column and row, respectively. This pattern is not required, but is the most common one currently on the web. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) */ @@ -14289,25 +14289,25 @@ declare namespace __esri { interface WebTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * The attribution information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#copyright) */ copyright?: string; /** * A string of subDomain names where tiles are served to speed up tile retrieval. If subDomains are specified, the [urlTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) should include a `{subDomain}` place holder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) */ subDomains?: string[]; /** * The tiling scheme information for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileInfo) */ tileInfo?: TileInfoProperties; /** * URL template for the hosted tiles. The `urlTemplate` should contain a `{subDomain}` place holder if [subDomains](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains) are specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate) */ urlTemplate?: string; @@ -14331,7 +14331,7 @@ declare namespace __esri { export interface WebTileLayerFetchTileOptions extends Object { /** * A timestamp to append to the tile url to avoid loading a cached version of the tile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#fetchTile) */ timestamp?: boolean; @@ -14340,136 +14340,136 @@ declare namespace __esri { interface WMSLayer extends Layer, PortalLayer, ScaleRangeLayer, RefreshableLayer { /** * Copyright information for the WMS service. This defaults to the value of the AccessConstraints property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#copyright) */ copyright: string; /** * Use this to append different custom parameters to the WMS map requests. The custom layer parameters are applied to GetMap and GetFeatureInfo. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customLayerParameters) */ customLayerParameters: any; /** * Use this to append custom parameters to all WMS requests. The custom parameters are applied to GetCapabilities, GetMap and GetFeatureInfo. For example, if an access key is required, the key can be configured as a custom parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customParameters) */ customParameters: any; /** * Description for the WMS layer. This defaults to the value of the Abstract property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#description) */ description: string; /** * Return format of feature information (MIME type). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoFormat) */ featureInfoFormat: string; /** * The URL for the WMS GetFeatureInfo call. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoUrl) */ featureInfoUrl: string; /** * All bounding boxes defined for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fullExtents) */ fullExtents: Extent[]; /** * The map image format (MIME type) to request. Defaults to `image/png` if the WMS service supports it. If not, it defaults to the value of the first `` in `` in the GetCapabilities response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageFormat) */ imageFormat: string; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxHeight) - * + * * @default 2048 */ imageMaxHeight: number; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxWidth) - * + * * @default 2048 */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageTransparency) - * + * * @default true */ imageTransparency: boolean; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReference) */ spatialReference: SpatialReference; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReferences) */ spatialReferences: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) */ sublayers: Collection; /** * The URL of the WMS service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#url) */ url: string; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. For example, `1.3.0`, `1.1.1`, `1.1` or `1.0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#version) */ version: string; /** * Fetching the WMS image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) - * + * * @param extent The extent of the view. * @param width The width of the view in pixels. * @param height The height of the view in pixels. * @param options The parameter options is an object with the following properties. * @param options.pixelRatio The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. * @param options.rotation The rotation in degrees of the exported image. - * + * */ fetchImage(extent: Extent, width: number, height: number, options?: WMSLayerFetchImageOptions): IPromise; /** * Returns a [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html) based on the given sublayer id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#findSublayerById) - * + * * @param id The [id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html#id) of the WMS sublayer. - * + * */ findSublayerById(id: number): WMSSublayer; @@ -14492,111 +14492,111 @@ declare namespace __esri { interface WMSLayerProperties extends LayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * Copyright information for the WMS service. This defaults to the value of the AccessConstraints property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#copyright) */ copyright?: string; /** * Use this to append different custom parameters to the WMS map requests. The custom layer parameters are applied to GetMap and GetFeatureInfo. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customLayerParameters) */ customLayerParameters?: any; /** * Use this to append custom parameters to all WMS requests. The custom parameters are applied to GetCapabilities, GetMap and GetFeatureInfo. For example, if an access key is required, the key can be configured as a custom parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#customParameters) */ customParameters?: any; /** * Description for the WMS layer. This defaults to the value of the Abstract property from the WMS GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#description) */ description?: string; /** * Return format of feature information (MIME type). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoFormat) */ featureInfoFormat?: string; /** * The URL for the WMS GetFeatureInfo call. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#featureInfoUrl) */ featureInfoUrl?: string; /** * All bounding boxes defined for the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fullExtents) */ fullExtents?: ExtentProperties[]; /** * The map image format (MIME type) to request. Defaults to `image/png` if the WMS service supports it. If not, it defaults to the value of the first `` in `` in the GetCapabilities response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageFormat) */ imageFormat?: string; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxHeight) - * + * * @default 2048 */ imageMaxHeight?: number; /** * Indicates the maximum height of the image exported by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageMaxWidth) - * + * * @default 2048 */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#imageTransparency) - * + * * @default true */ imageTransparency?: boolean; /** * Indicates whether the layer will be included in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * The spatial reference of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#spatialReferences) */ spatialReferences?: number[]; /** * A collection of [WMSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMSSublayer.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The URL of the WMS service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#url) */ url?: string; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. For example, `1.3.0`, `1.1.1`, `1.1` or `1.0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#version) */ version?: string; @@ -14620,13 +14620,13 @@ declare namespace __esri { export interface WMSLayerFetchImageOptions extends Object { /** * The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ pixelRatio?: number; /** * The rotation in degrees of the exported image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#fetchImage) */ rotation?: number; @@ -14635,62 +14635,62 @@ declare namespace __esri { interface WMTSLayer extends Layer, PortalLayer, ScaleRangeLayer, RefreshableLayer { /** * Currently active sublayer. Defaults to the first sublayer in [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#activeLayer) */ activeLayer: WMTSSublayer; /** * Copyright information for the WMTS service. This defaults to the value of the AccessConstraints property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#copyright) */ copyright: string; /** * Use this to append different custom parameters to the WMTS tile requests. The custom layer parameters are applied to GetTile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customLayerParameters) */ customLayerParameters: any; /** * Use this to append custom parameters to all WMTS requests. The custom parameters are applied to GetCapabilities and GetTile. For example, if an access key is required, the key can be configured as a custom parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customParameters) */ customParameters: any; /** * The service mode for the WMTS layer. If not specified, the API will first make a getCapabilities request using `RESTful`. If that fails, it will try using `KVP`. **Possible Values:** RESTful | KVP - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#serviceMode) - * + * * @default RESTful */ serviceMode: string; /** * A collection of [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers) */ sublayers: Collection; /** * The URL of the WMTS service. The URL for the GetCapabilities is created based on the url and serviceMode properties. For example https://gibs.earthdata.nasa.gov/wmts/epsg4326/best. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#url) */ url: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. Probably `1.0.0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#version) */ version: string; /** * Returns a [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) based on the given sublayer id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#findSublayerById) - * + * * @param id The [id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html#id) of the WMTS sublayer. - * + * */ findSublayerById(id: string): WMTSSublayer; @@ -14713,51 +14713,51 @@ declare namespace __esri { interface WMTSLayerProperties extends LayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties { /** * Currently active sublayer. Defaults to the first sublayer in [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#activeLayer) */ activeLayer?: WMTSSublayerProperties; /** * Copyright information for the WMTS service. This defaults to the value of the AccessConstraints property from the GetCapabilities request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#copyright) */ copyright?: string; /** * Use this to append different custom parameters to the WMTS tile requests. The custom layer parameters are applied to GetTile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customLayerParameters) */ customLayerParameters?: any; /** * Use this to append custom parameters to all WMTS requests. The custom parameters are applied to GetCapabilities and GetTile. For example, if an access key is required, the key can be configured as a custom parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#customParameters) */ customParameters?: any; /** * The service mode for the WMTS layer. If not specified, the API will first make a getCapabilities request using `RESTful`. If that fails, it will try using `KVP`. **Possible Values:** RESTful | KVP - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#serviceMode) - * + * * @default RESTful */ serviceMode?: string; /** * A collection of [WMTSSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-WMTSSublayer.html) objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#sublayers) */ sublayers?: CollectionProperties; /** * The URL of the WMTS service. The URL for the GetCapabilities is created based on the url and serviceMode properties. For example https://gibs.earthdata.nasa.gov/wmts/epsg4326/best. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#url) */ url?: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. Probably `1.0.0`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMTSLayer.html#version) */ version?: string; @@ -14780,13 +14780,13 @@ declare namespace __esri { interface Map extends Accessor, LayersMixin { /** * A flat collection of all the [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) in the map. This collection contains [basemap layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap), [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) and [ground layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground). [Group Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) and their [children layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html#layers) are also part of this collection. Reference layers in the basemap will always be included at the end of the collection. Layers should not be added directly to this collection. They must only be added via the [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers), [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or [ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#allLayers) */ readonly allLayers: Collection; /** - * Specifies a basemap for the map. The basemap is a set of tile layers that give geographic context to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the other [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. - * + * Specifies a basemap for the map. The basemap is a set of tile layers that give geographic context to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the other [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. + * * Value | Description * ------|------------ * streets | ![basemap-streets](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets.jpg) @@ -14806,8 +14806,8 @@ declare namespace __esri { * streets-night-vector | ![streets-night-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-night.jpg) * streets-relief-vector | ![streets-relief-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-relief.jpg) * streets-navigation-vector | ![streets-navigation-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-navigation.jpg) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) */ basemap: Basemap; @@ -14815,10 +14815,10 @@ declare namespace __esri { * Specifies the surface properties for the map. This property is only relevant when adding the map to a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It renders the terrain or topographical variations in the real world on the map's surface with a collection of [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html). This value can be an instance of [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html), or one of the following strings: * * `world-elevation` for a default instance of ground using the [Terrain3D Service](https://www.arcgis.com/home/item.html?id=7029fb60158543ad845c7e1527af11e4). * * `world-topobathymetry` for an instance of ground that combines surface elevation and bathymetry using the [TopoBathy3D Service](https://www.arcgis.com/home/item.html?id=0c69ba5a5d254118841d43f03aa3e97d). - * - * + * + * * The ground may not be set to `null` or `undefined`, it is guaranteed to always contain an instance of type [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html). The elevation can be removed from the ground by setting the ground property to a new empty [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) instance or by removing all the ground layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) */ ground: Ground; @@ -14827,7 +14827,7 @@ declare namespace __esri { interface MapConstructor { /** * The Map class contains properties and methods for storing, managing, and overlaying [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) common to both 2D and 3D viewing. Layers can be added and removed from the map, but are rendered via a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) (for viewing data in 2D) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) (for viewing data in 3D). Thus a map instance is a simple container that holds the layers, while the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is the means of displaying and interacting with a map's layers and basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) */ @@ -14838,8 +14838,8 @@ declare namespace __esri { interface MapProperties extends LayersMixinProperties { /** - * Specifies a basemap for the map. The basemap is a set of tile layers that give geographic context to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the other [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. - * + * Specifies a basemap for the map. The basemap is a set of tile layers that give geographic context to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the other [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. + * * Value | Description * ------|------------ * streets | ![basemap-streets](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets.jpg) @@ -14859,8 +14859,8 @@ declare namespace __esri { * streets-night-vector | ![streets-night-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-night.jpg) * streets-relief-vector | ![streets-relief-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-relief.jpg) * streets-navigation-vector | ![streets-navigation-vector](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets-navigation.jpg) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) */ basemap?: BasemapProperties | string; @@ -14868,10 +14868,10 @@ declare namespace __esri { * Specifies the surface properties for the map. This property is only relevant when adding the map to a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It renders the terrain or topographical variations in the real world on the map's surface with a collection of [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html). This value can be an instance of [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html), or one of the following strings: * * `world-elevation` for a default instance of ground using the [Terrain3D Service](https://www.arcgis.com/home/item.html?id=7029fb60158543ad845c7e1527af11e4). * * `world-topobathymetry` for an instance of ground that combines surface elevation and bathymetry using the [TopoBathy3D Service](https://www.arcgis.com/home/item.html?id=0c69ba5a5d254118841d43f03aa3e97d). - * - * + * + * * The ground may not be set to `null` or `undefined`, it is guaranteed to always contain an instance of type [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html). The elevation can be removed from the ground by setting the ground property to a new empty [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html) instance or by removing all the ground layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground) */ ground?: GroundProperties | string; @@ -14879,7 +14879,7 @@ declare namespace __esri { /** * A convenience module for importing [PointCloudRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/guide/typescript-setup/index.html). For example, rather than importing renderers one at a time like this: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-pointCloudRenderers.html) */ interface pointCloudRenderers { @@ -14890,12 +14890,12 @@ declare namespace __esri { interface PopupTemplate extends Accessor, JSONSupport { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. Each object represents an action or function that may be executed by clicking the icon or image symbolizing them in the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). By default, every [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. PopupTemplates do not have default actions. To override actions on the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) using PopupTemplate see [overwriteActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions). Actions defined in a PopupTemplate will only appear in the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) for features or layers that apply that particular PopupTemplate. The order of each action in the popup is the same order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). The [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event in [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the PopupTemplate that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions) */ actions: Collection; /** - * The template for defining and formatting a popup's content. Content may be defined with one of four types of values. + * The template for defining and formatting a popup's content. Content may be defined with one of four types of values. * * **String** - A popup's content can be a simple text or string value referencing field values or [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions. Expressions must be defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) property. These values are referenced via placeholders. Within the string, placeholders are denoted by `{fieldName}` or `{expression/expressionName}` which are used to specify which values from field attributes or expressions to display within certain locations in the string. When the application runs, substitution occurs and the placeholder is replaced with the actual attribute or expression value for the selected feature. The string can also include HTML markup and formatting functions. * * **Popup elements** - You can also display content as popup elements defined as an array of Objects. These elements can be used individually or combined. The order in which they are set determines how they display within the popup. See the items below describing each element. * * **text** - Object that provides descriptive text as content. This object must be defined using the [text popup element specification table](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#text). @@ -14904,61 +14904,61 @@ declare namespace __esri { * * **attachments** - Array of attachmentInfos objects listed in the popup. This object must be defined using the [attachments popup element specification table](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#attachments). * * **promise** - The PopupTemplate's content may also be defined with a promise that resolves to any of the above-mentioned elements. This is useful for cases when you run a task or execute a query and want to display the results in the popup. Simply pass the promise to the popupTemplate's content and ensure that it resolves to a string or other popup element. * * **function** - Content may be defined with a JavaScript function that returns any of the above-mentioned elements. This is handy when your popup requires additional processing or functionality than what is provided with the four content types listed above. For example, let’s assume that you would like to display charts using third-party JavaScript libraries or categorize information into separate tabs. In these cases, you can use a function that returns either a string, a reference to an HTML element, a popup element, or a promise. When the feature is clicked, the feature is passed as an argument to the function and provides access to the feature’s graphic and attributes. The function then executes and returns a value to display in the popup template. It is also possible to check a specific feature attribute and determine whether to apply a function based on its value. Out-of-the-box formatting functions can be used to format date, time, and number values. The syntax for using an out-of-the-box formatting function is: `{field-name:format-function-name(option-a: value, option-b: value)}` - * - * - * The formatter functions are described below: - * + * + * + * The formatter functions are described below: + * * Type | Description * ----- | ----------- * DateString | Formats the date into a human-readable format. Supports the following options: `hideTime: false` - When `true` shows time. Default value is `false`. `local: false` - Displays date and time in the local time zone. Default value is `false`. When `false` the date will display in UTC. `systemLocale: false` - Displays date and time in the system locale (local time zone). Default value is `false`. * DateFormat | Converts date fields into a human-readable format using [dojo/date/locale.format](https://dojotoolkit.org/reference-guide/1.10/dojo/date/locale/format.html) method. Supports the same options as [dojo/date/locale.format](https://dojotoolkit.org/reference-guide/1.10/dojo/date/locale/format.html). The following snippets show some usage examples: `{DATE_FIELD:DateFormat}` produces `3/8/08 4:00 PM`. `{DATE_FIELD:DateFormat(selector: 'date', fullYear: true)}` produces `4/8/2009`. * NumberFormat | Formats numbers into various formats using the [dojo/number.format](https://dojotoolkit.org/reference-guide/1.10/dojo/number.html#format) method. Supports the same set of options as [dojo/number.format](https://dojotoolkit.org/reference-guide/1.10/dojo/number.html#format). The following snippets show examples of usage pattern examples: `{Magnitude:NumberFormat}` produces `4.23456`. `{Magnitude:NumberFormat(places:2)}` produces `4.23`. - * + * * Out-of-the-box formatting functions and custom functions are supported as of version 4.1. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) */ content: string | any[] | Function | IPromise; /** * An array of objects that reference [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions. These expressions evaluate to either a number or a string value on a feature-by-feature basis at runtime. The values display within the view's popup as if they are field values. They can be displayed in a table using the `fieldInfos` of the popupTemplate's content or referenced within a simple string. See the object specification table below for a description of the properties that may be set in each object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ expressionInfos: PopupTemplateExpressionInfos[]; /** * An array of objects that defines how fields in the dataset or values from [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions participate in a popup. Each object contains properties for a single field or expression. See the object specification table below for available options to set on each field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ fieldInfos: PopupTemplateFieldInfos[]; /** * Additional options that can be defined for the popup layer. Currently supports one property, `showNoDataRecords`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#layerOptions) - * + * * @default null */ layerOptions: PopupTemplateLayerOptions; /** * An array of fields used in the PopupTemplate. Use this property to indicate what fields are required to fully render the PopupTemplate. To fetch the values from all fields, use `["*"]`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#outFields) - * + * * @default null */ outFields: string[]; /** * Indicates whether actions should replace existing [popup actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) - * + * * @default false */ overwriteActions: boolean; /** * The template for defining how to format the title used in a popup. You can format the title by specifying either a string value or a function that returns a simple string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#title) */ title: string | Function; @@ -14967,7 +14967,7 @@ declare namespace __esri { interface PopupTemplateConstructor { /** * A PopupTemplate formats and defines the content of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) for a specific [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) or [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). A PopupTemplate allows the user to access values from feature attributes and values returned from [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions when a feature in the view is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) */ @@ -14981,12 +14981,12 @@ declare namespace __esri { interface PopupTemplateProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. Each object represents an action or function that may be executed by clicking the icon or image symbolizing them in the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). By default, every [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. PopupTemplates do not have default actions. To override actions on the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) using PopupTemplate see [overwriteActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions). Actions defined in a PopupTemplate will only appear in the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) for features or layers that apply that particular PopupTemplate. The order of each action in the popup is the same order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). The [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event in [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the PopupTemplate that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions) */ actions?: CollectionProperties; /** - * The template for defining and formatting a popup's content. Content may be defined with one of four types of values. + * The template for defining and formatting a popup's content. Content may be defined with one of four types of values. * * **String** - A popup's content can be a simple text or string value referencing field values or [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions. Expressions must be defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) property. These values are referenced via placeholders. Within the string, placeholders are denoted by `{fieldName}` or `{expression/expressionName}` which are used to specify which values from field attributes or expressions to display within certain locations in the string. When the application runs, substitution occurs and the placeholder is replaced with the actual attribute or expression value for the selected feature. The string can also include HTML markup and formatting functions. * * **Popup elements** - You can also display content as popup elements defined as an array of Objects. These elements can be used individually or combined. The order in which they are set determines how they display within the popup. See the items below describing each element. * * **text** - Object that provides descriptive text as content. This object must be defined using the [text popup element specification table](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#text). @@ -14995,61 +14995,61 @@ declare namespace __esri { * * **attachments** - Array of attachmentInfos objects listed in the popup. This object must be defined using the [attachments popup element specification table](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#attachments). * * **promise** - The PopupTemplate's content may also be defined with a promise that resolves to any of the above-mentioned elements. This is useful for cases when you run a task or execute a query and want to display the results in the popup. Simply pass the promise to the popupTemplate's content and ensure that it resolves to a string or other popup element. * * **function** - Content may be defined with a JavaScript function that returns any of the above-mentioned elements. This is handy when your popup requires additional processing or functionality than what is provided with the four content types listed above. For example, let’s assume that you would like to display charts using third-party JavaScript libraries or categorize information into separate tabs. In these cases, you can use a function that returns either a string, a reference to an HTML element, a popup element, or a promise. When the feature is clicked, the feature is passed as an argument to the function and provides access to the feature’s graphic and attributes. The function then executes and returns a value to display in the popup template. It is also possible to check a specific feature attribute and determine whether to apply a function based on its value. Out-of-the-box formatting functions can be used to format date, time, and number values. The syntax for using an out-of-the-box formatting function is: `{field-name:format-function-name(option-a: value, option-b: value)}` - * - * - * The formatter functions are described below: - * + * + * + * The formatter functions are described below: + * * Type | Description * ----- | ----------- * DateString | Formats the date into a human-readable format. Supports the following options: `hideTime: false` - When `true` shows time. Default value is `false`. `local: false` - Displays date and time in the local time zone. Default value is `false`. When `false` the date will display in UTC. `systemLocale: false` - Displays date and time in the system locale (local time zone). Default value is `false`. * DateFormat | Converts date fields into a human-readable format using [dojo/date/locale.format](https://dojotoolkit.org/reference-guide/1.10/dojo/date/locale/format.html) method. Supports the same options as [dojo/date/locale.format](https://dojotoolkit.org/reference-guide/1.10/dojo/date/locale/format.html). The following snippets show some usage examples: `{DATE_FIELD:DateFormat}` produces `3/8/08 4:00 PM`. `{DATE_FIELD:DateFormat(selector: 'date', fullYear: true)}` produces `4/8/2009`. * NumberFormat | Formats numbers into various formats using the [dojo/number.format](https://dojotoolkit.org/reference-guide/1.10/dojo/number.html#format) method. Supports the same set of options as [dojo/number.format](https://dojotoolkit.org/reference-guide/1.10/dojo/number.html#format). The following snippets show examples of usage pattern examples: `{Magnitude:NumberFormat}` produces `4.23456`. `{Magnitude:NumberFormat(places:2)}` produces `4.23`. - * + * * Out-of-the-box formatting functions and custom functions are supported as of version 4.1. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) */ content?: string | any[] | Function | IPromise; /** * An array of objects that reference [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions. These expressions evaluate to either a number or a string value on a feature-by-feature basis at runtime. The values display within the view's popup as if they are field values. They can be displayed in a table using the `fieldInfos` of the popupTemplate's content or referenced within a simple string. See the object specification table below for a description of the properties that may be set in each object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ expressionInfos?: PopupTemplateExpressionInfos[]; /** * An array of objects that defines how fields in the dataset or values from [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expressions participate in a popup. Each object contains properties for a single field or expression. See the object specification table below for available options to set on each field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ fieldInfos?: PopupTemplateFieldInfos[]; /** * Additional options that can be defined for the popup layer. Currently supports one property, `showNoDataRecords`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#layerOptions) - * + * * @default null */ layerOptions?: PopupTemplateLayerOptions; /** * An array of fields used in the PopupTemplate. Use this property to indicate what fields are required to fully render the PopupTemplate. To fetch the values from all fields, use `["*"]`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#outFields) - * + * * @default null */ outFields?: string[]; /** * Indicates whether actions should replace existing [popup actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) - * + * * @default false */ overwriteActions?: boolean; /** * The template for defining how to format the title used in a popup. You can format the title by specifying either a string value or a function that returns a simple string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#title) */ title?: string | Function; @@ -15057,13 +15057,13 @@ declare namespace __esri { /** * Attachments are a type of popup element. Similar to text and media elements, attachments can only be set within the content. ![popuptemplate-attachments-element](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-attachments-element.png) The object specification for the fields popup element is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#attachments) */ export interface Attachments extends Object { /** * **Required.** The type of popup element to display. To list attachments, set this to `attachments`. The attachmentInfos are queried from the service and will list within the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#attachments) */ type: string; @@ -15071,19 +15071,19 @@ declare namespace __esri { /** * It is possible to set the fieldInfos directly within the PopupTemplate's content. If the fieldInfos is not set within the content, it will revert to whatever may be set within the [PopupTemplate.fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) property. ![popuptemplate-fields-element](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-fields-element.png) The object specification for the fields popup element is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fields) */ export interface Fields extends Object { /** * **Required.** The type of popup element to display. To display tabular field data, set this to `fields`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fields) */ type: string; /** * Object array of [fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos). If the `fieldInfos` property is not provided directly within the content, the popup will display whatever is set directly in the `PopupTemplate.fieldInfos`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fields) */ fieldInfos: any[]; @@ -15091,19 +15091,19 @@ declare namespace __esri { /** * It is possible to set media elements such as charts and/or images within the PopupTemplate's content. This content is set within the mediaInfos. ![popuptemplate-media-element](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-media-element.png) The object specification for the media popup element is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ export interface Media extends Object { /** * **Required.** The type of popup element to display. To display charts or images, set this to `media`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ type: string; /** * **Required.** Object array of mediaInfos representing images or charts for display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ mediaInfos: MediaMediaInfos[]; @@ -15113,25 +15113,25 @@ declare namespace __esri { export interface PopupTemplateExpressionInfos extends Object { /** * The name of the expression. This is used to reference the value of the given `expression` in the popupTemplate's [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content) property by wrapping it in curly braces and prefacing it with `expression/` (e.g. `{expression/expressionName}`). See the code snippets below for more examples. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ name: string; /** * The title used to describe the value returned by the expression in the popup. This will display if the value is referenced in a `fieldInfos` table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ title?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to either a string or a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ expression: string; /** * Indicates the return type of the Arcade expression. This is an optional property. **Possible Values:** string | number - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) */ returnType?: string; @@ -15141,37 +15141,37 @@ declare namespace __esri { export interface PopupTemplateFieldInfos extends Object { /** * **Required.** The field name as defined by the service or the `name` of an [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression. Arcade expression names are defined in the [expressionInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#expressionInfos) property. When referencing Arcade expressions, you must preface the name with `expression/`, such as `expression/percent-total`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ fieldName: string; /** * An object used with numerical or date fields to provide more detail about how the value should be displayed in a popup. When formatting Number fields, you must set both the `digitSeparator` and `places` properties for the formatting to take effect. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ format?: PopupTemplateFieldInfosFormat; /** * The field alias to display in place of the `fieldName` in the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ label?: string; /** * For editable popups, defines the text box format. **Possible Values:** rich-text | text-area | text-box - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ stringFieldOption?: string; /** * Defines a tooltip for editable popup fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ tooltip?: string; /** * Defines whether the field is visible in the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ visible?: boolean; @@ -15181,19 +15181,19 @@ declare namespace __esri { export interface PopupTemplateFieldInfosFormat extends Object { /** * Used only with Date fields. Specifies how the date should appear in a popup. **Possible Values:** short-date | short-date-le | long-date | day-short-month-year | long-month-day-year | short-date-long-time | short-date-le-long-time | short-date-short-time | short-date-le-short-time | short-date-short-time-24 | short-date-le-short-time-24 | short-date-short-time-24 | short-date-le-short-time-24 | long-month-year | short-month-year | year - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ dateFormat?: string; /** * Used only with Number fields. A value of `true` indicates the number should have a digit (or thousands) separator when the value appears in popups. A value of `false` means that no separator will be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ digitSeparator?: boolean; /** * Used only with Number fields to specify the number of supported decimal places that should appear in popups. Any places beyond this value are rounded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) */ places?: number; @@ -15203,7 +15203,7 @@ declare namespace __esri { export interface PopupTemplateLayerOptions extends Object { /** * Applicable to [Imagery Layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html). Indicates whether records without data should display within the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#layerOptions) */ showNoDataRecords: boolean; @@ -15211,19 +15211,19 @@ declare namespace __esri { /** * An object used to define descriptive text as an element within the PopupTemplate's content. The text may reference values returned from a field attribute or an [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression. ![popuptemplate-text-element](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-text-element.png) The object specification for the text popup element is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#text) */ export interface Text extends Object { /** * **Required.** The type of popup element to display. For descriptive text, set this to `text`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#text) */ type: string; /** * **Required.** The formatted string content to display. This may contain a field name enclosed in `{}`, such as `{FIELDNAME}`, or an [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression name, referenced as `{expression/EXPRESSIONNAME}`. Text content may also leverage HTML tags such as ``, `

`, and `
` for formatting the look and feel of the content. To use this element, set the `type` property to `text`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#text) */ text: string; @@ -15233,31 +15233,31 @@ declare namespace __esri { export interface MediaMediaInfos extends Object { /** * Defines the media title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ title: string; /** * Defines a caption for the media. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ caption: string; /** * **Since: 4.5** Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of `0` indicates auto refresh is not enabled. If the property does not exist, it is equivalent to having a value of `0`. Only applicable when `type` is set to `image`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ refreshInterval: number; /** * Defines the media type. **Possible Values:** image | pie-chart | bar-chart | column-chart | line-chart - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ type: string; /** * Defines the value format. This depends on the media type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ value: MediaMediaInfosValue; @@ -15267,31 +15267,31 @@ declare namespace __esri { export interface MediaMediaInfosValue extends Object { /** * Use this for image values. It defines the sourceURL pointing to the image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ sourceURL: string; /** * Used for chart values. An array of strings indicating field names from the specified layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ fields: string[]; /** * Used for chart values. A field used to normalize data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ normalizationField: string; /** * Used for chart values. Defines a new dojo theme, only valid for chart types. View the [Dojox Charting Theme Preview](https://download.dojotoolkit.org/release-1.10.0/dojo-release-1.10.0/dojox/charting/tests/theme_preview.html) to see some of the theme options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ theme: string; /** * Used for chart values. Defines the tooltip display field that displays when hovering over the chart. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#media) */ tooltipField: string; @@ -15300,460 +15300,460 @@ declare namespace __esri { interface Portal extends Accessor, Loadable { /** * The access level of the organization. When public, anonymous users can access the organization. When private, access is restricted to only members of the organization. **Possible Values:** public | private - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#access) */ access: string; /** * When `true`, access to the organization's Portal resources must occur over SSL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#allSSL) */ allSSL: boolean; /** - * The authentication mode for handling authentication when the user attempts to access a secure resource. - * + * The authentication mode for handling authentication when the user attempts to access a secure resource. + * * Possible Value | Description * ---------------|------------ * anonymous | An error will be returned when a secure resource is requested. * auto | The user will be signed in when a secure resource is requested. * immediate | The user will be signed in when the Portal is loaded. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authMode) - * + * * @default auto */ authMode: string; /** * Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authorizedCrossOriginDomains) */ authorizedCrossOriginDomains: string[]; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is not true. The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method does this automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery) */ basemapGalleryGroupQuery: string; /** * The Bing key to use for web maps using Bing Maps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#bingKey) */ bingKey: string; /** * Indicates whether an organization can list applications in the marketplace . - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListApps) */ canListApps: boolean; /** * Indicates whether an organization can list data services in the marketplace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListData) */ canListData: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListPreProvisionedItems) */ canListPreProvisionedItems: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canProvisionDirectPurchase) */ canProvisionDirectPurchase: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. When `false`, no public items outside of the organization are included. However, public items which are part of the organization are included. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSearchPublic) - * + * * @default true */ canSearchPublic: boolean; /** * The Bing key can be shared to the public and is returned as part of a portal's description call (`/sharing/rest/portals/`). This requires the access of the portal to be set to public. The canShareBingPublic property is not returned publicly but only shown to users within the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canShareBingPublic) - * + * * @default false */ canShareBingPublic: boolean; /** * When `true`, members of the organization can share resources outside the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSharePublic) - * + * * @default false */ canSharePublic: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInArcGIS) - * + * * @default false */ canSignInArcGIS: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInIDP) - * + * * @default false */ canSignInIDP: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#colorSetsGroupQuery) */ colorSetsGroupQuery: string; /** * Indicates whether to allow the organization to disable commenting. When commentsEnabled is false, comments are hidden and not removed. numComments are set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization re-enables comments, the comments display and numComments are restored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#commentsEnabled) - * + * * @default false */ commentsEnabled: boolean; /** * Date the organization was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#created) */ created: Date; /** * The default locale (language and country) information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#culture) */ culture: string; /** * The custom base URL for the portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#customBaseUrl) */ customBaseUrl: string; /** * The default basemap to use for the portal. Used in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap) */ defaultBasemap: Basemap; /** * The default extent to use for the portal. Used in the map viewer. The extent will be in the default basemap's spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultExtent) */ defaultExtent: Extent; /** * The default vector basemap to use for the portal. Used in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) */ defaultVectorBasemap: Basemap; /** * A description of the organization/portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#description) */ description: string; /** * Boolean value indicating whether to opt-in to the [Esri User Experience Improvement (EUEI) program](https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#ESRI_QUESTIONANSWER_AED97F28DCD84F7682623C2FA9E5CE49). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#eueiEnabled) - * + * * @default false */ eueiEnabled: boolean; /** * The featured groups for the portal. Returns an array of objects that provide access to the owner and title for each featured group. Each item in this array has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ featuredGroups: PortalFeaturedGroups[]; /** * The query that defines the featured group. If null, then the most viewed items in the organization will be the featured items. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredItemsGroupQuery) */ featuredItemsGroupQuery: string; /** * The query that identifies the group containing features items for the gallery. Set a Group ID or, if null, then the most viewed items in your organization are displayed in the gallery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#galleryTemplatesGroupQuery) */ galleryTemplatesGroupQuery: string; /** * Indicates whether the organization has content categories. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#hasCategorySchema) - * + * * @default false */ hasCategorySchema: boolean; /** * Helper services provided by the portal. For the detailed information about these services, see the [about utility services](https://server.arcgis.com/en/portal/latest/administer/windows/about-utility-services.htm) topic from the ArcGIS Server documentation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#helperServices) */ helperServices: any; /** * The group that contains featured content to be displayed on the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContent) */ homePageFeaturedContent: string; /** * The number of featured items that can be displayed on the home page. The max is 100. Accepts integers only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContentCount) */ homePageFeaturedContentCount: number; /** * The port used by the portal for HTTP communication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpPort) */ httpPort: number; /** * The port used by the portal for HTTPS communication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpsPort) */ httpsPort: number; /** * The id of the organization that owns this portal. If `null` then this is the default portal for anonymous and non-organizational users. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#id) */ id: string; /** * The country code of the calling IP (ArcGIS Online only). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#ipCntryCode) */ ipCntryCode: string; /** * Indicates whether the portal is an organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isOrganization) */ readonly isOrganization: boolean; /** * Indicates if the portal is on-premises. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isPortal) */ isPortal: boolean; /** * The query that identifies the group containing editing templates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#layerTemplatesGroupQuery) */ layerTemplatesGroupQuery: string; /** * Indicates whether the portal's resources have loaded. When `true`, all the properties of the object can be accessed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The maximum validity in minutes of tokens issued for users of the organization. -1 is the default and is a special value that indicates infinite timeout or permanent tokens. For tokens granted using OAuth 2.0 authorization grant, it represents the maximum validity of refresh tokens. For access tokens, the maximum validity is the lower of two weeks or this value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#maxTokenExpirationMinutes) */ maxTokenExpirationMinutes: number; /** * Date the organization was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#modified) */ modified: Date; /** * Name of the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#name) */ name: string; /** * URL of the portal host. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalHostname) */ portalHostname: string; /** * The portal mode. **Possible Values:** multitenant | singletenant - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalMode) */ portalMode: string; /** * Properties specific to the organization, for example the "contact us" link. If the organization is public, the properties are visible to the anonymous user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalProperties) */ portalProperties: any; /** * The region for the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region) */ region: string; /** * The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online and "https://www.example.com/arcgis/sharing/rest" for your in-house portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#restUrl) */ readonly restUrl: string; /** * Custom HTML for the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#rotatorPanels) */ rotatorPanels: any[]; /** * Indicates whether the description of your organization displays on the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#showHomePageDescription) */ showHomePageDescription: boolean; /** * Indicates whether hosted services are supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#supportsHostedServices) - * + * * @default false */ supportsHostedServices: boolean; /** * The query that defines the symbols sets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#symbolSetsGroupQuery) */ symbolSetsGroupQuery: string; /** * The query that defines the collection of templates that will appear in the template gallery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#templatesGroupQuery) */ templatesGroupQuery: string; /** * The URL to the thumbnail of the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * Sets the units of measure for the organization's users. The user default is derived from the organization's [region](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region). **Possible Values:** english | metric - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#units) */ units: string; /** * The URL to the portal instance. Setting the location of the portal instance via [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) should be used in favor of setting it directly on this property. If using an on-premise portal, the syntax should look similar to: `https://www.example.com/arcgis` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#url) - * + * * @default {@link module:esri/config#portalUrl esriConfig.portalUrl} */ url: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#urlKey) */ urlKey: string; /** * Information representing a registered user of the portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#user) */ user: PortalUser; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. The recommended security setting is true. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useStandardizedQuery) */ useStandardizedQuery: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, and (a) [vectorBasemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) should be used instead of [basemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery), while (b) [defaultVectorBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) should be used instead of [defaultBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap). The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method automatically uses vectorBasemapGalleryGroupQuery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) */ useVectorBasemaps: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is true. The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method does this automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) */ vectorBasemapGalleryGroupQuery: string; /** * Fetches the [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) that are displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html). When [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is `true`, the basemaps will be based on [vectorBasemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery), and otherwise on [basemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) - * + * * @param basemapGalleryGroupQuery When provided, this argument is used to fetch basemaps based on input query parameters. - * + * */ fetchBasemaps(basemapGalleryGroupQuery?: string): IPromise; /** * If present, fetches the organization's category schema. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchCategorySchema) - * - * + * + * */ fetchCategorySchema(): IPromise; /** * Fetches the featured groups in the Portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchFeaturedGroups) - * - * + * + * */ fetchFeaturedGroups(): IPromise; /** * Fetches and returns the associated regions with the portal instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchRegions) - * - * + * + * */ fetchRegions(): IPromise; /** * Executes a query against the Portal to return an array of [PortalGroup](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html) objects that match the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryGroups) - * + * * @param queryParams The input query parameters defined in [PortalQueryParams](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html). - * + * */ queryGroups(queryParams: PortalQueryParams | PortalQueryParamsProperties): IPromise; /** * Executes a query against the Portal to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryItems) - * + * * @param queryParams The input query parameters defined in [PortalQueryParams](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html). - * + * */ queryItems(queryParams: PortalQueryParams | PortalQueryParamsProperties): IPromise; /** * Executes a query against the Portal to return an array of [PortalUser](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html) objects that match the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryUsers) - * + * * @param queryParams The input query parameters defined in [PortalQueryParams](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html). - * + * */ queryUsers(queryParams: PortalQueryParams | PortalQueryParamsProperties): IPromise; } @@ -15761,7 +15761,7 @@ declare namespace __esri { interface PortalConstructor { /** * The Portal class is part of the [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/) that provides a way to build applications that work with content from [ArcGIS Online](http://www.arcgis.com/home/) or an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/). [ArcGIS Enterprise](https://enterprise.arcgis.com/en/portal/) is software from Esri that customers can deploy either on-premises or in the cloud. [ArcGIS Online](http://www.arcgis.com/home/) is Esri's Software as a Service offering that represents GIS as a Service and is implemented using the same technology as ArcGIS Enterprise. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) */ @@ -15770,10 +15770,10 @@ declare namespace __esri { /** * Returns a cached default Portal instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#getDefault) - * - * + * + * */ getDefault(): Portal; } @@ -15783,372 +15783,372 @@ declare namespace __esri { interface PortalProperties extends LoadableProperties { /** * The access level of the organization. When public, anonymous users can access the organization. When private, access is restricted to only members of the organization. **Possible Values:** public | private - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#access) */ access?: string; /** * When `true`, access to the organization's Portal resources must occur over SSL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#allSSL) */ allSSL?: boolean; /** - * The authentication mode for handling authentication when the user attempts to access a secure resource. - * + * The authentication mode for handling authentication when the user attempts to access a secure resource. + * * Possible Value | Description * ---------------|------------ * anonymous | An error will be returned when a secure resource is requested. * auto | The user will be signed in when a secure resource is requested. * immediate | The user will be signed in when the Portal is loaded. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authMode) - * + * * @default auto */ authMode?: string; /** * Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#authorizedCrossOriginDomains) */ authorizedCrossOriginDomains?: string[]; /** * The query that defines the basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is not true. The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method does this automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery) */ basemapGalleryGroupQuery?: string; /** * The Bing key to use for web maps using Bing Maps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#bingKey) */ bingKey?: string; /** * Indicates whether an organization can list applications in the marketplace . - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListApps) */ canListApps?: boolean; /** * Indicates whether an organization can list data services in the marketplace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListData) */ canListData?: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canListPreProvisionedItems) */ canListPreProvisionedItems?: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canProvisionDirectPurchase) */ canProvisionDirectPurchase?: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. When `false`, no public items outside of the organization are included. However, public items which are part of the organization are included. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSearchPublic) - * + * * @default true */ canSearchPublic?: boolean; /** * The Bing key can be shared to the public and is returned as part of a portal's description call (`/sharing/rest/portals/`). This requires the access of the portal to be set to public. The canShareBingPublic property is not returned publicly but only shown to users within the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canShareBingPublic) - * + * * @default false */ canShareBingPublic?: boolean; /** * When `true`, members of the organization can share resources outside the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSharePublic) - * + * * @default false */ canSharePublic?: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInArcGIS) - * + * * @default false */ canSignInArcGIS?: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#canSignInIDP) - * + * * @default false */ canSignInIDP?: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#colorSetsGroupQuery) */ colorSetsGroupQuery?: string; /** * Indicates whether to allow the organization to disable commenting. When commentsEnabled is false, comments are hidden and not removed. numComments are set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization re-enables comments, the comments display and numComments are restored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#commentsEnabled) - * + * * @default false */ commentsEnabled?: boolean; /** * Date the organization was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#created) */ created?: DateProperties; /** * The default locale (language and country) information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#culture) */ culture?: string; /** * The custom base URL for the portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#customBaseUrl) */ customBaseUrl?: string; /** * The default basemap to use for the portal. Used in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap) */ defaultBasemap?: BasemapProperties; /** * The default extent to use for the portal. Used in the map viewer. The extent will be in the default basemap's spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultExtent) */ defaultExtent?: ExtentProperties; /** * The default vector basemap to use for the portal. Used in the map viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) */ defaultVectorBasemap?: BasemapProperties; /** * A description of the organization/portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#description) */ description?: string; /** * Boolean value indicating whether to opt-in to the [Esri User Experience Improvement (EUEI) program](https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#ESRI_QUESTIONANSWER_AED97F28DCD84F7682623C2FA9E5CE49). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#eueiEnabled) - * + * * @default false */ eueiEnabled?: boolean; /** * The featured groups for the portal. Returns an array of objects that provide access to the owner and title for each featured group. Each item in this array has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ featuredGroups?: PortalFeaturedGroups[]; /** * The query that defines the featured group. If null, then the most viewed items in the organization will be the featured items. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredItemsGroupQuery) */ featuredItemsGroupQuery?: string; /** * The query that identifies the group containing features items for the gallery. Set a Group ID or, if null, then the most viewed items in your organization are displayed in the gallery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#galleryTemplatesGroupQuery) */ galleryTemplatesGroupQuery?: string; /** * Indicates whether the organization has content categories. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#hasCategorySchema) - * + * * @default false */ hasCategorySchema?: boolean; /** * Helper services provided by the portal. For the detailed information about these services, see the [about utility services](https://server.arcgis.com/en/portal/latest/administer/windows/about-utility-services.htm) topic from the ArcGIS Server documentation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#helperServices) */ helperServices?: any; /** * The group that contains featured content to be displayed on the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContent) */ homePageFeaturedContent?: string; /** * The number of featured items that can be displayed on the home page. The max is 100. Accepts integers only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#homePageFeaturedContentCount) */ homePageFeaturedContentCount?: number; /** * The port used by the portal for HTTP communication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpPort) */ httpPort?: number; /** * The port used by the portal for HTTPS communication. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#httpsPort) */ httpsPort?: number; /** * The id of the organization that owns this portal. If `null` then this is the default portal for anonymous and non-organizational users. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#id) */ id?: string; /** * The country code of the calling IP (ArcGIS Online only). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#ipCntryCode) */ ipCntryCode?: string; /** * Indicates if the portal is on-premises. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#isPortal) */ isPortal?: boolean; /** * The query that identifies the group containing editing templates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#layerTemplatesGroupQuery) */ layerTemplatesGroupQuery?: string; /** * The maximum validity in minutes of tokens issued for users of the organization. -1 is the default and is a special value that indicates infinite timeout or permanent tokens. For tokens granted using OAuth 2.0 authorization grant, it represents the maximum validity of refresh tokens. For access tokens, the maximum validity is the lower of two weeks or this value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#maxTokenExpirationMinutes) */ maxTokenExpirationMinutes?: number; /** * Date the organization was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#modified) */ modified?: DateProperties; /** * Name of the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#name) */ name?: string; /** * URL of the portal host. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalHostname) */ portalHostname?: string; /** * The portal mode. **Possible Values:** multitenant | singletenant - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalMode) */ portalMode?: string; /** * Properties specific to the organization, for example the "contact us" link. If the organization is public, the properties are visible to the anonymous user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#portalProperties) */ portalProperties?: any; /** * The region for the organization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region) */ region?: string; /** * Custom HTML for the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#rotatorPanels) */ rotatorPanels?: any[]; /** * Indicates whether the description of your organization displays on the home page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#showHomePageDescription) */ showHomePageDescription?: boolean; /** * Indicates whether hosted services are supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#supportsHostedServices) - * + * * @default false */ supportsHostedServices?: boolean; /** * The query that defines the symbols sets. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#symbolSetsGroupQuery) */ symbolSetsGroupQuery?: string; /** * The query that defines the collection of templates that will appear in the template gallery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#templatesGroupQuery) */ templatesGroupQuery?: string; /** * Sets the units of measure for the organization's users. The user default is derived from the organization's [region](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#region). **Possible Values:** english | metric - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#units) */ units?: string; /** * The URL to the portal instance. Setting the location of the portal instance via [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) should be used in favor of setting it directly on this property. If using an on-premise portal, the syntax should look similar to: `https://www.example.com/arcgis` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#url) - * + * * @default {@link module:esri/config#portalUrl esriConfig.portalUrl} */ url?: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#urlKey) */ urlKey?: string; /** * Information representing a registered user of the portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#user) */ user?: PortalUserProperties; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. The recommended security setting is true. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useStandardizedQuery) */ useStandardizedQuery?: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, and (a) [vectorBasemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) should be used instead of [basemapGalleryGroupQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#basemapGalleryGroupQuery), while (b) [defaultVectorBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultVectorBasemap) should be used instead of [defaultBasemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#defaultBasemap). The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method automatically uses vectorBasemapGalleryGroupQuery. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) */ useVectorBasemaps?: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the [BasemapGallery](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) when [useVectorBasemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#useVectorBasemaps) is true. The [fetchBasemaps()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#fetchBasemaps) method does this automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#vectorBasemapGalleryGroupQuery) */ vectorBasemapGalleryGroupQuery?: string; @@ -16158,13 +16158,13 @@ declare namespace __esri { export interface PortalFeaturedGroups extends Object { /** * Name of the group owner. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ owner: string; /** * Group title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#featuredGroups) */ title: string; @@ -16173,31 +16173,31 @@ declare namespace __esri { interface PortalFolder extends Accessor { /** * The date the folder was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#created) */ created: Date; /** * The unique id of the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#id) */ id: string; /** * The portal associated with the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#portal) */ portal: Portal; /** * The title of the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#title) */ title: string; /** * The URL to the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#url) */ readonly url: string; @@ -16214,25 +16214,25 @@ declare namespace __esri { interface PortalFolderProperties { /** * The date the folder was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#created) */ created?: DateProperties; /** * The unique id of the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#id) */ id?: string; /** * The portal associated with the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#portal) */ portal?: PortalProperties; /** * The title of the folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalFolder.html#title) */ title?: string; @@ -16241,117 +16241,117 @@ declare namespace __esri { interface PortalGroup extends Accessor { /** * The access privileges on the group which determines who can see and access the group. **Possible Values:** private | org | public - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#access) */ access: string; /** * The date the group was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#created) */ created: Date; /** * A detailed description of the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#description) */ description: string; /** * The unique id for the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#id) */ id: string; /** * If set to `true`, then users will not be able to apply to join the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#isInvitationOnly) - * + * * @default false */ isInvitationOnly: boolean; /** * The date the group was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#modified) */ modified: Date; /** * The username of the group's owner. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#owner) */ owner: string; /** * The portal associated with the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#portal) */ portal: Portal; /** * A short summary that describes the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#snippet) */ snippet: string; /** * User defined tags that describe the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#tags) */ tags: string[]; /** * The URL to the thumbnail used for the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The title of the group. This is the name that is displayed to users. It is also used to refer to the group. Every group must have a title and it must be unique. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#title) */ title: string; /** * The URL to the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#url) */ readonly url: string; /** * If present, fetches the group's category schema. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchCategorySchema) - * - * + * + * */ fetchCategorySchema(): IPromise; /** * Fetches the current members of the group. This method is only available to members or administrators of the group. View the ArcGIS REST API documentation for the [Group Users](https://developers.arcgis.com/rest/users-groups-and-items/group-users.htm) for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#fetchMembers) - * - * + * + * */ fetchMembers(): IPromise; /** * Get the URL to the thumbnail image for the group. Available width sizes: 150, 300 and 600. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#getThumbnailUrl) - * + * * @param width The desired image width. - * + * */ getThumbnailUrl(width?: number): string; /** * Executes a query against the group to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems) - * + * * @param queryParams The input query parameters defined in [PortalQueryParams](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html). - * + * */ queryItems(queryParams?: PortalQueryParams | PortalQueryParamsProperties): IPromise; } @@ -16367,69 +16367,69 @@ declare namespace __esri { interface PortalGroupProperties { /** * The access privileges on the group which determines who can see and access the group. **Possible Values:** private | org | public - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#access) */ access?: string; /** * The date the group was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#created) */ created?: DateProperties; /** * A detailed description of the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#description) */ description?: string; /** * The unique id for the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#id) */ id?: string; /** * If set to `true`, then users will not be able to apply to join the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#isInvitationOnly) - * + * * @default false */ isInvitationOnly?: boolean; /** * The date the group was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#modified) */ modified?: DateProperties; /** * The username of the group's owner. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#owner) */ owner?: string; /** * The portal associated with the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#portal) */ portal?: PortalProperties; /** * A short summary that describes the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#snippet) */ snippet?: string; /** * User defined tags that describe the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#tags) */ tags?: string[]; /** * The title of the group. This is the name that is displayed to users. It is also used to refer to the group. Every group must have a title and it must be unique. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#title) */ title?: string; @@ -16438,280 +16438,280 @@ declare namespace __esri { interface PortalItem extends Accessor, Loadable, JSONSupport { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#access) */ access: string; /** * Information on the source of the item and its copyright status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#accessInformation) */ accessInformation: string; /** * Contains an array of objects containing proxy information for premium platform services. This is most widely seen in registered applications that work with premium and subscriber services, e.g. routing and analysis services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ readonly applicationProxies: PortalItemApplicationProxies[]; /** * Average rating. Uses a weighted average called "Bayesian average." - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#avgRating) */ avgRating: number; /** * An array of organization categories that are set on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#categories) */ categories: string[]; /** * The date the item was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#created) */ created: Date; /** * The item's locale information (language and country). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#culture) */ culture: string; /** * The detailed description of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#description) */ description: string; /** * The geographic extent, or bounding rectangle, of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#extent) */ extent: Extent; /** * An array of group categories set on the item. This varies slightly from `categories` as it only returns categories in the group content returned from [PortalGroup.queryItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#groupCategories) */ groupCategories: string[]; /** * The unique id for the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#id) */ id: string; /** * Indicates whether a layer can be created from this item using [Layer.fromPortalItem()](esri-layers-Layer.html#fromPortalItem). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#isLayer) */ readonly isLayer: boolean; /** - * Indicates whether an item can be updated and deleted. - * + * Indicates whether an item can be updated and deleted. + * * Possible Value | Description * ---------------|------------ * admin | The item can be updated or deleted. * update | The item can be updated, but not deleted. * null | The item cannot be updated nor deleted. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#itemControl) */ readonly itemControl: string; /** * The URL to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#itemUrl) */ readonly itemUrl: string; /** * Information on license or restrictions related to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#licenseInfo) */ licenseInfo: string; /** * Indicates whether the item's resources have loaded from the portal. When `true`, all the properties of the object can be accessed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The date the item was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#modified) */ modified: Date; /** * The name of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#name) */ name: string; /** * Number of comments on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numComments) */ numComments: number; /** * Number of ratings on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numRatings) */ numRatings: number; /** * Number of views on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numViews) */ numViews: number; /** * The username of the user who owns this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#owner) */ owner: string; /** * The portal that contains the item. Defaults to the value in [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) (e.g. https://www.arcgis.com). Suggested to use [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) instead of this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#portal) */ portal: Portal; /** * An array of string URLs. These URLs should point to screenshots (i.e. screen captures) associated with an application. An example value could be something similar to `"screenshots/Basic.png"`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#screenshots) - * + * * @default null */ screenshots: string[]; /** * The size of the item (in bytes). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#size) */ size: number; /** * A summary description of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#snippet) */ snippet: string; /** * User defined tags that describe the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#tags) */ tags: string[]; /** * The URL to the thumbnail used for the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The title for the item. This is the name that is displayed to users and used to refer to the item. Every item must have a title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#title) */ title: string; /** * The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See the [ArcGIS REST API Items and Items Types Reference](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm) to get an understanding of the item type hierarchy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#type) */ type: string; /** * Type keywords that describe the type of content of this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#typeKeywords) */ typeKeywords: string[]; /** * The service URL of this item. Only certain layer item types such as "Feature Service", "Map Service", "Image Service", "Scene Service", "WMS" and "KML" have service URLs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#url) */ url: string; /** * Adds a rating to an accessible item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#addRating) - * + * * @param rating Rating to set for the item. Rating must be a number between 1.0 and 5.0. - * + * */ addRating(rating: number | PortalRating): IPromise; /** * Deletes a rating for the specified item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#deleteRating) - * - * + * + * */ deleteRating(): IPromise; /** * Requests a PortalItem in the format specified in `responseType`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchData) - * + * * @param responseType The format of the response. **Possible Values:** json | xml | text | blob | array-buffer | document - * + * */ fetchData(responseType?: string): IPromise; /** * Returns the rating (if any) given to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRating) - * - * + * + * */ fetchRating(): IPromise; /** * Gets all the related items of a certain relationship type for the portal item. An optional direction can be specified if the direction of the relationship is ambiguous. Otherwise, the service will try to infer it. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) - * + * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * @param params.relationshipType The type of relationship between the two items. See [Relationship types](https://developers.arcgis.com/rest/users-groups-and-items/relationship-types.htm) for a complete listing of types. * @param params.direction The direction of the relationship. Can either be `forward` (from origin to destination) or `reverse` (from destination to origin). **Possible Values:** forward | reverse - * + * */ fetchRelatedItems(params: PortalItemFetchRelatedItemsParams): IPromise; /** * Get the URL to the thumbnail image for the item. Available width sizes: 200, 400, 800 and 2400. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#getThumbnailUrl) - * + * * @param width The desired image width. - * + * */ getThumbnailUrl(width?: number): string; /** * Updates the item's properties to the portal, and optionally its data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#update) - * + * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * @param params.data **Optional**. The component used to stream the data represented by the item to the client. - * + * */ update(params?: PortalItemUpdateParams): IPromise; /** * Updates the item's thumbnail on the portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#updateThumbnail) - * + * * @param params See the object specification table below for the parameters that may be passed as properties in this object. * @param params.thumbnail A URL, Data URI, Blob, or File. The accepted formats are `GIF`, `JPG`, and `PNG`. - * + * */ updateThumbnail(params: PortalItemUpdateThumbnailParams): IPromise; } @@ -16729,159 +16729,159 @@ declare namespace __esri { interface PortalItemProperties extends LoadableProperties { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#access) */ access?: string; /** * Information on the source of the item and its copyright status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#accessInformation) */ accessInformation?: string; /** * Average rating. Uses a weighted average called "Bayesian average." - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#avgRating) */ avgRating?: number; /** * An array of organization categories that are set on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#categories) */ categories?: string[]; /** * The date the item was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#created) */ created?: DateProperties; /** * The item's locale information (language and country). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#culture) */ culture?: string; /** * The detailed description of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#description) */ description?: string; /** * The geographic extent, or bounding rectangle, of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#extent) */ extent?: ExtentProperties; /** * An array of group categories set on the item. This varies slightly from `categories` as it only returns categories in the group content returned from [PortalGroup.queryItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#groupCategories) */ groupCategories?: string[]; /** * The unique id for the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#id) */ id?: string; /** * Information on license or restrictions related to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#licenseInfo) */ licenseInfo?: string; /** * The date the item was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#modified) */ modified?: DateProperties; /** * The name of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#name) */ name?: string; /** * Number of comments on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numComments) */ numComments?: number; /** * Number of ratings on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numRatings) */ numRatings?: number; /** * Number of views on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#numViews) */ numViews?: number; /** * The username of the user who owns this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#owner) */ owner?: string; /** * The portal that contains the item. Defaults to the value in [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) (e.g. https://www.arcgis.com). Suggested to use [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) instead of this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#portal) */ portal?: PortalProperties; /** * An array of string URLs. These URLs should point to screenshots (i.e. screen captures) associated with an application. An example value could be something similar to `"screenshots/Basic.png"`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#screenshots) - * + * * @default null */ screenshots?: string[]; /** * The size of the item (in bytes). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#size) */ size?: number; /** * A summary description of the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#snippet) */ snippet?: string; /** * User defined tags that describe the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#tags) */ tags?: string[]; /** * The title for the item. This is the name that is displayed to users and used to refer to the item. Every item must have a title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#title) */ title?: string; /** * The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See the [ArcGIS REST API Items and Items Types Reference](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm) to get an understanding of the item type hierarchy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#type) */ type?: string; /** * Type keywords that describe the type of content of this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#typeKeywords) */ typeKeywords?: string[]; /** * The service URL of this item. Only certain layer item types such as "Feature Service", "Map Service", "Image Service", "Scene Service", "WMS" and "KML" have service URLs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#url) */ url?: string; @@ -16891,19 +16891,19 @@ declare namespace __esri { export interface PortalItemApplicationProxies extends Object { /** * The URL of the premium map service layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ sourceUrl: string; /** * The proxy URL for the source URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ proxyUrl: string; /** * The proxy ID registered in ArcGIS Online or ArcGIS Enterprise Portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#applicationProxies) */ proxyId: string; @@ -16913,13 +16913,13 @@ declare namespace __esri { export interface PortalItemFetchRelatedItemsParams extends Object { /** * The type of relationship between the two items. See [Relationship types](https://developers.arcgis.com/rest/users-groups-and-items/relationship-types.htm) for a complete listing of types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ relationshipType: string; /** * The direction of the relationship. Can either be `forward` (from origin to destination) or `reverse` (from destination to origin). **Possible Values:** forward | reverse - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchRelatedItems) */ direction?: string; @@ -16929,7 +16929,7 @@ declare namespace __esri { export interface PortalItemUpdateParams extends Object { /** * **Optional**. The component used to stream the data represented by the item to the client. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#update) */ data: string | any; @@ -16939,7 +16939,7 @@ declare namespace __esri { export interface PortalItemUpdateThumbnailParams extends Object { /** * A URL, Data URI, Blob, or File. The accepted formats are `GIF`, `JPG`, and `PNG`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#updateThumbnail) */ thumbnail: Blob | string; @@ -16950,37 +16950,37 @@ declare namespace __esri { * An array of categories stored within the item. Use this property to filter the results from [Portal.queryItems()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryItems) and [PortalGroup.queryItems()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems). It accepts an array of: * * individual string elements or * * an array of strings. - * - * - * The query looks at each element within the array and performs a SQL `AND` operation on them. If the element is an array instead of a single string element, the elements within this array are read as `OR`. See the snippet below: + * + * + * The query looks at each element within the array and performs a SQL `AND` operation on them. If the element is an array instead of a single string element, the elements within this array are read as `OR`. See the snippet below: * > Note: String[] elements are only supported by [ArcGIS Online](http://doc.arcgis.com/en/arcgis-online/reference/what-is-agol.htm) and version 10.6.1 of [Portal for ArcGIS Enterprise](https://enterprise.arcgis.com/en/portal/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#categories) */ categories: (string | string[])[]; /** * Only relevant when querying for [PortalItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). When specified, restricts the results of the query to the extent defined here. The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#spatialReference) of the given extent must be WGS84 (wkid 4326) or Web Mercator (wkid 3857). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#extent) */ extent: Extent; /** * The maximum number of results to be included in the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) set response. The maximum value allowed is `100`. The [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) property combined with the `num` property can be used to paginate the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) - * + * * @default 10 */ num: number; /** * The query string used for the search. View the [ArcGIS REST API Search Reference](https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm) for details on constructing a valid query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) */ query: string; /** - * A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries. - * + * A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries. + * * Field name | Query functionality * ---------------|------------ * title | search, group @@ -16994,40 +16994,40 @@ declare namespace __esri { * num-ratings | search * num-comments | search * num-views | search - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortField) */ sortField: string; /** - * The order in which to sort the results. - * + * The order in which to sort the results. + * * Possible Value | Description * ---------------|------------ * asc | Sort the results in ascending order. * desc | Sort the results in descending order. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortOrder) - * + * * @default asc */ sortOrder: string; /** * The index of the first entry in the result set response. The index is 1-based. The [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) property, along with the [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) property can be used to paginate the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) - * + * * @default 1 */ start: number; /** * Creates a deep clone of the instance of PortalQueryParams that calls this method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#clone) - * - * + * + * */ clone(): PortalQueryParams; } @@ -17045,37 +17045,37 @@ declare namespace __esri { * An array of categories stored within the item. Use this property to filter the results from [Portal.queryItems()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#queryItems) and [PortalGroup.queryItems()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html#queryItems). It accepts an array of: * * individual string elements or * * an array of strings. - * - * - * The query looks at each element within the array and performs a SQL `AND` operation on them. If the element is an array instead of a single string element, the elements within this array are read as `OR`. See the snippet below: + * + * + * The query looks at each element within the array and performs a SQL `AND` operation on them. If the element is an array instead of a single string element, the elements within this array are read as `OR`. See the snippet below: * > Note: String[] elements are only supported by [ArcGIS Online](http://doc.arcgis.com/en/arcgis-online/reference/what-is-agol.htm) and version 10.6.1 of [Portal for ArcGIS Enterprise](https://enterprise.arcgis.com/en/portal/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#categories) */ categories?: (string | string[])[]; /** * Only relevant when querying for [PortalItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html). When specified, restricts the results of the query to the extent defined here. The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#spatialReference) of the given extent must be WGS84 (wkid 4326) or Web Mercator (wkid 3857). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#extent) */ extent?: ExtentProperties; /** * The maximum number of results to be included in the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) set response. The maximum value allowed is `100`. The [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) property combined with the `num` property can be used to paginate the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) - * + * * @default 10 */ num?: number; /** * The query string used for the search. View the [ArcGIS REST API Search Reference](https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm) for details on constructing a valid query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#query) */ query?: string; /** - * A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries. - * + * A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries. + * * Field name | Query functionality * ---------------|------------ * title | search, group @@ -17089,30 +17089,30 @@ declare namespace __esri { * num-ratings | search * num-comments | search * num-views | search - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortField) */ sortField?: string; /** - * The order in which to sort the results. - * + * The order in which to sort the results. + * * Possible Value | Description * ---------------|------------ * asc | Sort the results in ascending order. * desc | Sort the results in descending order. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#sortOrder) - * + * * @default asc */ sortOrder?: string; /** * The index of the first entry in the result set response. The index is 1-based. The [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) property, along with the [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#num) property can be used to paginate the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html#start) - * + * * @default 1 */ start?: number; @@ -17121,25 +17121,25 @@ declare namespace __esri { interface PortalQueryResult extends Accessor { /** * The query parameters for the next set of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#nextQueryParams) */ nextQueryParams: PortalQueryParams; /** * The query parameters for the first set of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#queryParams) */ queryParams: PortalQueryParams; /** * An array of result item objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) */ results: any[]; /** * The total number of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#total) */ total: number; @@ -17156,25 +17156,25 @@ declare namespace __esri { interface PortalQueryResultProperties { /** * The query parameters for the next set of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#nextQueryParams) */ nextQueryParams?: PortalQueryParamsProperties; /** * The query parameters for the first set of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#queryParams) */ queryParams?: PortalQueryParamsProperties; /** * An array of result item objects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#results) */ results?: any[]; /** * The total number of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryResult.html#total) */ total?: number; @@ -17183,13 +17183,13 @@ declare namespace __esri { interface PortalRating extends Accessor { /** * Date the rating was added to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#created) */ created: Date; /** * A rating between 1.0 and 5.0 for the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#rating) */ rating: number; @@ -17206,13 +17206,13 @@ declare namespace __esri { interface PortalRatingProperties { /** * Date the rating was added to the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#created) */ created?: DateProperties; /** * A rating between 1.0 and 5.0 for the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalRating.html#rating) */ rating?: number; @@ -17221,181 +17221,181 @@ declare namespace __esri { interface PortalUser extends Accessor { /** * Indicates the level of access of the user. If private, the user descriptive information will not be available to others nor will the username be searchable. **Possible Values:** private | org | public - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#access) */ access: string; /** * The date the user was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#created) */ created: Date; /** * The culture information for the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#culture) */ culture: string; /** * A description of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#description) */ description: string; /** * The user's e-mail address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#email) */ email: string; /** * The user's full name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fullName) */ fullName: string; /** * The date the user was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#modified) */ modified: Date; /** * The ID of the organization the user belongs to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#orgId) */ orgId: string; /** * The portal associated with the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#portal) */ portal: Portal; /** * The user's preferred view for content, either web or GIS. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#preferredView) */ preferredView: string; /** * The user preferred region, used to set the featured maps on the home page, content in the gallery, and the default extent of new maps in the Viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#region) */ region: string; /** * Defines the user's role in the organization. See [roleId](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) for more details about when user has a custom role. **Possible Values:** org_admin | org_publisher | org_user - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) */ role: string; /** * The ID of the user's role. Only set if the user is assigned a custom role. When present, the [role](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) will indicate the "base" role of the custom role based on the privileges the custom role contains. For example, if the custom role contains some publisher privileges, the [role](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) will be set to `org_publisher`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) */ roleId: string; /** * The URL to the thumbnail image for the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#thumbnailUrl) */ readonly thumbnailUrl: string; /** * The user's personal units of measure setting. **Possible Values:** english | metric - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#units) */ units: string; /** * The URL for the user's content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#userContentUrl) */ readonly userContentUrl: string; /** * The username of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#username) */ username: string; /** * Adds an item to the user's portal content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) - * + * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * @param params.item The item to add to the user's content. * @param params.data The component used to stream the data represented by the item to the client. * @param params.folder The portal folder in which to store the item. - * + * */ addItem(params: PortalUserAddItemParams): IPromise; /** * Deletes an item from the user's portal content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#deleteItem) - * + * * @param item The portal item to remove. - * + * */ deleteItem(item: PortalItem): IPromise; /** * Deletes items from the user's portal content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#deleteItems) - * + * * @param items The portal items to remove. - * + * */ deleteItems(items: PortalItem[]): IPromise; /** * Fetches all of the user's folders used to organize portal content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchFolders) - * - * + * + * */ fetchFolders(): IPromise; /** * Fetches all the groups that the portal user has permission to access. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchGroups) - * - * + * + * */ fetchGroups(): IPromise; /** * Retrieves all the items in the specified folder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) - * + * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * @param params.folder The folder to retrieve items from. * @param params.num The maximum number of results to be included in the result set response. The maximum value allowed is 100. The start property combined with the num property can be used to paginate the search results. * @param params.start The index of the first entry in the result set response. The index is 1-based. - * + * */ fetchItems(params?: PortalUserFetchItemsParams): IPromise; /** * Get the URL to the thumbnail image for the user. Available width sizes: 150, 300 and 600. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#getThumbnailUrl) - * + * * @param width The desired image width. - * + * */ getThumbnailUrl(width?: number): string; /** * Executes a query against the user's favorite group to return an array of [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) objects that match the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#queryFavorites) - * + * * @param queryParams The input query parameters defined in [PortalQueryParams](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalQueryParams.html). This object may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/). - * + * */ queryFavorites(queryParams?: PortalQueryParams): IPromise; } @@ -17411,91 +17411,91 @@ declare namespace __esri { interface PortalUserProperties { /** * Indicates the level of access of the user. If private, the user descriptive information will not be available to others nor will the username be searchable. **Possible Values:** private | org | public - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#access) */ access?: string; /** * The date the user was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#created) */ created?: DateProperties; /** * The culture information for the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#culture) */ culture?: string; /** * A description of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#description) */ description?: string; /** * The user's e-mail address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#email) */ email?: string; /** * The user's full name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fullName) */ fullName?: string; /** * The date the user was last modified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#modified) */ modified?: DateProperties; /** * The ID of the organization the user belongs to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#orgId) */ orgId?: string; /** * The portal associated with the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#portal) */ portal?: PortalProperties; /** * The user's preferred view for content, either web or GIS. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#preferredView) */ preferredView?: string; /** * The user preferred region, used to set the featured maps on the home page, content in the gallery, and the default extent of new maps in the Viewer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#region) */ region?: string; /** * Defines the user's role in the organization. See [roleId](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) for more details about when user has a custom role. **Possible Values:** org_admin | org_publisher | org_user - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) */ role?: string; /** * The ID of the user's role. Only set if the user is assigned a custom role. When present, the [role](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) will indicate the "base" role of the custom role based on the privileges the custom role contains. For example, if the custom role contains some publisher privileges, the [role](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#role) will be set to `org_publisher`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#roleId) */ roleId?: string; /** * The user's personal units of measure setting. **Possible Values:** english | metric - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#units) */ units?: string; /** * The username of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#username) */ username?: string; @@ -17505,19 +17505,19 @@ declare namespace __esri { export interface PortalUserAddItemParams extends Object { /** * The item to add to the user's content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ item: PortalItem; /** * The component used to stream the data represented by the item to the client. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ data?: string | any; /** * The portal folder in which to store the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) */ folder?: PortalFolder; @@ -17527,23 +17527,23 @@ declare namespace __esri { export interface PortalUserFetchItemsParams extends Object { /** * The folder to retrieve items from. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) */ folder?: PortalFolder; /** * The maximum number of results to be included in the result set response. The maximum value allowed is 100. The start property combined with the num property can be used to paginate the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) - * + * * @default 10 */ num?: number; /** * The index of the first entry in the result set response. The index is 1-based. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchItems) - * + * * @default 1 */ start?: number; @@ -17551,7 +17551,7 @@ declare namespace __esri { /** * A convenience module for importing [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/guide/typescript-setup/index.html). For example, rather than importing renderers one at a time like this: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers.html) */ interface renderers { @@ -17562,116 +17562,116 @@ declare namespace __esri { interface ClassBreaksRenderer extends Renderer, VisualVariablesMixin { /** * When symbolizing polygon features with graduated symbols, set a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) on this property to visualize the boundaries of each feature. Use a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) of varying sizes in the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) to indicate the quantity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol: FillSymbol | PolygonSymbol3D; /** * Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ classBreakInfos: ClassBreaksRendererClassBreakInfos[]; /** - * The default symbol assigned to features with a value not matched to a given break. If `null`, unmatched features will not be assigned a symbol. + * The default symbol assigned to features with a value not matched to a given break. If `null`, unmatched features will not be assigned a symbol. * > **Known Limitations** SceneLayers with a `mesh` [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) will display unmatching features with a generic symbol even if the `defaultSymbol` is `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol) */ defaultSymbol: Symbol; /** * The name of a numeric attribute field whose data determines the symbol of each feature based on the class breaks defined in [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) */ field: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ legendOptions: ClassBreaksRendererLegendOptions; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `field`, this property contains the attribute field name used for normalization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) */ normalizationField: string; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `percent-of-total`, this property contains the total of all data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) */ normalizationTotal: number; /** - * Indicates how the data is normalized. If this property is defined, then the class breaks contain a normalized min/max value instead of the value in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field). The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. If this property is defined, then the class breaks contain a normalized min/max value instead of the value in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field). The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the data value using the attribute value of the field specified in the [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) property. This value is set by default if the [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use [normalizationTotal](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) to define the total value by which to normalize. This value is set by default if the [normalizationTotal](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) is provided. - * + * * With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) */ normalizationType: string; /** * The type of renderer. For ClassBreaksRenderer this value is always `class-breaks`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#type) */ readonly type: "class-breaks"; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. This property is typically used as an alternative to [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) for data-driven visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) property. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * Adds a class break to the renderer. You can provide the minimum, maximum and symbol values as individual arguments or by using the info object. The range of the break is greater than or equal to the minimum value and less than the maximum value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#addClassBreakInfo) - * + * * @param min The minimum value to use in the break. This can be a number or an info object as defined in [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos). * @param max The maximum value to use in the break. * @param symbol Symbol to use for the break. - * + * */ addClassBreakInfo(min: number | any, max: number, symbol: Symbol): void; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#clone) - * - * + * + * */ clone(): ClassBreaksRenderer; /** * Returns the [classBreakInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) information (as defined by the renderer) associated with the given graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#getClassBreakInfo) - * + * * @param graphic The graphic whose rendering information will be returned. - * + * */ getClassBreakInfo(graphic: Graphic): any; /** * Removes a break from the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#removeClassBreakInfo) - * + * * @param min Minimum value in the break to remove * @param max Maximum value in the break to remove. - * + * */ removeClassBreakInfo(min: number, max: number): void; } @@ -17679,7 +17679,7 @@ declare namespace __esri { interface ClassBreaksRendererConstructor { /** * ClassBreaksRenderer defines the symbol of each feature in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on the value of a numeric attribute. Symbols are assigned based on classes or ranges of data. Each feature is assigned a symbol based on the class break in which the value of the attribute falls. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) */ @@ -17693,70 +17693,70 @@ declare namespace __esri { interface ClassBreaksRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * When symbolizing polygon features with graduated symbols, set a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) on this property to visualize the boundaries of each feature. Use a [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) of varying sizes in the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) to indicate the quantity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol?: FillSymbolProperties | PolygonSymbol3DProperties; /** * Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ classBreakInfos?: ClassBreaksRendererClassBreakInfos[]; /** - * The default symbol assigned to features with a value not matched to a given break. If `null`, unmatched features will not be assigned a symbol. + * The default symbol assigned to features with a value not matched to a given break. If `null`, unmatched features will not be assigned a symbol. * > **Known Limitations** SceneLayers with a `mesh` [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) will display unmatching features with a generic symbol even if the `defaultSymbol` is `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#defaultSymbol) */ defaultSymbol?: SymbolProperties; /** * The name of a numeric attribute field whose data determines the symbol of each feature based on the class breaks defined in [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) */ field?: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ legendOptions?: ClassBreaksRendererLegendOptions; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `field`, this property contains the attribute field name used for normalization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) */ normalizationField?: string; /** * When [normalizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) is `percent-of-total`, this property contains the total of all data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) */ normalizationTotal?: number; /** - * Indicates how the data is normalized. If this property is defined, then the class breaks contain a normalized min/max value instead of the value in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field). The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. If this property is defined, then the class breaks contain a normalized min/max value instead of the value in the given [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field). The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the data value using the attribute value of the field specified in the [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) property. This value is set by default if the [normalizationField](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationField) is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use [normalizationTotal](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) to define the total value by which to normalize. This value is set by default if the [normalizationTotal](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationTotal) is provided. - * + * * With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#normalizationType) */ normalizationType?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. This property is typically used as an alternative to [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#field) for data-driven visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpression) property. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpressionTitle) */ valueExpressionTitle?: string; @@ -17766,25 +17766,25 @@ declare namespace __esri { export interface ClassBreaksRendererClassBreakInfos extends Object { /** * The minimum value of the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ minValue: number; /** * The maximum value of the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ maxValue: number; /** * The symbol used to style features whose values are between the `minValue` and `maxValue` of the break. This value may be autocast by specifying the symbol `type`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ symbol: Symbol; /** * The label used to describe features in the break in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) */ label?: string; @@ -17794,7 +17794,7 @@ declare namespace __esri { export interface ClassBreaksRendererLegendOptions extends Object { /** * Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and takes precedence over a [field alias](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) or [valueExpressionTitle](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#valueExpressionTitle). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) */ title: string; @@ -17803,14 +17803,14 @@ declare namespace __esri { interface HeatmapRenderer extends Renderer { /** * The area of influence for each point in the layer. This is defined as a radius in pixels. The default is `10`, which means the pixels within a 10-pixel radius of the point's location are assigned an intensity value corresponding to their distance from the nearby point. Increasing this value creates a larger heatmap with more hotspots. Decreasing it makes a smaller heatmap with fewer hotspots. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#blurRadius) - * + * * @default 10 */ blurRadius: number; /** - * An array of objects describing the renderer's color ramp. The ratio of a pixel's intensity value to the [maxPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) of the renderer is mapped to a corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#color) along a continuous ramp. The color of the first stop (i.e. the stop with the lowest `ratio` value) must have an alpha value of `0` for the underlying basemap to be visible in the app. The default value is the following: + * An array of objects describing the renderer's color ramp. The ratio of a pixel's intensity value to the [maxPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) of the renderer is mapped to a corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#color) along a continuous ramp. The color of the first stop (i.e. the stop with the lowest `ratio` value) must have an alpha value of `0` for the underlying basemap to be visible in the app. The default value is the following: * ```js * [ * { ratio: 0, color: "rgba(255, 140, 0, 0)" }, @@ -17818,45 +17818,45 @@ declare namespace __esri { * { ratio: 0.9, color: "rgba(255, 0, 0, 1)" } * ] * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) */ colorStops: HeatmapColorStop[]; /** * The name of the attribute field used to weight the intensity of each heatmap point. For example, suppose you have a layer of points representing buildings containing a field `num_units` for the number of units in the building (if it's an apartment complex). You could weight the heatmap renderer based on the `num_units` field to create a heatmap representing the density of housing units in a city. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) */ field: string; /** * The pixel intensity value that determines which pixels are assigned the final color in the [colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops). Pixelx with intensity values above this number will be assigned the final (or hottest) color in the color ramp. Typically, `minPixelIntensity` will be zero and `maxPixelIntensity` will be set to a high value appropriate for the dataset. The default may not be ideal for your dataset, so this value will likely need to change. Determining the best values for `minPixelIntensity` and `maxPixelIntensity` is an exercise left up to the developer since different types, scales, densities, and distributions of data will require different values for these properties to create a visually pleasing separation of high and low intensity areas appropriate for the data and the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) - * + * * @default 100 */ maxPixelIntensity: number; /** * The pixel intensity value used to determine which pixels will be assigned the initial color in the [colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops). Pixels with intensity values below this number will be excluded from the visualization. When using a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) to weight the points, setting `minPixelIntensity` above zero might help to visually deemphasize frequently occurring but low value point clusters. This property does not actually filter the data or modify the calculated intensity value. Rather, it scales the color ramp such that a higher intensity value is required for a pixel to get a noticeable color. Determining the best values for `minPixelIntensity` and `maxPixelIntensity` is an exercise left up to the developer since different types, scales, densities, and distributions of data will require different values for these properties to create a visually pleasing separation of high and low intensity areas appropriate for the data and the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minPixelIntensity) - * + * * @default 0 */ minPixelIntensity: number; /** * The type of renderer. For HeatmapRenderer this value is always `heatmap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#type) */ readonly type: "heatmap"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#clone) - * - * + * + * */ clone(): HeatmapRenderer; } @@ -17864,7 +17864,7 @@ declare namespace __esri { interface HeatmapRendererConstructor { /** * The HeatmapRenderer renders point [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) as a raster surface, emphasizing areas with a high density of points. This renderer uses a [Gaussian Blur](https://en.wikipedia.org/wiki/Gaussian_blur) to determine the strength of the influence of each point over an area determined by the [blurRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#blurRadius). A Gaussian, or normal, distribution is used to spread the color of the point so it appears to be a fuzzy circle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) */ @@ -17878,14 +17878,14 @@ declare namespace __esri { interface HeatmapRendererProperties extends RendererProperties { /** * The area of influence for each point in the layer. This is defined as a radius in pixels. The default is `10`, which means the pixels within a 10-pixel radius of the point's location are assigned an intensity value corresponding to their distance from the nearby point. Increasing this value creates a larger heatmap with more hotspots. Decreasing it makes a smaller heatmap with fewer hotspots. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#blurRadius) - * + * * @default 10 */ blurRadius?: number; /** - * An array of objects describing the renderer's color ramp. The ratio of a pixel's intensity value to the [maxPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) of the renderer is mapped to a corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#color) along a continuous ramp. The color of the first stop (i.e. the stop with the lowest `ratio` value) must have an alpha value of `0` for the underlying basemap to be visible in the app. The default value is the following: + * An array of objects describing the renderer's color ramp. The ratio of a pixel's intensity value to the [maxPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) of the renderer is mapped to a corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#color) along a continuous ramp. The color of the first stop (i.e. the stop with the lowest `ratio` value) must have an alpha value of `0` for the underlying basemap to be visible in the app. The default value is the following: * ```js * [ * { ratio: 0, color: "rgba(255, 140, 0, 0)" }, @@ -17893,29 +17893,29 @@ declare namespace __esri { * { ratio: 0.9, color: "rgba(255, 0, 0, 1)" } * ] * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops) */ colorStops?: HeatmapColorStopProperties[]; /** * The name of the attribute field used to weight the intensity of each heatmap point. For example, suppose you have a layer of points representing buildings containing a field `num_units` for the number of units in the building (if it's an apartment complex). You could weight the heatmap renderer based on the `num_units` field to create a heatmap representing the density of housing units in a city. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) */ field?: string; /** * The pixel intensity value that determines which pixels are assigned the final color in the [colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops). Pixelx with intensity values above this number will be assigned the final (or hottest) color in the color ramp. Typically, `minPixelIntensity` will be zero and `maxPixelIntensity` will be set to a high value appropriate for the dataset. The default may not be ideal for your dataset, so this value will likely need to change. Determining the best values for `minPixelIntensity` and `maxPixelIntensity` is an exercise left up to the developer since different types, scales, densities, and distributions of data will require different values for these properties to create a visually pleasing separation of high and low intensity areas appropriate for the data and the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#maxPixelIntensity) - * + * * @default 100 */ maxPixelIntensity?: number; /** * The pixel intensity value used to determine which pixels will be assigned the initial color in the [colorStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#colorStops). Pixels with intensity values below this number will be excluded from the visualization. When using a [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#field) to weight the points, setting `minPixelIntensity` above zero might help to visually deemphasize frequently occurring but low value point clusters. This property does not actually filter the data or modify the calculated intensity value. Rather, it scales the color ramp such that a higher intensity value is required for a pixel to get a noticeable color. Determining the best values for `minPixelIntensity` and `maxPixelIntensity` is an exercise left up to the developer since different types, scales, densities, and distributions of data will require different values for these properties to create a visually pleasing separation of high and low intensity areas appropriate for the data and the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minPixelIntensity) - * + * * @default 0 */ minPixelIntensity?: number; @@ -17924,43 +17924,43 @@ declare namespace __esri { interface PointCloudClassBreaksRenderer extends PointCloudRenderer { /** * Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ colorClassBreakInfos: PointCloudClassBreaksRendererColorClassBreakInfos[]; /** * The name of the field that is used to drive the color visualization for the renderer. The value of this field determines which class break each point is assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ legendOptions: PointCloudClassBreaksRendererLegendOptions; /** * The type of renderer. For PointCloudClassBreaksRenderer this value is always `point-cloud-class-breaks`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#type) */ readonly type: "point-cloud-class-breaks"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#clone) - * - * + * + * */ clone(): PointCloudClassBreaksRenderer; } @@ -17968,7 +17968,7 @@ declare namespace __esri { interface PointCloudClassBreaksRendererConstructor { /** * This class defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a numeric attribute. Colors are assigned based on classes or ranges of data. Each point is assigned a symbol based on the class break in which the value of the attribute falls. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html) */ @@ -17982,27 +17982,27 @@ declare namespace __esri { interface PointCloudClassBreaksRendererProperties extends PointCloudRendererProperties { /** * Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ colorClassBreakInfos?: PointCloudClassBreaksRendererColorClassBreakInfos[]; /** * The name of the field that is used to drive the color visualization for the renderer. The value of this field determines which class break each point is assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType?: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ legendOptions?: PointCloudClassBreaksRendererLegendOptions; @@ -18012,25 +18012,25 @@ declare namespace __esri { export interface PointCloudClassBreaksRendererColorClassBreakInfos extends Object { /** * The minimum value of the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ minValue: number; /** * The maximum value of the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ maxValue: number; /** * The color used to colorize the points where values are between the `minValue` and `maxValue` of the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ color: Color; /** * The label used to describe point in the break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos) */ label?: string; @@ -18040,7 +18040,7 @@ declare namespace __esri { export interface PointCloudClassBreaksRendererLegendOptions extends Object { /** * Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and takes precedence over a [field alias](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudClassBreaksRenderer.html#legendOptions) */ title?: string; @@ -18049,37 +18049,37 @@ declare namespace __esri { interface PointCloudRenderer extends Accessor, JSONSupport { /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. High values leave the color unchanged, while low values darken the color of the point. This helps to display the scanned surface in a more realistic way. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ colorModulation: PointCloudRendererColorModulation; /** * Specifies how the size of the points in the point cloud is computed for rendering. The splat algorithm automatically computes a size based on the density, which varies with the Level of Detail that is currently displayed. The fixed size algorithm displays all points with the same size, either in screen space or real world units. When `pointSizeAlgorithm` is not set, the default is `splat`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ pointSizeAlgorithm: PointCloudRendererPointSizeAlgorithm; /** * The number of points to draw per display inch. This property determines the level of detail in the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointsPerInch) - * + * * @default 10 */ pointsPerInch: number; /** * The point cloud renderer type. **Possible values:** point-cloud-class-breaks | point-cloud-rgb | point-cloud-stretch | point-cloud-unique-value - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#type) */ readonly type: string; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#clone) - * - * + * + * */ clone(): PointCloudRenderer; } @@ -18097,21 +18097,21 @@ declare namespace __esri { interface PointCloudRendererProperties { /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. High values leave the color unchanged, while low values darken the color of the point. This helps to display the scanned surface in a more realistic way. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ colorModulation?: PointCloudRendererColorModulation; /** * Specifies how the size of the points in the point cloud is computed for rendering. The splat algorithm automatically computes a size based on the density, which varies with the Level of Detail that is currently displayed. The fixed size algorithm displays all points with the same size, either in screen space or real world units. When `pointSizeAlgorithm` is not set, the default is `splat`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ pointSizeAlgorithm?: PointCloudRendererPointSizeAlgorithm; /** * The number of points to draw per display inch. This property determines the level of detail in the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointsPerInch) - * + * * @default 10 */ pointsPerInch?: number; @@ -18121,23 +18121,23 @@ declare namespace __esri { export interface PointCloudRendererColorModulation extends Object { /** * Field to use for the color modulation. Commonly modulation is used with the `intensity` field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) */ field: string; /** * Field value at which the point color becomes darkest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) - * + * * @default 0 */ minValue?: number; /** * Field value at which the point color will be left unchanged. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#colorModulation) - * + * * @default 255 */ maxValue?: number; @@ -18147,27 +18147,27 @@ declare namespace __esri { export interface PointCloudRendererPointSizeAlgorithm extends Object { /** * `fixed-size` or `splat`. Choosing `fixed-size` implies setting `size` and `useRealWorldSymbolSizes`. If `splat` is chosen then `scaleFactor` should be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ type: string; /** * Specifies whether `size` is in real world units or screen-space units. Applies to `fixed-size` only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ useRealWorldSymbolSizes?: boolean; /** * Point size in meters (`useRealWorldSymbolSizes = true`) or points. Applies to `fixed-size` only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) */ size?: number; /** * Specifies the scale factor that is applied to the size estimated by the density. Applies to `splat` only. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRenderer.html#pointSizeAlgorithm) - * + * * @default 1 */ scaleFactor?: number; @@ -18176,23 +18176,23 @@ declare namespace __esri { interface PointCloudRGBRenderer extends PointCloudRenderer { /** * The name of the field containing RGB values used to drive the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#field) */ field: string; /** * The type of Renderer. For PointCloudRGBRenderer this value is always `point-cloud-rgb`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#type) */ readonly type: "point-cloud-rgb"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#clone) - * - * + * + * */ clone(): PointCloudRGBRenderer; } @@ -18200,7 +18200,7 @@ declare namespace __esri { interface PointCloudRGBRendererConstructor { /** * PointCloudRGBRenderer defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a color attribute. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html) */ @@ -18214,7 +18214,7 @@ declare namespace __esri { interface PointCloudRGBRendererProperties extends PointCloudRendererProperties { /** * The name of the field containing RGB values used to drive the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html#field) */ field?: string; @@ -18223,43 +18223,43 @@ declare namespace __esri { interface PointCloudStretchRenderer extends PointCloudRenderer { /** * The name of the number field whose values are used to drive the continuous color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ legendOptions: PointCloudStretchRendererLegendOptions; /** * An array of color value pairs. Points with values between the specified stops are colorized with linearly interpolated colors. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ stops: PointCloudStretchRendererStops[]; /** * The type of Renderer. For PointCloudStretchRenderer this value is always `point-cloud-stretch`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#type) */ readonly type: "point-cloud-stretch"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#clone) - * - * + * + * */ clone(): PointCloudStretchRenderer; } @@ -18267,7 +18267,7 @@ declare namespace __esri { interface PointCloudStretchRendererConstructor { /** * PointCloudStretchRenderer defines the color of each point in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on the value of a numeric attribute. It allows you to easily map continuous color ramps to minimum and maximum data values of one of the layer's numeric attribute fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html) */ @@ -18281,27 +18281,27 @@ declare namespace __esri { interface PointCloudStretchRendererProperties extends PointCloudRendererProperties { /** * The name of the number field whose values are used to drive the continuous color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType?: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ legendOptions?: PointCloudStretchRendererLegendOptions; /** * An array of color value pairs. Points with values between the specified stops are colorized with linearly interpolated colors. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ stops?: PointCloudStretchRendererStops[]; @@ -18311,7 +18311,7 @@ declare namespace __esri { export interface PointCloudStretchRendererLegendOptions extends Object { /** * Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and takes precedence over a [field alias](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#legendOptions) */ title?: string; @@ -18321,19 +18321,19 @@ declare namespace __esri { export interface PointCloudStretchRendererStops extends Object { /** * The value for this stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ value: number; /** * The label for this stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ label?: string; /** * The color value for this stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html#stops) */ color: Color; @@ -18342,43 +18342,43 @@ declare namespace __esri { interface PointCloudUniqueValueRenderer extends PointCloudRenderer { /** * Each element in the array is an object that matches a unique value with a specific color. Features with equal values to those specified here will be assigned the associated color. For example, you may choose to visualize points representing low vegetation with a green color and points representing power lines with a gray color. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ colorUniqueValueInfos: PointCloudUniqueValueRendererColorUniqueValueInfos[]; /** * The name of the field whose values are used to drive the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#field) */ field: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ legendOptions: PointCloudUniqueValueRendererLegendOptions; /** * The type of Renderer. For PointCloudUniqueValueRenderer this value is always `point-cloud-unique-value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#type) */ readonly type: "point-cloud-unique-value"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#clone) - * - * + * + * */ clone(): PointCloudUniqueValueRenderer; } @@ -18386,7 +18386,7 @@ declare namespace __esri { interface PointCloudUniqueValueRendererConstructor { /** * PointCloudUniqueValueRenderer allows you to colorize points in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) based on an attribute value. This is done by assigning unique colors to represent points with equal attribute values. This renderer is used to visualize points of the same type, not interpolate colors along a continuous ramp mapped to numbers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html) */ @@ -18400,27 +18400,27 @@ declare namespace __esri { interface PointCloudUniqueValueRendererProperties extends PointCloudRendererProperties { /** * Each element in the array is an object that matches a unique value with a specific color. Features with equal values to those specified here will be assigned the associated color. For example, you may choose to visualize points representing low vegetation with a green color and points representing power lines with a gray color. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ colorUniqueValueInfos?: PointCloudUniqueValueRendererColorUniqueValueInfos[]; /** * The name of the field whose values are used to drive the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#field) */ field?: string; /** * A transform that is applied to the field value before evaluating the renderer. **Possible Values:** none | low-four-bit | high-four-bit | absolute-value | modulo-ten - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType) - * + * * @default null */ fieldTransformType?: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ legendOptions?: PointCloudUniqueValueRendererLegendOptions; @@ -18430,19 +18430,19 @@ declare namespace __esri { export interface PointCloudUniqueValueRendererColorUniqueValueInfos extends Object { /** * A unique combination of values that will be represented with the given `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ values: string[]; /** * The color used to represent points whose value matches `values`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ color: Color; /** * Label used to describe points matched to the unique value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos) */ label?: string; @@ -18452,7 +18452,7 @@ declare namespace __esri { export interface PointCloudUniqueValueRendererLegendOptions extends Object { /** * Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and takes precedence over a [field alias](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html#legendOptions) */ title?: string; @@ -18461,13 +18461,13 @@ declare namespace __esri { interface Renderer extends Accessor, JSONSupport { /** * Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as [sizeRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) or [colorRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer). This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections can be remembered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) */ authoringInfo: AuthoringInfo; /** * The renderer type. **Possible values:** class-breaks | heatmap | simple | unique-value - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#type) */ readonly type: string; @@ -18476,7 +18476,7 @@ declare namespace __esri { interface RendererConstructor { /** * Renderers define how to visually represent each feature in one of the following layer types: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) */ @@ -18490,7 +18490,7 @@ declare namespace __esri { interface RendererProperties { /** * Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as [sizeRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) or [colorRendererCreator.createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer). This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections can be remembered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) */ authoringInfo?: AuthoringInfoProperties; @@ -18498,7 +18498,7 @@ declare namespace __esri { /** * Defines a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) with minimum and maximum bounds. When an object with this specification is applied to the [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) property of a renderer, then feature sizes are bounded by min and max data values. Features with values greater than the provided max value are assigned the specified maximum size. Likewise, features with values less than the provied min value are assigned the specified minimum size. Features with values between the min and the max are assigned a corresponding size that is linearly interpolated between the provided min and max size values. The object specification for this object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ export interface BoundedMinMax extends Object { @@ -18506,49 +18506,49 @@ declare namespace __esri { * The size used to render a feature containing the maximum data value. * * When setting a number, sizes are expressed in points for all 2D symbols and 3D flat symbol layers; size is expressed in meters for all 3D volumetric symbols. * * String values are only supported for 2D symbols and 3D flat symbol layers. Strings may specify size in either points or pixels (e.g. `minSize: "16pt"`, `minSize: "12px"`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ maxSize: string | number; /** * Value must be `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ type: string; /** * The name of the numeric attribute field used to normalize the data in `field`. If this field is used, then the values in `maxDataValue` and `minDataValue` should be normalized as percentages or ratios. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ valueExpressionTitle?: string; /** * The maximum data value used in the size ramp. Features with this value or higher will be rendered at the size defined in `maxSize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ maxDataValue: number; /** * The name of the numeric attribute field that contains the data values used to determine the size of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ field?: string; /** * The minimum data value used in the size ramp. Features with this value or lower will be rendered at the size defined in `minSize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ minDataValue: number; @@ -18556,19 +18556,19 @@ declare namespace __esri { * The size used to render a feature containing the minimum data value. * * When setting a number, sizes are expressed in points for all 2D symbols and 3D flat symbol layers; size is expressed in meters for all 3D volumetric symbols. * * String values are only supported for 2D symbols and 3D flat symbol layers. Strings may specify size in either points or pixels (e.g. `minSize: "16pt"`, `minSize: "12px"`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ minSize: string | number; /** * An object providing options for displaying the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ legendOptions?: BoundedMinMaxLegendOptions; /** - * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. - * + * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. + * * Possible Value | Description * ----------------|----------- * width | The diameter of the symbol from east to west. @@ -18576,14 +18576,14 @@ declare namespace __esri { * height | The height of the symbol. * width-and-depth | Applies the size visual variable to both width and depth axes. * all | Applies the size visual variable to all axes. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ axis?: string; /** * When setting a size visual variable on a renderer using an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), this property indicates whether to apply the value defined by the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width), or [depth](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) properties to the corresponding axis of this visual variable instead of proportionally scaling this axis' value after other axes. [View an example](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-3d/index.html) of this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ useSymbolValue?: boolean; @@ -18591,49 +18591,49 @@ declare namespace __esri { /** * The **color** visual variable defines how a continuous color ramp is applied to features based on the values of a numeric attribute field. The minimum and maximum values of the data should be indicated along with their respective color values. You must specify `stops` to construct the color ramp, and either `field` or `valueExpression` to define the driving value. [![renderer-vv-color](https://developers.arcgis.com/javascript/assets/img/samples/7-vv-color.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/index.html) The object specification for color is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ export interface ColorVisualVariable extends Object { /** * **Required.** Value must be `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ type: string; /** * The name of the numeric attribute field that contains the data values used to determine the color of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ field?: string; /** * Name of the numeric attribute field by which to normalize the data. If this field is used, then the values in `stops` should be normalized as percentages or ratios. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ valueExpressionTitle?: string; /** * An object providing options for displaying the color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ legendOptions?: ColorVisualVariableLegendOptions; /** * An array of objects that defines the color ramp in a sequence of stops. At least two stops are required. Features with values between the given stops will be assigned colors along the ramp proportional to the minimum and maximum values used. The stops must be listed in ascending order based on the value of the `value` property in each stop. Each stop object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ stops: ColorVisualVariableStops[]; @@ -18641,49 +18641,49 @@ declare namespace __esri { /** * The **opacity** visual variable defines the opacity of each feature's symbol based on a numeric attribute field value. The minimum and maximum values of the data should be indicated along with their respective opacity values. The specification for this object is provided below. You must specify `stops` to construct the opacity ramp, and either `field` or `valueExpression` to define the driving value. [![renderer-vv-opacity](https://developers.arcgis.com/javascript/assets/img/samples/12-vv-transparency.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-opacity/index.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ export interface OpacityVisualVariable extends Object { /** * **Required.** Value must be `opacity`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ type: string; /** * The name of the numeric attribute field that contains the data values used to determine the opacity of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ field?: string; /** * Name of the attribute field by which to normalize the data. If this field is used, then the values in `stops` should be normalized as percentages or ratios. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding opacity ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ valueExpressionTitle?: string; /** * An object providing options for displaying the opacity ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ legendOptions?: OpacityVisualVariableLegendOptions; /** * An array of objects that defines the thematic opacity ramp in a sequence of stops. At least two stops are required. The stops must be listed in ascending order based on the value of the `value` property in each stop. Each stop object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ stops: OpacityVisualVariableStops[]; @@ -18691,43 +18691,43 @@ declare namespace __esri { /** * Defines a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) where data values are interpreted as real-world sizes based on a given unit. Features are then sized according to the real-world measurements, not thematic values and screen units. [![renderer-vv-rw](https://developers.arcgis.com/javascript/assets/img/samples/2-extrude-height.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-buildings-3d/index.html) The object specification for this object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ export interface RealWorldSize extends Object { /** * Value must be `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ type: string; /** * The name of the numeric attribute field that contains the data values used to determine the size of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ valueExpressionTitle?: string; /** * Indicates the unit of measurement used to interpret the value returned by `field` or `valueExpression`. For 3D volumetric symbols the default is `meters`. This property should not be used if the data value represents a thematic quantity (e.g. traffic count, census data, etc.). **Possible Values:** unknown | inches | feet | yards | miles | nautical-miles | millimeters | centimeters | decimeters | meters | kilometers | decimal-degrees - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ valueUnit: string; /** - * Specifies how to apply the data value when mapping real-world sizes. See table below for supported values. - * + * Specifies how to apply the data value when mapping real-world sizes. See table below for supported values. + * * Value | Description * ------|----------- * radius | The point data value represents the radius of a circular feature. @@ -18735,20 +18735,20 @@ declare namespace __esri { * area | The point data value represents the area of a feature. * width | The polyline data value represents the width of a line. * distance | The polyline data value represents the distance from the center line (one half of the width). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ valueRepresentation?: string; /** * An object providing options for displaying the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ legendOptions?: RealWorldSizeLegendOptions; /** - * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. - * + * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. + * * Possible Value | Description * ----------------|----------- * width | The diameter of the symbol from east to west. @@ -18756,66 +18756,66 @@ declare namespace __esri { * height | The height of the symbol. * width-and-depth | Applies the size visual variable to both width and depth axes. * all | Applies the size visual variable to all axes. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ axis?: string; /** * When setting a size visual variable on a renderer using an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), this property indicates whether to apply the value defined by the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width), or [depth](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) properties to the corresponding axis of this visual variable instead of proportionally scaling this axis' value after other axes. [View an example](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-3d/index.html) of this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ useSymbolValue?: boolean; } /** - * The **rotation** visual variable defines how features rendered with [marker symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) or [text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) in a MapView or [3D object symbol layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html) in a SceneView are rotated. The rotation value is determined by mapping the values to data in a field, or by other arithmetic means with an Arcade expression. This object may be used to depict variables such as wind direction, vehicle heading, etc. [![renderer-vv-rotation](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-vv-rotation.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-rotation/index.html) + * The **rotation** visual variable defines how features rendered with [marker symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) or [text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) in a MapView or [3D object symbol layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html) in a SceneView are rotated. The rotation value is determined by mapping the values to data in a field, or by other arithmetic means with an Arcade expression. This object may be used to depict variables such as wind direction, vehicle heading, etc. [![renderer-vv-rotation](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-vv-rotation.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-rotation/index.html) * > **Known Limitations** In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) rotation visual variables are not currently supported with [marker symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html), [text symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [3D icon symbol layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) and [3D text symbol layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ export interface RotationVisualVariable extends Object { /** * **Required.** Value must be `rotation`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ type: string; /** * The name of the numeric attribute field that contains the rotation angle of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ valueExpression?: string; /** - * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the rotation visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then the following rotation axis will rotate the symbol as indicated by their name. - * + * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the rotation visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then the following rotation axis will rotate the symbol as indicated by their name. + * * Possible Value | Description * ----------------|----------- * heading | The rotation of the symbol in the horizontal plane (i.e., around the z axis). * tilt | The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). * roll | The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ axis?: string; /** * Defines the origin and direction of rotation depending on how the angle of rotation was measured. See the table below for a list of possible values. This property only applies to rotations around the `heading` axis. - * + * * Value | Description * ------|------------ * geographic | Rotates the symbol from the north in a clockwise direction. * arithmetic | Rotates the symbol from the east in a counter-clockwise direction. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) */ rotationType?: string; @@ -18823,67 +18823,67 @@ declare namespace __esri { /** * **Only applicable to [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)**. Defines icon sizes in a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) based on minimum and maximum bounds similar to the [BoundedMinMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) case. However, this specification allows the developer to specify various min and max sizes based on the [MapView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale). Features with values greater than the provided max value are assigned the specified maximum size for the given view scale. Likewise, features with values less than the provied min value are assigned the specified minumum size for the given view scale. Features with values between the min and the max are assigned a corresponding size that is linearly interpolated between the provided min and max size values for the given scale value. The object specification for this object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ export interface ScaleDependentIcons extends Object { /** * Value must be `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ type: string; /** * The name of the numeric attribute field that contains the data values used to determine the size of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ field?: string; /** * The name of the numeric attribute field used to normalize the data in `field`. If this field is used, then the values in `maxDataValue` and `minDataValue` should be normalized as percentages or ratios. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ valueExpressionTitle?: string; /** * The maximum data value used in the size ramp. Features with this value or higher will be rendered at the size defined in `maxSize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ maxDataValue: number; /** * An object defining the size of features whose data value (defined in `field` or `valueExpression`) is greater than or equal to the `maxDataValue` for the given view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ maxSize: ScaleDependentStops; /** * The minimum data value used in the size ramp. Features with this value or lower will be rendered at the size defined in `minSize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ minDataValue: number; /** * An object defining the size of features whose data value (defined in `field` or `valueExpression`) is less than or equal to the `minDataValue` for the given view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ minSize: ScaleDependentStops; /** * An object providing options for displaying the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ legendOptions?: ScaleDependentIconsLegendOptions; @@ -18891,59 +18891,59 @@ declare namespace __esri { /** * **Only applicable to [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)**. Defines feature sizes and outline widths in a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) based on the [MapView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale). It also provides the specification of the `minSize` and `maxSize` properties in a [ScaleDependentIcons](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) size visual variable. The object specification for this object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ export interface ScaleDependentStops extends Object { /** * Value must be `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ type: string; /** * This value must be `$view.scale`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ valueExpression: string; /** * **Deprecated since version 4.2. Use `valueExpression` instead**. The only supported expression is `view.scale`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ expression?: string; /** * This value must be `outline` when scaling polygon outline widths based on the view scale. If scale-dependent icons are desired, then this property should be ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ target?: string; /** * An array of objects that define the size of the icon (or alternatively the width of the polygon outline) at the given scale `value`. At least two stops are required. The stops must be listed in ascending order based on the value of the `value` property in each stop. Each stop object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ stops: ScaleDependentStopsStops[]; } /** - * The **size** visual variable defines the size of individual features in a layer based on a numeric (often thematic) value. This value comes from one of the following: + * The **size** visual variable defines the size of individual features in a layer based on a numeric (often thematic) value. This value comes from one of the following: * * An attribute `field` * * The value of an attribute `field` divided by a `normalizationField` * * A value returned from an [Arcade expression](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) specified in `valueExpression`. - * - * - * Size is defined in the form of a continuous ramp, which may be applied to renderers in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Symbol size may be applied either thematically, or literally using real-world units. See the following object specification tables for details about each potential use of a size visual variable: + * + * + * Size is defined in the form of a continuous ramp, which may be applied to renderers in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Symbol size may be applied either thematically, or literally using real-world units. See the following object specification tables for details about each potential use of a size visual variable: * * **[BoundedMinMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax)** - Feature sizes are bounded by min and max data values. * * **[ThematicStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops)** - Defines two or more stops at which feature sizes are mapped to data values. * * **[ScaleDependentIcons](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons)** - Icons sizes are bounded by min and max data values, but the min and max sizes (and interpolated sizes) change based on the scale of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). * * **[ScaleDependentStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops)** - Defines the width of polygon outlines at various view scales. * * **[RealWorldSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize)** - Feature sizes are determined based on real-world measurements and units, not thematic values and screen units. - * - * + * + * * [![renderer-unique-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-unique-vv.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-2d/index.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) */ export interface SizeVisualVariable extends Object { @@ -18951,55 +18951,55 @@ declare namespace __esri { /** * Defines two or more stops at which feature sizes are mapped to data values in a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable). Setting two stops will have the same effect as creating a [BoundedMinMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) size visual variable. Adding additional stops allows you to map specific sizes with data values. Sizes are interpolated linearly between stop values. The object specification for this object is provided below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ export interface ThematicStops extends Object { /** * Value must be `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ type: string; /** * The name of the numeric attribute field that contains the data values used to determine the size of each feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ field?: string; /** * The name of the numeric attribute field used to normalize the data in `field`. If this field is used, then the values in `stops` should be normalized as percentages or ratios. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. This takes precedence over `field`. Therefore, this property is typically used as an alternative to `field` in visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the `valueExpression` property. This is displayed as the title of the corresponding size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the `legendOptions` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ valueExpressionTitle?: string; /** * An array of objects that defines the thematic size ramp in a sequence of data or expression stops. At least two stops are required. The stops must be listed in ascending order based on the value of the `value` property in each stop. Each stop object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ stops: ThematicStopsStops[]; /** * An object providing options for displaying the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ legendOptions?: ThematicStopsLegendOptions; /** - * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. - * + * Only applicable when working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Defines the axis the size visual variable should be applied to when rendering features with an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). See the [local scene sample](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/index.html) for an example of this. + * * Possible Value | Description * ----------------|----------- * width | The diameter of the symbol from east to west. @@ -19007,14 +19007,14 @@ declare namespace __esri { * height | The height of the symbol. * width-and-depth | Applies the size visual variable to both width and depth axes. * all | Applies the size visual variable to all axes. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ axis?: string; /** * When setting a size visual variable on a renderer using an [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), this property indicates whether to apply the value defined by the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width), or [depth](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) properties to the corresponding axis of this visual variable instead of proportionally scaling this axis' value after other axes. [View an example](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-3d/index.html) of this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ useSymbolValue?: boolean; @@ -19024,13 +19024,13 @@ declare namespace __esri { export interface BoundedMinMaxLegendOptions extends Object { /** * The title describing the visualization of the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ title?: string; /** * Indicates whether to show the size ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#BoundedMinMax) */ showLegend?: boolean; @@ -19040,13 +19040,13 @@ declare namespace __esri { export interface ColorVisualVariableLegendOptions extends Object { /** * The title describing the visualization of the color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ title?: string; /** * Indicates whether to show the color ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ showLegend?: boolean; @@ -19056,19 +19056,19 @@ declare namespace __esri { export interface ColorVisualVariableStops extends Object { /** * **Required**. Specifies the data value to map with the given `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ value: number; /** * **Required**. The [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) used to render features with the given `value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ color: Color; /** * A string value used to label the stop in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) */ label?: string; @@ -19078,13 +19078,13 @@ declare namespace __esri { export interface OpacityVisualVariableLegendOptions extends Object { /** * The title describing the visualization of the opacity ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ title?: string; /** * Indicates whether to show the opacity ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ showLegend?: boolean; @@ -19094,19 +19094,19 @@ declare namespace __esri { export interface OpacityVisualVariableStops extends Object { /** * **Required**. Specifies the data value to map with the given `opacity`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ value: number; /** * **Required**. The opacity value used to render features containing the specified `value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ opacity: number; /** * A string value used to label the stop in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) */ label?: string; @@ -19116,13 +19116,13 @@ declare namespace __esri { export interface RealWorldSizeLegendOptions extends Object { /** * The title describing the visualization of the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ title?: string; /** * Indicates whether to show the size ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RealWorldSize) */ showLegend?: boolean; @@ -19132,13 +19132,13 @@ declare namespace __esri { export interface ScaleDependentIconsLegendOptions extends Object { /** * The title describing the visualization of the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ title?: string; /** * Indicates whether to show the size ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentIcons) */ showLegend?: boolean; @@ -19148,13 +19148,13 @@ declare namespace __esri { export interface ScaleDependentStopsStops extends Object { /** * Specifies the scale value to map with the given `size`. When the [MapView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) equals the given number then icons (or outlines) will be rendered with the given size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ value: number; /** * The size at which to render features at the specified scale `value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ScaleDependentStops) */ size: string | number; @@ -19164,13 +19164,13 @@ declare namespace __esri { export interface ThematicStopsLegendOptions extends Object { /** * The title describing the visualization of the size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This takes precedence over a field alias or `valueExpressionTitle`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ title?: string; /** * Indicates whether to show the size ramp in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ showLegend?: boolean; @@ -19180,19 +19180,19 @@ declare namespace __esri { export interface ThematicStopsStops extends Object { /** * Specifies the data or expression value to map with the given `size`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ value: number; /** * The size at which to render features containing the specified `value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ size: number | string; /** * A string value used to label the stop in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ThematicStops) */ label?: string; @@ -19201,29 +19201,29 @@ declare namespace __esri { interface SimpleRenderer extends Renderer, VisualVariablesMixin { /** * The label for the renderer. This describes what features with the given [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) represent in the real world. This will display next to the layer's [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) inside the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. This text is not displayed in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) when [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) are used. When the renderer contains [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables), you should set the `title` property in `legendOptions` on each visual variable to describe the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#label) */ label: string; /** * The symbol used by the renderer to visualize all features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) */ symbol: Symbol; /** * The type of renderer. For SimpleRenderer this value is always `simple`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#type) */ readonly type: "simple"; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#clone) - * - * + * + * */ clone(): SimpleRenderer; } @@ -19231,7 +19231,7 @@ declare namespace __esri { interface SimpleRendererConstructor { /** * SimpleRenderer renders all features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) with one [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html). This renderer may be used to simply visualize the location of geographic features. For example, layers representing political boundaries, cities, buildings, rivers, etc. that are typically used for providing geographic context in an application may be defined with a single symbol per layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html) */ @@ -19245,13 +19245,13 @@ declare namespace __esri { interface SimpleRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * The label for the renderer. This describes what features with the given [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) represent in the real world. This will display next to the layer's [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) inside the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. This text is not displayed in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) when [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables) are used. When the renderer contains [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#visualVariables), you should set the `title` property in `legendOptions` on each visual variable to describe the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#label) */ label?: string; /** * The symbol used by the renderer to visualize all features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html#symbol) */ symbol?: SymbolProperties; @@ -19259,25 +19259,25 @@ declare namespace __esri { /** * This object contains helper methods for generating data-driven visualizations with continuous color or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The methods in this module generate renderer or visual variable objects that may be applied directly to a supported layer. The renderers specify how features should be visualized based on data values and colors optimized based on the indicated basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html) */ interface color { /** * Generates a continuous color [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) representing the age of features based on one or more fields. The age of a feature is calculated based on a given `startTime` and `endTime`, one of which must be a date field in the input `layer`. This method generates an Arcade expression and calculates statistics on the output of the expression to accomplish this. The resulting renderer contains a continuous color visual variable that maps optimal colors based on the indicated basemap to data values based on the resulting statistics of the expression. You are required to provide a `layer`, `view`, `startTime`, and `endTime` to generate this renderer. Optionally, you can set a `unit` and a `theme` for the visualization. Other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the statistics object to the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) - * + * * @param params Input parameters for generating a continuous color visualization of age for time data returned from start and/or end date field(s). See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.view The view instance in which the visualization will be rendered. - * @param params.startTime The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` paramter must reference a Date field in the layer. - * @param params.endTime The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` paramter must reference a Date field in the layer. + * @param params.startTime The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` parameter must reference a Date field in the layer. + * @param params.endTime The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` parameter must reference a Date field in the layer. * @param params.unit The time unit used to calculate the difference between `endTime` and `startTime`. If a unit is not specified, then a suggested unit is determined based on the spread and distribution of the data. **Possible Values:** years | months | days | hours | minutes | seconds * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * @param params.theme + * @param params.theme * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | @@ -19287,49 +19287,49 @@ declare namespace __esri { * @param params.legendOptions Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * @param params.statistics A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. * @param params.colorScheme In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createAgeRenderer(params: colorCreateAgeRendererParams): IPromise; /** * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) that may be applied directly to the layer used to call this method. The resulting renderer defines the symbol color of each feature based on the value of the given `field` value. A default color scheme is determined based on the given `basemap`. Depending on the `classificationMethod`, class breaks (or data ranges) are generated based on the statistics of the data. Each feature is assigned a color based on the class break in which the value of the `field` falls. In most cases you will provide a `layer`, `basemap`, `field`, and `classificationMethod` to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what colors to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @param params Input parameters for generating a classed color visualization based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.field The name of the field whose data will be queried for statistics and classified. This property is ignored if a `valueExpression` is used. * @param params.normalizationField The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. * @param params.normalizationType With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the `field` value by the value of `normalizationField`. This value is set by default if the `normalizationField` is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use `normalizationTotal` to define the total value by which to normalize. This value is set by default if the `normalizationTotal` is provided. - * + * * @param params.normalizationTotal When `normalizationType` is `percent-of-total`, this property contains the total of all data values. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * @param params.classificationMethod - * The classification method used for generating breaks. See the table below for a list of possible values. - * + * @param params.classificationMethod + * The classification method used for generating breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * equal-interval | Divides the range of attribute values into equal-sized subranges. For example, if you specify three classes for a field whose values range from 0 to 300, this method will create three classes with ranges of 0–100, 101–200, and 201–300. Equal interval is best applied to familiar data ranges, such as percentages and temperature. This method emphasizes the amount of an attribute value relative to other values. For example, it could show if a store is part of the group of stores that make up the top one-third of all sales. @@ -19348,38 +19348,38 @@ declare namespace __esri { * @param params.maxValue A maximum value set by the user. Use this in conjunction with `minValue` to generate class breaks between lower and upper bounds. This will be the upper bound of the highest class break. * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createClassBreaksRenderer(params: colorCreateClassBreaksRendererParams): IPromise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to the layer used to call this method. The renderer contains a continuous color visual variable that maps optimal colors based on the indicated basemap to specific stop values based on queried statistics from the indicated field or expression. In most cases you will provide a `layer`, `basemap`, `field`, and `theme` to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what colors to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the statistics object to the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) - * + * * @param params Input parameters for generating a continuous color visualization based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. * @param params.normalizationField The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * @param params.theme + * @param params.theme * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | @@ -19397,30 +19397,30 @@ declare namespace __esri { * @param params.maxValue A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned color visual variable. * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createContinuousRenderer(params: colorCreateContinuousRendererParams): IPromise; /** * Generates a [PointCloudStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudStretchRenderer.html) with a color scheme best-suited for the given basemap based on statistics returned from a given field of a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). All that's required is a layer instance, field name, and basemap ID. You can optionally set the size and density of the points to suit the needs of the desired visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) - * + * * @param params Input parameters for generating a renderer based on the given field of the input layer. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. The only field names used for this renderer type are `elevation` and `intensity`. @@ -19429,34 +19429,34 @@ declare namespace __esri { * @param params.density The number of points per inch in the view. * @param params.colorScheme In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. * @param params.statistics A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the stats object here to avoid making a second statistics query to the server. - * + * */ createPCContinuousRenderer(params: colorCreatePCContinuousRendererParams): IPromise; /** * Generates a [PointCloudRGBRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html) based on the `RGB` field of a given [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). This method simplifies the experience of creating a [PointCloudRGBRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudRGBRenderer.html) manually. All that's required is a layer instance. You can optionally set the size and density of the points to suit the needs of the desired visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCTrueColorRenderer) - * + * * @param params Input parameters for generating a true color visualization based on the `RGB` field of the input layer. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.size The size of each point expressed as a percentage. This value will determine point sizes scaled based on the given `density` of points. When the value is `100%`, the size of each point is set so that it minimizes the number of gaps between neighboring points. Any value above `100%` will allow for points to overlap neighboring points scaled to the given value. Values below `100%` scale point sizes smaller so there appear to be more gaps between points. * @param params.density The number of points per inch in the view. - * + * */ createPCTrueColorRenderer(params: colorCreatePCTrueColorRendererParams): IPromise; /** * This method generates a color visual variable with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and colors based on the input basemap. There are two different ways this method may be called. The most common case is by providing a `layer`, `basemap`, `field`, and `theme`. This is the scenario where the statistics of the data aren't well known and the user doesn't know what colors to use. You can optionally use a `valueExpression` instead of a field to visualize features based on a numeric value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the object in the `statistics` parameter to avoid making an extra call to the server. You can also provide a `colorScheme` if you don't want one picked for you. In this case the `basemap` and `theme` options would be ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) - * + * * @param params Input parameters for generating a color visual variable based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visual variable is generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. * @param params.normalizationField The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * @param params.theme + * @param params.theme * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | @@ -19474,7 +19474,7 @@ declare namespace __esri { * @param params.maxValue A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned color visual variable. * @param params.view When generating 3D symbols (except for layers with a `mesh` geometry type), a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. * @param params.worldScale Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology, except for layers with a `mesh` geometry type. A `view` must be provided if this property is set to `true`. - * + * */ createVisualVariable(params: colorCreateVisualVariableParams): IPromise; } @@ -19483,49 +19483,49 @@ declare namespace __esri { /** * The result object of the [createAgeRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ export interface AgeRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ renderer: ClassBreaksRenderer; /** * A color visual variable configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ visualVariable: ColorVisualVariable; /** * The time unit used to represent age in the output `renderer`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ unit: string; /** * The color scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#AgeRendererResult) */ basemapId: string; @@ -19533,37 +19533,37 @@ declare namespace __esri { /** * The result object of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ export interface ClassBreaksRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ renderer: ClassBreaksRenderer; /** * This object describes class breaks generated from data in a layer for a given field with a specified classification method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ classBreaksResult: ClassBreaksResult; /** * The color scheme used for the class breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ClassBreaksRendererResult) */ basemapId: string; @@ -19573,109 +19573,109 @@ declare namespace __esri { export interface colorCreateAgeRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The view instance in which the visualization will be rendered. - * + * * [Read more...](global.html) */ view: View; /** - * The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` paramter must reference a Date field in the layer. - * + * The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` parameter must reference a Date field in the layer. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ startTime: Date | string | number; /** - * The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` paramter must reference a Date field in the layer. - * + * The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` parameter must reference a Date field in the layer. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ endTime: Date | string | number; /** * The time unit used to calculate the difference between `endTime` and `startTime`. If a unit is not specified, then a suggested unit is determined based on the spread and distribution of the data. **Possible Values:** years | months | days | hours | minutes | seconds - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ unit?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ theme?: string; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ legendOptions?: colorCreateAgeRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ statistics?: SummaryStatisticsResult; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ colorScheme?: ColorScheme; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) - * + * * @default 2d */ symbolType?: string; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -19685,13 +19685,13 @@ declare namespace __esri { export interface colorCreateAgeRendererParamsLegendOptions extends Object { /** * The title used to represent the age color ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ title?: string; /** * Indicates whether to include the age renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createAgeRenderer) */ showLegend?: boolean; @@ -19701,171 +19701,171 @@ declare namespace __esri { export interface colorCreateClassBreaksRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and classified. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ normalizationField?: string; /** - * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the `field` value by the value of `normalizationField`. This value is set by default if the `normalizationField` is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use `normalizationTotal` to define the total value by which to normalize. This value is set by default if the `normalizationTotal` is provided. - * + * * With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ normalizationType?: string; /** * When `normalizationType` is `percent-of-total`, this property contains the total of all data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ normalizationTotal?: number; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** - * The classification method used for generating breaks. See the table below for a list of possible values. - * + * The classification method used for generating breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * equal-interval | Divides the range of attribute values into equal-sized subranges. For example, if you specify three classes for a field whose values range from 0 to 300, this method will create three classes with ranges of 0–100, 101–200, and 201–300. Equal interval is best applied to familiar data ranges, such as percentages and temperature. This method emphasizes the amount of an attribute value relative to other values. For example, it could show if a store is part of the group of stores that make up the top one-third of all sales. * natural-breaks | Groups similar values that maximize the differences between classes. Features are divided into classes whose boundaries are set where there are relatively big differences in the data values. Natural breaks are data-specific classifications and not useful for comparing multiple maps built from different underlying information. * quantile | Assigns the same number of data values to each class. This is well suited to linearly distributed data. Because features are grouped in equal numbers in each class, the resulting map can often be misleading. Similar features can potentially be placed in adjacent classes, or features with widely different values can be put in the same class. You can minimize this distortion by increasing the number of classes. * standard-deviation | Creates class breaks with equal value ranges that are a proportion of the standard deviation. This is usually done at intervals of one, one-half, one-third, or one-fourth standard deviations from the mean. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default equal-interval */ classificationMethod?: string; /** * If a `standard-deviation` classification method is used, then this indicates the interval by which to generate class breaks. **Possible Values:** 1 | 0.5 | 0.33 | 0.25 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default 1 */ standardDeviationInterval?: number; /** * The number of class breaks to generate. This is ignored if a `standard-deviation` classification method is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default 5 */ numClasses?: number; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ sqlWhere?: string; /** * Provides options for setting a title to describe a field instead of using the field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ legendOptions?: colorCreateClassBreaksRendererParamsLegendOptions; /** * A minimum value set by the user. Use this in conjunction with `maxValue` to generate class breaks between lower and upper bounds. This will be the lower bound of the lowest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ minValue?: number; /** * A maximum value set by the user. Use this in conjunction with `minValue` to generate class breaks between lower and upper bounds. This will be the upper bound of the highest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default 2d */ symbolType?: string; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -19875,7 +19875,7 @@ declare namespace __esri { export interface colorCreateClassBreaksRendererParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer) */ title?: string; @@ -19885,139 +19885,139 @@ declare namespace __esri { export interface colorCreateContinuousRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ normalizationField?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ theme?: string; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ legendOptions?: colorCreateContinuousRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) - * + * * @default 2d */ symbolType?: string; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -20027,13 +20027,13 @@ declare namespace __esri { export interface colorCreateContinuousRendererParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ title?: string; /** * Indicates whether to describe the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) */ showLegend?: boolean; @@ -20043,49 +20043,49 @@ declare namespace __esri { export interface colorCreatePCContinuousRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) */ layer: PointCloudLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. The only field names used for this renderer type are `elevation` and `intensity`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) */ field: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * The size of each point expressed as a percentage. This value will determine point sizes scaled based on the given `density` of points. When the value is `100%`, the size of each point is set so that it minimizes the number of gaps between neighboring points. Any value above `100%` will allow for points to overlap neighboring points scaled to the given value. Values below `100%` scale point sizes smaller so there appear to be more gaps between points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) - * + * * @default 100% */ size?: string; /** * The number of points per inch in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) - * + * * @default 25 */ density?: number; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) */ colorScheme?: ColorScheme; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the stats object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) */ statistics?: SummaryStatisticsResult; @@ -20095,23 +20095,23 @@ declare namespace __esri { export interface colorCreatePCTrueColorRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCTrueColorRenderer) */ layer: PointCloudLayer; /** * The size of each point expressed as a percentage. This value will determine point sizes scaled based on the given `density` of points. When the value is `100%`, the size of each point is set so that it minimizes the number of gaps between neighboring points. Any value above `100%` will allow for points to overlap neighboring points scaled to the given value. Values below `100%` scale point sizes smaller so there appear to be more gaps between points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCTrueColorRenderer) - * + * * @default 100% */ size?: string; /** * The number of points per inch in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCTrueColorRenderer) - * + * * @default 25 */ density?: number; @@ -20121,107 +20121,107 @@ declare namespace __esri { export interface colorCreateVisualVariableParams extends Object { /** * The layer for which the visual variable is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ normalizationField?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) - * + * * @default gray */ basemap?: string | Basemap; /** * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ theme?: string; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ colorScheme?: ColorScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ legendOptions?: colorCreateVisualVariableParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ maxValue?: number; /** * When generating 3D symbols (except for layers with a `mesh` geometry type), a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology, except for layers with a `mesh` geometry type. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ worldScale?: boolean; @@ -20231,13 +20231,13 @@ declare namespace __esri { export interface colorCreateVisualVariableParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ title?: string; /** * Indicates whether to describe the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) */ showLegend?: boolean; @@ -20245,43 +20245,43 @@ declare namespace __esri { /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createContinuousRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ export interface ContinuousRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * A color visual variable configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ visualVariable: ColorVisualVariable; /** * The color scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#ContinuousRendererResult) */ basemapId: string; @@ -20289,37 +20289,37 @@ declare namespace __esri { /** * The result object of the [createPCContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCContinuousRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ export interface PCContinuousRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this object on the input layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ renderer: PointCloudStretchRenderer; /** * The color scheme used by the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ colorScheme: ColorScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal color scheme for the output renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCContinuousRendererResult) */ basemapId: string; @@ -20327,13 +20327,13 @@ declare namespace __esri { /** * The result object of the [createPCTrueColorRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createPCTrueColorRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCTrueColorRendererResult) */ export interface PCTrueColorRendererResult extends Object { /** * The renderer object configured to represent the true color of each point in the point cloud. This gives the PointCloudLayer a realistic visualization of how it looks in the real world. Set this object on the input layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#PCTrueColorRendererResult) */ renderer: PointCloudRGBRenderer; @@ -20341,43 +20341,43 @@ declare namespace __esri { /** * The result object of the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createVisualVariable) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ export interface VisualVariableResult extends Object { /** * A color visual variable configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ visualVariable: ColorVisualVariable; /** * The color scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ colorScheme: ColorScheme; /** * Basic statistics returned from a query to the service for the given field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ basemapId: string; /** * Authoring information related to the creation of the visual variable. This includes information related to UI inputs from sliders and selected themes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; @@ -20385,37 +20385,37 @@ declare namespace __esri { /** * This object contains helper methods for generating location-only visualizations (not data-driven) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) method generates a [SimpleRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html) object that may be applied directly to the layer. This renderer contains a single symbol with a color optimally selected based on the indicated basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html) */ interface location { /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a supported [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The renderer contains a single symbol with a color optimally chosen based on the indicated basemap. In most cases you will provide a `layer` and `basemap` to generate this renderer. If working in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), then the `view` and `symbolType` options should be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) - * + * * @param params Input parameters for generating a location-based visualization. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * @param params.locationScheme In authoring apps, the user may select a pre-defined location scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. * @param params.view The SceneView instance in which the visualization will be rendered. This parameter is required if `symbolType = "3d-volumetric"`, except for layers with a `mesh` geometryType. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createRenderer(params: locationCreateRendererParams): IPromise; } @@ -20426,57 +20426,57 @@ declare namespace __esri { export interface locationCreateRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * In authoring apps, the user may select a pre-defined location scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) */ locationScheme?: LocationScheme; /** * The SceneView instance in which the visualization will be rendered. This parameter is required if `symbolType = "3d-volumetric"`, except for layers with a `mesh` geometryType. - * + * * [Read more...](global.html) */ view?: SceneView; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) - * + * * @default 2d */ symbolType?: string; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -20484,25 +20484,25 @@ declare namespace __esri { /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#createRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#RendererResult) */ export interface RendererResult extends Object { /** * A simple renderer configured with a single color best suited to match the given basemap. Set this to a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#RendererResult) */ renderer: SimpleRenderer; /** * The location scheme used by the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#RendererResult) */ locationScheme: LocationScheme; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-location.html#RendererResult) */ basemapId: string; @@ -20510,15 +20510,15 @@ declare namespace __esri { /** * This object contains a helper method for generating data-driven visualizations with continuous opacity based on data returned from a field value or expression in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html) */ interface opacity { /** * This method generates an opacity visual variable with default alpha values optimally mapped to data values based on the statistics queried for the indicated field or expression. There are several ways this method may be called. The most common case is by providing a `layer` and a `field`. This is the scenario where the statistics of the data aren't well known and the user doesn't know the which alpha values to map to data values. You can optionally use a `valueExpression` instead of a field to visualize features based on a numeric value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the stats in the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) - * + * * @param params Input parameters for generating an opacity visual variable based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visual variable is generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. @@ -20532,7 +20532,7 @@ declare namespace __esri { * @param params.minValue A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variable. * @param params.maxValue A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned visual variable. * @param params.view A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * */ createVisualVariable(params: opacityCreateVisualVariableParams): IPromise; } @@ -20543,73 +20543,73 @@ declare namespace __esri { export interface opacityCreateVisualVariableParams extends Object { /** * The layer for which the visual variable is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ legendOptions?: opacityCreateVisualVariableParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ maxValue?: number; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; @@ -20619,7 +20619,7 @@ declare namespace __esri { export interface opacityCreateVisualVariableParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) */ title?: string; @@ -20627,31 +20627,31 @@ declare namespace __esri { /** * The result object of the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#createVisualVariable) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#VisualVariableResult) */ export interface opacityVisualVariableResult extends Object { /** * An opacity visual variable configured based on the statistics of the data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#VisualVariableResult) */ visualVariable: OpacityVisualVariable; /** * Basic statistics returned from a query to the service for the given field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * Authoring information related to the creation of the visual variable. This includes information related to UI inputs from sliders and selected themes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-opacity.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; @@ -20659,13 +20659,13 @@ declare namespace __esri { /** * This object contains a helper method for generating a predominance visualization. Visualizing predominance involves coloring a [layer’s](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) features based on which attribute among a set of competing numeric attributes wins or beats the others in total count. Common applications of this include visualizing election results, survey results, and demographic majorities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html) */ interface predominance { /** - * Generates a predominance renderer based on a set of competing numeric fields. Visualizing predominance involves coloring a [layer’s](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) features based on which attribute among a set of competing numeric attributes wins or beats the others in total count. Common applications of this include visualizing election results, survey results, and demographic majorities. For example, suppose you have a layer of U.S. counties with fields containing the total sales of various crops: wheat, soybeans, corn, cotton, and vegetables. If a feature has the following values for each field: - * + * Generates a predominance renderer based on a set of competing numeric fields. Visualizing predominance involves coloring a [layer’s](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) features based on which attribute among a set of competing numeric attributes wins or beats the others in total count. Common applications of this include visualizing election results, survey results, and demographic majorities. For example, suppose you have a layer of U.S. counties with fields containing the total sales of various crops: wheat, soybeans, corn, cotton, and vegetables. If a feature has the following values for each field: + * * Field Name | Count | Color * -----------|-------|------ * Wheat | 130 | purple @@ -20673,11 +20673,11 @@ declare namespace __esri { * Corn | 0 | yellow * Cotton | 300 | green * Vegetables | 120 | red - * + * * Then the renderer symbolizes the feature with a blue color since Soybeans is the predominant crop. The predominant field of a feature is determined based on the result of an Arcade expression generated by this method. You are required to provide a `layer`, `view`, and list of `fields` to generate this renderer. Optionally, you can set `includeSizeVariable` to `true` to change the size of each feature to indicate how influential the feature is compared to the entire layer as a whole. You can also set `includeOpacityVariable` to `true` to add opacity to each feature depending on how strong the predominant field is compared to all the other fields. For the example above, the feature would likely be opaque since Soybeans beats all other features combined by a wide margin. If the Soybean total were still the highest, but only 301, then the feature would be very transparent, indicating the Soybean total wins, but not by a wide margin. Other options are provided for convenience for more involved custom visualization authoring applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @param params Input parameters for generating a predominance visualization based on a set of competing field(s). See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.view The view instance in which the visualization will be rendered. @@ -20687,34 +20687,34 @@ declare namespace __esri { * @param params.includeSizeVariable Indicates whether to include data-driven size in the final renderer. If `true`, features will be assigned a sized based on the sum of all competing values in the `fields` param. Features with small total counts will be sized with small icons or lines depending on the geometry type of the layer, and features with large total counts will be sized with large icons or lines. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values. ![predominance-size](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/predominance-size.png) * @param params.legendOptions Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * @param params.statistics A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. - * @param params.sortBy + * @param params.sortBy * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). See the table below for information about values that may be passed to this parameter. - * + * * Possible Value | Description * ---------------|------------ * count | Unique values/types will be sorted from highest to lowest based on the count of features that fall in each category. * value | Unique values/types will be sorted in the order they were specified in the `fields` parameter. - * + * * **Possible Values:** count | value * @param params.predominanceScheme In authoring apps, the user may select a pre-defined predominance scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createRenderer(params: predominanceCreateRendererParams): IPromise; } @@ -20725,111 +20725,111 @@ declare namespace __esri { export interface predominanceCreateRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The view instance in which the visualization will be rendered. - * + * * [Read more...](global.html) */ view: View; /** * A set of competing numeric fields used as the basis of the predominance visualization. For example, if creating an election map, you would indicate the names of each field representing the candidate or political party where total votes are stored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ fields: predominanceCreateRendererParamsFields[]; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * Indicates whether to include data-driven opacity in the final renderer. If `true`, features where the predominant value beats all others by a large margin are given a high opacity. Features where the predominant value beats others by a small margin will be assigned a low opacity, indicating that while the feature has a winning value, it doesn't win by much. ![predominance-opacity](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/predominance-opacity.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ includeOpacityVariable?: boolean; /** * Indicates whether to include data-driven size in the final renderer. If `true`, features will be assigned a sized based on the sum of all competing values in the `fields` param. Features with small total counts will be sized with small icons or lines depending on the geometry type of the layer, and features with large total counts will be sized with large icons or lines. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values. ![predominance-size](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/predominance-size.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ includeSizeVariable?: boolean; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ legendOptions?: predominanceCreateRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ statistics?: SummaryStatisticsResult; /** * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). See the table below for information about values that may be passed to this parameter. - * + * * Possible Value | Description * ---------------|------------ * count | Unique values/types will be sorted from highest to lowest based on the count of features that fall in each category. * value | Unique values/types will be sorted in the order they were specified in the `fields` parameter. - * + * * **Possible Values:** count | value - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @default count */ sortBy?: string; /** * In authoring apps, the user may select a pre-defined predominance scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ predominanceScheme?: PredominanceScheme; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @default 2d */ symbolType?: string; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -20839,13 +20839,13 @@ declare namespace __esri { export interface predominanceCreateRendererParamsFields extends Object { /** * The name of a numeric field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ name: string; /** * The label describing the field name (or category) in the legend. This is should be used if the given field doesn't have an intuitive field name. For example, for a field named `dem` representing the total vote count for the Democratic party, you can set the label to `Democrat` to clarify the name of the category in the final visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ label?: string; @@ -20855,13 +20855,13 @@ declare namespace __esri { export interface predominanceCreateRendererParamsLegendOptions extends Object { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ title?: string; /** * Indicates whether to include the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) */ showLegend?: boolean; @@ -20869,49 +20869,49 @@ declare namespace __esri { /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#createRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ export interface predominanceRendererResult extends Object { /** * The unique value renderer object representing the predominance visualization. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ renderer: UniqueValueRenderer; /** * An array of objects describing the value, symbol, and count of each unique type or category represented in the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ predominantCategoryInfos: UniqueValueInfo[]; /** * An array of objects describing the values or categories excluded from consideration in visualizing data from the given fields. The specification of each object matches that of the objects specified in the `predominantCategoryInfos` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ excludedCategoryInfos: any[]; /** * A size visual variable representing the total count of all fields included in the predominance visualization. This is included if the `includeSizeVariable` parameter is true. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ size?: sizeVisualVariableResult; /** * An opacity visual variable representing the percentage of the total count comprised by the predominant value of all fields. This variable indicates the strength of a particular value's predominance compared to the other values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ opacity?: opacityVisualVariableResult; /** * The predominance scheme used by the renderer based on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ predominanceScheme: PredominanceScheme; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html#RendererResult) */ basemapId: string; @@ -20919,24 +20919,24 @@ declare namespace __esri { /** * This object contains a helper method for creating a renderer for exploring the relationship between two numeric attributes. This is commonly known as a [bivariate choropleth](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/) visualization. This renderer classifies each variable in either 2, 3, or 4 classes along separate color ramps. One of those ramps is rotated 90 degrees and overlaid on the other to create a 2x2, 3x3, or 4x4 square grid. The x-axis indicates the range of values for one variable, and the y-axis indicates the range for the second variable. The squares running diagonal from the lower left corner to the upper right corner indicate features where the two variables may be related or in agreement with one another. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html) */ interface relationship { /** * Generates a relationship renderer (bivariate choropleth) based on a set of competing numeric fields. Each feature's category is determined based on the result of an Arcade expression generated internally by this method. You are required provide a `layer`, `view`, `field1` name, and `field2` name to generate this renderer. Optionally, you can set the `focus` to change the rotation of the legend and the `numClasses` parameter to change the grid size of the legend. Other options are provided for convenience for more involved custom visualization authoring applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @param params Input parameters for generating a relationship visualization based on a pair of numeric field(s). See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.view The view instance in which the visualization will be rendered. * @param params.field1 A numeric field that will be used to explore its relationship with `field2`. In the default visualization, the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * @param params.field2 A numeric field that will be used to explore its relationship with `field1`. In the default visualization, the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * @param params.classificationMethod The method for classifying each field's data values. See [classBreaks](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) for more information about each classification type. **Possible Values:** quantile | equal-interval | natural-breaks - * @param params.focus - * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This value does not change the renderer or symbology of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description at the top of this page for a more thorough explanation of how to read the legend. - * + * @param params.focus + * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This value does not change the renderer or symbology of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description at the top of this page for a more thorough explanation of how to read the legend. + * * Value | Example | Description * ------|-------------|-------- * null | ![relationship-legend-null](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-null.png) | The legend renders as a square. The top right corner of the legend indicates that values from both `field1` and `field2` are considered high. | @@ -20944,35 +20944,35 @@ declare namespace __esri { * HL | ![relationship-legend-hl](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-hl.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are high and values from `field2` are low. | * LH | ![relationship-legend-lh](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-lh.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are low and values from `field2` are high. | * LL | ![relationship-legend-ll](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-ll.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered low. | - * @param params.numClasses - * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization more difficult to understand. There are only three possible values. - * + * @param params.numClasses + * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization more difficult to understand. There are only three possible values. + * * 2 classes | 3 classes | 4 classes * --|--|--- * ![relationship-breaks-2](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-2.png) | ![relationship-breaks-3](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-3.png) | ![relationship-breaks-4](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-4.png) - * + * * **Possible Values:** 2 | 3 | 4 * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * @param params.legendOptions Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * @param params.relationshipScheme In authoring apps, the user may select a pre-defined relationship scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value or that fall outside of the prescribed class breaks. - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createRenderer(params: relationshipCreateRendererParams): IPromise; } @@ -20983,39 +20983,39 @@ declare namespace __esri { export interface relationshipCreateRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The view instance in which the visualization will be rendered. - * + * * [Read more...](global.html) */ view: View; /** * A numeric field that will be used to explore its relationship with `field2`. In the default visualization, the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ field1: relationshipCreateRendererParamsField1; /** * A numeric field that will be used to explore its relationship with `field1`. In the default visualization, the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ field2: relationshipCreateRendererParamsField2; /** * The method for classifying each field's data values. See [classBreaks](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) for more information about each classification type. **Possible Values:** quantile | equal-interval | natural-breaks - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default quantile */ classificationMethod?: string; /** - * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This value does not change the renderer or symbology of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description at the top of this page for a more thorough explanation of how to read the legend. - * + * Determines the orientation of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). This value does not change the renderer or symbology of any features in the layer. This affects the legend only. See the table below for a description of the possible values. See the class description at the top of this page for a more thorough explanation of how to read the legend. + * * Value | Example | Description * ------|-------------|-------- * null | ![relationship-legend-null](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-null.png) | The legend renders as a square. The top right corner of the legend indicates that values from both `field1` and `field2` are considered high. | @@ -21023,81 +21023,81 @@ declare namespace __esri { * HL | ![relationship-legend-hl](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-hl.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are high and values from `field2` are low. | * LH | ![relationship-legend-lh](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-lh.png) | The legend renders as a diamond with the focus on the top corner where values from `field1` are low and values from `field2` are high. | * LL | ![relationship-legend-ll](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-legend-ll.png) | The legend renders as a diamond with the focus on the top corner where values from both `field1` and `field2` are considered low. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ focus?: string; /** - * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization more difficult to understand. There are only three possible values. - * + * Indicates the number of classes by which to break up the values of each field. More classes give you more detail, but more colors, making the visualization more difficult to understand. There are only three possible values. + * * 2 classes | 3 classes | 4 classes * --|--|--- * ![relationship-breaks-2](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-2.png) | ![relationship-breaks-3](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-3.png) | ![relationship-breaks-4](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/smartmapping/relationship-breaks-4.png) - * + * * **Possible Values:** 2 | 3 | 4 - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default 3 */ numClasses?: number; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ legendOptions?: relationshipCreateRendererParamsLegendOptions; /** * In authoring apps, the user may select a pre-defined relationship scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ relationshipScheme?: RelationshipScheme; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default 2d */ symbolType?: string; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value or that fall outside of the prescribed class breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -21107,25 +21107,25 @@ declare namespace __esri { export interface relationshipCreateRendererParamsField1 extends Object { /** * The name of a numeric field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ minValue?: number; @@ -21135,25 +21135,25 @@ declare namespace __esri { export interface relationshipCreateRendererParamsField2 extends Object { /** * The name of a numeric field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ field: string; /** * The name of a numeric field used to normalize the given `field`. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ minValue?: number; @@ -21163,13 +21163,13 @@ declare namespace __esri { export interface relationshipCreateRendererParamsLegendOptions extends Object { /** * The title used to describe the renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ title?: string; /** * Indicates whether to include the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) */ showLegend?: boolean; @@ -21177,37 +21177,37 @@ declare namespace __esri { /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#createRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ export interface relationshipRendererResult extends Object { /** * The renderer object representing the relationship visualization. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ renderer: UniqueValueRenderer; /** * Describes each class break for both fields considered in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ classBreaks: RendererResultClassBreaks; /** * Describes each container or bin used in the visualization. Each unique value info object describes a class break for `field1` and `field2`. Therefore, features with the same color fall share will have values that fall in the same class break for `field1` and the same class break for `field2`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ uniqueValueInfos: UniqueValueInfo[]; /** * The relationship scheme used by the renderer based on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ relationshipScheme: RelationshipScheme; /** * The ID of the basemap used to determine the optimal fill colors of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ basemapId: string; @@ -21217,13 +21217,13 @@ declare namespace __esri { export interface RendererResultClassBreaks extends Object { /** * The class breaks generated for values in the `field1` parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ field1: ClassBreaksResult; /** * The class breaks generated for values in the `field2` parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html#RendererResult) */ field2: ClassBreaksResult; @@ -21231,60 +21231,60 @@ declare namespace __esri { /** * This object contains helper methods for generating data-driven visualizations with continuous size or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The methods in this module generate renderer or visual variable objects that may be applied directly to a supported layer. The renderers specify how features should be visualized based on data values and sizes optimized based on the indicated basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html) */ interface size { /** * Generates a continuous size [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) representing the age of features based on one or more fields. The age of a feature is calculated based on a given `startTime` and `endTime`, one of which must be a date field in the input `layer`. This method generates an Arcade expression and calculates statistics on the output of the expression to accomplish this. The resulting renderer contains a continuous size visual variable that maps optimal sizes based on the indicated basemap to data values based on the resulting statistics of the expression. You are required to provide a `layer`, `view`, `startTime`, and `endTime` to generate this renderer. Optionally, you can set a `unit` for the visualization. Other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the statistics object to the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) - * + * * @param params Input parameters for generating a continuous size visualization of age for time data returned from start and/or end date field(s). See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.view The view instance in which the visualization will be rendered. - * @param params.startTime The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` paramter must reference a Date field in the layer. - * @param params.endTime The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` paramter must reference a Date field in the layer. + * @param params.startTime The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` parameter must reference a Date field in the layer. + * @param params.endTime The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` parameter must reference a Date field in the layer. * @param params.unit The time unit used to calculate the difference between `endTime` and `startTime`. If a unit is not specified, then a suggested unit is determined based on the spread and distribution of the data. **Possible Values:** years | months | days | hours | minutes | seconds * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * @param params.legendOptions Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. * @param params.statistics A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. * @param params.sizeScheme In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * + * */ createAgeRenderer(params: sizeCreateAgeRendererParams): IPromise; /** * Generates a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) that may be applied directly to the layer used to call this method. The resulting renderer defines the symbol size of each feature based on the value of the given `field` value. A default size scheme is determined based on the given `basemap`. Depending on the `classificationMethod`, class breaks (or data ranges) are generated based on the statistics of the data. Each feature is assigned a size based on the class break in which the value of the `field` falls. In most cases you will provide a `layer`, `basemap`, `field`, and `classificationMethod` to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what sizes to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @param params Input parameters for generating a classed size visualization based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * @param params.field The name of the field whose data will be queried for statistics and classified. This property is ignored if a `valueExpression` is used. * @param params.normalizationField The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. * @param params.normalizationType With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the `field` value by the value of `normalizationField`. This value is set by default if the `normalizationField` is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use `normalizationTotal` to define the total value by which to normalize. This value is set by default if the `normalizationTotal` is provided. - * + * * @param params.normalizationTotal When `normalizationType` is `percent-of-total`, this property contains the total of all data values. - * @param params.classificationMethod - * The classification method used for generating breaks. See the table below for a list of possible values. - * + * @param params.classificationMethod + * The classification method used for generating breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * equal-interval | Divides the range of attribute values into equal-sized subranges. For example, if you specify three classes for a field whose values range from 0 to 300, this method will create three classes with ranges of 0–100, 101–200, and 201–300. Equal interval is best applied to familiar data ranges, such as percentages and temperature. This method emphasizes the amount of an attribute value relative to other values. For example, it could show if a store is part of the group of stores that make up the top one-third of all sales. @@ -21303,23 +21303,23 @@ declare namespace __esri { * @param params.maxValue A maximum value set by the user. Use this in conjunction with `minValue` to generate class breaks between lower and upper bounds. This will be the upper bound of the highest class break. * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * + * */ createClassBreaksRenderer(params: sizeCreateClassBreaksRendererParams): IPromise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to the layer used to call this method. The renderer contains a continuous size visual variable that maps marker sizes to specific stop values based on queried statistics from the indicated field or expression. In most cases you will provide a `layer`, `basemap`, and `field` to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what sizes to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the statistics object to the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) - * + * * @param params Input parameters for generating size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the renderer is generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. @@ -21336,23 +21336,23 @@ declare namespace __esri { * @param params.maxValue A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned size visual variable. * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * + * */ createContinuousRenderer(params: sizeCreateContinuousRendererParams): IPromise; /** * This method generates an array of size visual variables with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and mapped to appropriate sizes. There are two different ways this method may be called. The most common case is by providing a `layer`, `basemap`, and `field`. This is the scenario where the statistics of the data aren't well known and the user doesn't know what sizes to use. You can optionally use a `valueExpression` instead of a field to visualize features based on a numeric value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the object in the `statistics` parameter to avoid making an extra call to the server. You can also provide a `sizeScheme` if you don't want one picked for you. In this case the `basemap` and `theme` options would be ignored. The resulting array of visual variables will contain exactly one size visual variable unless the `axis` parameter is set to "height". - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) - * + * * @param params Input parameters for generating size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visual variables are generated. * @param params.field The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. @@ -21370,7 +21370,7 @@ declare namespace __esri { * @param params.view When generating 3D symbols, a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. * @param params.worldScale Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology. A `view` must be provided if this property is set to `true`. * @param params.axis When set to `all`, a single size variable that scales uniformly in all dimensions is generated. When set to `height`, the result contains two size visual variables: the first one sizes the height according to the field statistics, while the second defines a constant size for width and depth. **Possible Values:** all | height - * + * */ createVisualVariables(params: sizeCreateVisualVariablesParams): IPromise; } @@ -21379,49 +21379,49 @@ declare namespace __esri { /** * The result object of the [createAgeRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ export interface sizeAgeRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ renderer: ClassBreaksRenderer; /** * Size visual variables configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ visualVariables: SizeVisualVariable[]; /** * The time unit used to represent age in the output `renderer`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ unit: string; /** * The size scheme used by the visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query for the generated expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#AgeRendererResult) */ basemapId: string; @@ -21429,37 +21429,37 @@ declare namespace __esri { /** * The result object of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ export interface sizeClassBreaksRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ renderer: ClassBreaksRenderer; /** * This object describes class breaks generated from data in a layer for a given field with a specified classification method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ classBreaksResult: ClassBreaksResult; /** * The size scheme used by the visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ defaultValuesUsed: boolean; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ClassBreaksRendererResult) */ basemapId: string; @@ -21467,43 +21467,43 @@ declare namespace __esri { /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ export interface sizeContinuousRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * Size visual variables configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ visualVariables: SizeVisualVariable[]; /** * The size scheme used by the visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values are used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for data from the given field name or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#ContinuousRendererResult) */ basemapId: string; @@ -21513,80 +21513,80 @@ declare namespace __esri { export interface sizeCreateAgeRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The view instance in which the visualization will be rendered. - * + * * [Read more...](global.html) */ view: View; /** - * The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` paramter must reference a Date field in the layer. - * + * The name of the field, or a date value representing the start time in the age calculation. If a date value is specified, then the `endTime` parameter must reference a Date field in the layer. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ startTime: Date | string | number; /** - * The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` paramter must reference a Date field in the layer. - * + * The name of the field, or a date value representing the end time in the age calculation. If a date value is specified, then the `startTime` parameter must reference a Date field in the layer. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ endTime: Date | string | number; /** * The time unit used to calculate the difference between `endTime` and `startTime`. If a unit is not specified, then a suggested unit is determined based on the spread and distribution of the data. **Possible Values:** years | months | days | hours | minutes | seconds - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ unit?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * Provides options for modifying [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) properties describing the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ legendOptions?: sizeCreateAgeRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. The `createAgeRenderer()` method generates an Arcade expression and executes a statistics query against the layer for the result of the expression. If statistics for the expression have already been generated, then pass the object here to avoid making a second statistics query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ statistics?: SummaryStatisticsResult; /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ sizeScheme?: SizeScheme; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter does not need to be specified for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) - * + * * @default 2d */ symbolType?: string; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; @@ -21596,13 +21596,13 @@ declare namespace __esri { export interface sizeCreateAgeRendererParamsLegendOptions extends Object { /** * The title used to represent the age size ramp in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ title?: string; /** * Indicates whether to include the age renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createAgeRenderer) */ showLegend?: boolean; @@ -21612,157 +21612,157 @@ declare namespace __esri { export interface sizeCreateClassBreaksRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * The name of the field whose data will be queried for statistics and classified. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ field: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ normalizationField?: string; /** - * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. - * + * Indicates how the data is normalized. The data value obtained from the `field` is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * field | Divides the `field` value by the value of `normalizationField`. This value is set by default if the `normalizationField` is provided. * log | Computes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values. * percent-of-total | Divides the data value by the sum of all data values then multiplies by 100. Use `normalizationTotal` to define the total value by which to normalize. This value is set by default if the `normalizationTotal` is provided. - * + * * With the exception of `log` normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations. For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ normalizationType?: string; /** * When `normalizationType` is `percent-of-total`, this property contains the total of all data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ normalizationTotal?: number; /** - * The classification method used for generating breaks. See the table below for a list of possible values. - * + * The classification method used for generating breaks. See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------ * equal-interval | Divides the range of attribute values into equal-sized subranges. For example, if you specify three classes for a field whose values range from 0 to 300, this method will create three classes with ranges of 0–100, 101–200, and 201–300. Equal interval is best applied to familiar data ranges, such as percentages and temperature. This method emphasizes the amount of an attribute value relative to other values. For example, it could show if a store is part of the group of stores that make up the top one-third of all sales. * natural-breaks | Groups similar values that maximize the differences between classes. Features are divided into classes whose boundaries are set where there are relatively big differences in the data values. Natural breaks are data-specific classifications and not useful for comparing multiple maps built from different underlying information. * quantile | Assigns the same number of data values to each class. This is well suited to linearly distributed data. Because features are grouped in equal numbers in each class, the resulting map can often be misleading. Similar features can potentially be placed in adjacent classes, or features with widely different values can be put in the same class. You can minimize this distortion by increasing the number of classes. * standard-deviation | Creates class breaks with equal value ranges that are a proportion of the standard deviation. This is usually done at intervals of one, one-half, one-third, or one-fourth standard deviations from the mean. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default equal-interval */ classificationMethod?: string; /** * If a `standard-deviation` classification method is used, then this indicates the interval by which to generate class breaks. **Possible Values:** 1 | 0.5 | 0.33 | 0.25 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default 1 */ standardDeviationInterval?: number; /** * The number of class breaks to generate. This is ignored if a `standard-deviation` classification method is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default 5 */ numClasses?: number; /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ sqlWhere?: string; /** * Provides options for setting a title to describe a field instead of using the field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ legendOptions?: sizeCreateClassBreaksRendererParamsLegendOptions; /** * A minimum value set by the user. Use this in conjunction with `maxValue` to generate class breaks between lower and upper bounds. This will be the lower bound of the lowest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ minValue?: number; /** * A maximum value set by the user. Use this in conjunction with `minValue` to generate class breaks between lower and upper bounds. This will be the upper bound of the highest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) - * + * * @default 2d */ symbolType?: string; @@ -21772,7 +21772,7 @@ declare namespace __esri { export interface sizeCreateClassBreaksRendererParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createClassBreaksRenderer) */ title?: string; @@ -21782,111 +21782,111 @@ declare namespace __esri { export interface sizeCreateContinuousRendererParams extends Object { /** * The layer for which the renderer is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ normalizationField?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ legendOptions?: sizeCreateContinuousRendererParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) - * + * * @default true */ defaultSymbolEnabled?: boolean; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) - * + * * @default 2d */ symbolType?: string; @@ -21896,13 +21896,13 @@ declare namespace __esri { export interface sizeCreateContinuousRendererParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ title?: string; /** * Indicates whether to describe the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createContinuousRenderer) */ showLegend?: boolean; @@ -21912,101 +21912,101 @@ declare namespace __esri { export interface sizeCreateVisualVariablesParams extends Object { /** * The layer for which the visual variables are generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ field: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ normalizationField?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) - * + * * @default gray */ basemap?: string | Basemap; /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ sizeScheme?: SizeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ sqlWhere?: string; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ legendOptions?: sizeCreateVisualVariablesParamsLegendOptions; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ maxValue?: number; /** * When generating 3D symbols, a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ worldScale?: boolean; /** * When set to `all`, a single size variable that scales uniformly in all dimensions is generated. When set to `height`, the result contains two size visual variables: the first one sizes the height according to the field statistics, while the second defines a constant size for width and depth. **Possible Values:** all | height - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) - * + * * @default all */ axis?: string; @@ -22016,13 +22016,13 @@ declare namespace __esri { export interface sizeCreateVisualVariablesParamsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ title?: string; /** * Indicates whether to describe the renderer in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) */ showLegend?: boolean; @@ -22030,43 +22030,43 @@ declare namespace __esri { /** * The result object of the [createVisualVariables()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#createVisualVariables) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ export interface sizeVisualVariableResult extends Object { /** * An array of size visual variables configured based on the statistics of the data and the view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ visualVariables: SizeVisualVariable[]; /** * The size scheme used by the main visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ sizeScheme: SizeScheme; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ basemapId: string; /** * Authoring information related to the creation of the visual variable. This includes information related to UI inputs from sliders and selected themes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-size.html#VisualVariableResult) */ authoringInfo: AuthoringInfo; @@ -22074,15 +22074,15 @@ declare namespace __esri { /** * This object contains helper methods for generating data-driven visualizations with unique types (or categories) based on a field value from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) method generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) object that may be applied directly to the layer used to generate it. This renderer contains unique values with colors best suited to the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html) */ interface type { /** * Generates a [PointCloudUniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PointCloudUniqueValueRenderer.html) based on a given field of a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html). This renderer visualizes points of the same type, usually from the `CLASS_CODE` field or an equivalent field that stores information related to the classification of the data (e.g. low vegetation, high vegetation, ground, etc.). The generated renderer visualizes each point with a standard predefined color matching the class code of the point. All that's required is a layer instance and field name. You can optionally set the size and density of the points to suit the needs of the desired visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) - * + * * @param params Input parameters for generating a renderer based on the given field of the input layer. See the table below for details of each parameter. * @param params.layer The layer for which the visualization is generated. * @param params.field The name of the field containing classification data for the given layer. A common field name used for this renderer type is `CLASS_CODE`, though other fields can be used. @@ -22090,27 +22090,27 @@ declare namespace __esri { * @param params.density The number of points per inch in the view. * @param params.typeScheme In authoring apps, the user may select a pre-defined type scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. * @param params.statistics A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * */ createPCClassRenderer(params: typeCreatePCClassRendererParams): IPromise; /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) that supports renderers. The renderer contains unique symbols representing a string or a numeric value returned from the indicated field. In most cases you will provide a `layer`, `basemap`, and `field` to generate this renderer. This is a scenario in which the values of the field aren't well known and the user doesn't know which colors to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @param params Input parameters for generating symbols to represent unique types based on data returned from a given field. See the table below for details of each parameter. * @param params.layer The layer for which the renderer is generated. * @param params.field The name of the field from which to extract unique values that will be used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. * @param params.numTypes The number of types (or categories) displayed by the renderer. Use `-1` to display all returned types. - * @param params.sortBy + * @param params.sortBy * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). See the table below for information about values that may be passed to this parameter. - * + * * Possible Value | Description * ---------------|------------ * count | Unique values/types will be sorted from highest to lowest based on the count of features that fall in each category. * value | Unique values/types will be sorted in alphabetical order. - * + * * **Possible Values:** count | value * @param params.typeScheme In authoring apps, the user may select a pre-defined type scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. * @param params.valueExpression An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number or a string. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. @@ -22118,9 +22118,9 @@ declare namespace __esri { * @param params.legendOptions Provides options for setting a title to a field that will override the field alias defined in the service. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). * @param params.defaultSymbolEnabled Enables the `defaultSymbol` on the renderer and assigns it to features with no value. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter can be ignored for layers with a `mesh` geometry type. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter can be ignored for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | @@ -22128,15 +22128,15 @@ declare namespace __esri { * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly-sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | * @param params.statistics A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * @param params.colorMixMode - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * @param params.colorMixMode + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * + * */ createRenderer(params: typeCreateRendererParams): IPromise; } @@ -22145,13 +22145,13 @@ declare namespace __esri { /** * The result object of the [createPCClassRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#PCClassRendererResult) */ export interface PCClassRendererResult extends Object { /** * The renderer object configured to represent the class codes in the point cloud. Set this object on the input layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#PCClassRendererResult) */ renderer: PointCloudUniqueValueRenderer; @@ -22159,37 +22159,37 @@ declare namespace __esri { /** * The result object of the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ export interface typeRendererResult extends Object { /** * The renderer object configured to best match the given basemap. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ renderer: UniqueValueRenderer; /** * An array of objects describing the value, symbol, and count of each unique type or category represented in the renderer. See the table below describing each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ uniqueValueInfos: UniqueValueInfo[]; /** * An array of objects describing the values or categories excluded from consideration in visualizing data from the given field. The specification of each object matches that of the objects specified in the `uniqueValueInfos` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ excludedUniqueValueInfos: any[]; /** * The scheme used to represent each category within the `uniqueValueInfos`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ typeScheme: TypeScheme; /** * The ID of the basemap used to determine the optimal color scheme to represent the categorical variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#RendererResult) */ basemapId: string; @@ -22199,41 +22199,41 @@ declare namespace __esri { export interface typeCreatePCClassRendererParams extends Object { /** * The layer for which the visualization is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) */ layer: PointCloudLayer; /** * The name of the field containing classification data for the given layer. A common field name used for this renderer type is `CLASS_CODE`, though other fields can be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) */ field: string; /** * The size of each point expressed as a percentage. This value will determine point sizes scaled based on the given `density` of points. When the value is `100%`, the size of each point is set so that it minimizes the number of gaps between neighboring points. Any value above `100%` will allow for points to overlap neighboring points scaled to the given value. Values below `100%` scale point sizes smaller so there appear to be more gaps between points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) - * + * * @default 100% */ size?: string; /** * The number of points per inch in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) - * + * * @default 25 */ density?: number; /** * In authoring apps, the user may select a pre-defined type scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) */ typeScheme?: TypeSchemeForPoint; /** * A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createPCClassRenderer) */ statistics?: UniqueValuesResult; @@ -22243,118 +22243,118 @@ declare namespace __esri { export interface typeCreateRendererParams extends Object { /** * The layer for which the renderer is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The name of the field from which to extract unique values that will be used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ field?: string; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * The number of types (or categories) displayed by the renderer. Use `-1` to display all returned types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @default 10 */ numTypes?: number; /** * Indicates how values should be sorted in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). See the table below for information about values that may be passed to this parameter. - * + * * Possible Value | Description * ---------------|------------ * count | Unique values/types will be sorted from highest to lowest based on the count of features that fall in each category. * value | Unique values/types will be sorted in alphabetical order. - * + * * **Possible Values:** count | value - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @default count */ sortBy?: string; /** * In authoring apps, the user may select a pre-defined type scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ typeScheme?: TypeScheme; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number or a string. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ valueExpressionTitle?: string; /** * Provides options for setting a title to a field that will override the field alias defined in the service. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ legendOptions?: typeCreateRendererParamsLegendOptions; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ defaultSymbolEnabled?: boolean; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter can be ignored for layers with a `mesh` geometry type. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. This parameter can be ignored for layers with a `mesh` geometry type. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly-sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sized uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @default 2d */ symbolType?: string; /** * A statistics object generated from the [uniqueValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ statistics?: UniqueValuesResult; /** - * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. - * + * **This option only applies to generating renderers for mesh SceneLayers**. Specifies how the symbol's color is applied to the geometry color/texture. See the documentation in [FillSymbol3DLayer.material](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#material) for more context. See the table below for possible values. + * * Value | Description * ------|------------ * tint | Applies the symbol `color` to the desaturated geometry/texture color. * replace | Removes the geometry/texture color and applies the symbol `color`. * multiply | Multiplies geometry/texture color value with the symbol `color` value. The result is a darker color. Multiplying with white keeps the geometry color the same. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) - * + * * @default replace */ colorMixMode?: string; @@ -22364,7 +22364,7 @@ declare namespace __esri { export interface typeCreateRendererParamsLegendOptions extends Object { /** * The title used to represent the given field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) */ title: string; @@ -22372,31 +22372,31 @@ declare namespace __esri { /** * Describes the symbol, label, and value of a unique value generated by the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#createRenderer) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#UniqueValueInfo) */ export interface UniqueValueInfo extends Object { /** * A unique value representing a type or category of features in a layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#UniqueValueInfo) */ value: string | number; /** * The number of features with the given `value` (or belonging to the given category). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#UniqueValueInfo) */ count: number; /** * The label describing the value or category in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#UniqueValueInfo) */ label: string; /** * The symbol used to represent features belonging to the given category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-type.html#UniqueValueInfo) */ symbol: Symbol; @@ -22404,15 +22404,15 @@ declare namespace __esri { /** * This object contains helper methods for generating data-driven univariate visualizations using both continuous color and continuous size based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) method generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) object that may be applied directly to a supported layer. This renderer contains a continuous color and size ramp with optimal colors based on the indicated basemap and mapped to specific break values based on the statistics of the indicated field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html) */ interface univariateColorSize { /** * Generates a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that may be applied directly to a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The renderer contains continuous color and size visual variables that map symbols with optimal colors and sizes based on the indicated basemap to specific stop values based on queried statistics from the indicated field or expression. In most cases you will provide a `layer`, `basemap`, `field`, and `theme` to generate this renderer. This is a scenario in which the statistics of the data aren't well known and the user doesn't know what colors and sizes to use in the visualization. You can also use a `valueExpression` instead of a `field` to visualize features based on a value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the statistics object to the `statistics` parameter to avoid making an extra call to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) - * + * * @param params See the table below for details of each parameter that may be passed to this method. * @param params.layer The layer for which the visual variable is generated. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. @@ -22429,23 +22429,23 @@ declare namespace __esri { * @param params.colorOptions Options for configuring the color portion of the visualization. * @param params.sizeOptions Options for configuring the size portion of the visualization. * @param params.view The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * @param params.symbolType - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * @param params.symbolType + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sizes uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * + * */ createContinuousRenderer(params: univariateColorSizeCreateContinuousRendererParams): IPromise; /** * This method generates color and size visual variables, both based on the same given field or expression. These visual variables are generated with default stops that are optimally chosen based on the statistics queried for the indicated field or expression and colors based on the input basemap. There are two different ways this method may be called. The most common case is by providing a `layer`, `basemap`, and `field`. This is the scenario where the statistics of the data aren't well known and the user doesn't know what colors to use. You can optionally use a `valueExpression` instead of a field to visualize features based on a numeric value returned from a script executed at runtime. The other options are provided for convenience for more involved custom visualization authoring applications. For example, if you already generated statistics in another operation, you can pass the object in the `statistics` parameter to avoid making an extra call to the server. You can also provide a `colorScheme` and/or a `sizeScheme` if you don't want one picked for you. In this case the `basemap` and `theme` options would be ignored. The resulting array of visual variables will contain one color visual variable, and one or two size visual variables depending on the value of the `sizeOptions.axis` parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) - * + * * @param params Input parameters for generating color and size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * @param params.layer The layer for which the visual variable is generated. * @param params.basemap The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. @@ -22462,7 +22462,7 @@ declare namespace __esri { * @param params.sizeOptions Options for configuring the size portion of the visualization. * @param params.view When generating 3D symbols, a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. * @param params.worldScale Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * */ createVisualVariables(params: univariateColorSizeCreateVisualVariablesParams): IPromise; } @@ -22471,43 +22471,43 @@ declare namespace __esri { /** * The result object of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ export interface univariateColorSizeContinuousRendererResult extends Object { /** * The renderer object configured to best match the given basemap and the spread of the data. Set this on a layer's `renderer` property to update its visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ renderer: ClassBreaksRenderer; /** * Object containing visual variable and scheme information for the color portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ color: ContinuousRendererResultColor; /** * Object containing visual variable and scheme information for the size portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ size: ContinuousRendererResultSize; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ basemapId: string; @@ -22517,109 +22517,109 @@ declare namespace __esri { export interface univariateColorSizeCreateContinuousRendererParams extends Object { /** * The layer for which the visual variable is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) - * + * * @default gray */ basemap?: string | Basemap; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ sqlWhere?: string; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ maxValue?: number; /** * Enables the `defaultSymbol` on the renderer and assigns it to features with no value and features that do not fall within the configured data range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ defaultSymbolEnabled?: boolean; /** * Options for configuring the color portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ colorOptions?: univariateColorSizeCreateContinuousRendererParamsColorOptions; /** * Options for configuring the size portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ sizeOptions?: univariateColorSizeCreateContinuousRendererParamsSizeOptions; /** * The view instance in which the visualization will be rendered. A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is required if `symbolType = "3d-volumetric"` or `3d-volumetric-uniform`. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** - * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. - * + * The type of symbol to generate. This depends on the view in which you are working and the desired visualization. Possible values are described below. + * * | Value | Description | * | ----- | ----------- | * | 2d | Generates a visualization using 2D symbols such as [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), or [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html). Use this option if generating a visualization for data in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). | * | 3d-flat | Generates a visualization using 3D symbols with flat symbol layers such as [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html), [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html), or [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html). Use this option if generating a 2D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). | * | 3d-volumetric | Generates a visualization using 3D symbols with volumetric symbol layers such as [ObjectSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html), [PathSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html), or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html). Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and only the symbol's height should be variable, for example with cylinders. A SceneView instance must be provided to the `view` parameter if this option is used. | * | 3d-volumetric-uniform | Generates a visualization using uniformly sized 3D symbols with volumetric symbol layers. Use this option if generating a 3D visualization for data in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) and the symbol should be sizes uniformly, for example with spheres. A SceneView instance must be provided to the `view` parameter if this option is used. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) - * + * * @default 2d */ symbolType?: string; @@ -22629,27 +22629,27 @@ declare namespace __esri { export interface univariateColorSizeCreateContinuousRendererParamsColorOptions extends Object { /** * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ theme?: string; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ colorScheme?: ColorScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ legendOptions?: univariateColorSizeCreateContinuousRendererParamsColorOptionsLegendOptions; @@ -22659,7 +22659,7 @@ declare namespace __esri { export interface univariateColorSizeCreateContinuousRendererParamsColorOptionsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ title: string; @@ -22669,13 +22669,13 @@ declare namespace __esri { export interface univariateColorSizeCreateContinuousRendererParamsSizeOptions extends Object { /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ sizeScheme?: SizeScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ legendOptions?: univariateColorSizeCreateContinuousRendererParamsSizeOptionsLegendOptions; @@ -22685,7 +22685,7 @@ declare namespace __esri { export interface univariateColorSizeCreateContinuousRendererParamsSizeOptionsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createContinuousRenderer) */ title: string; @@ -22695,93 +22695,93 @@ declare namespace __esri { export interface univariateColorSizeCreateVisualVariablesParams extends Object { /** * The layer for which the visual variable is generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ layer: FeatureLayer | SceneLayer | CSVLayer; /** * The [named string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or basemap object of the Esri basemap that will be paired with the output visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) - * + * * @default gray */ basemap?: string | Basemap; /** * The name of the field whose data will be queried for statistics and used for the basis of the data-driven visualization. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ field?: string; /** * The name of the field to normalize the values of the given `field`. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized with minimal bias due to area differences or count variation. This option is commonly used when visualizing densities. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ normalizationField?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ valueExpression?: string; /** * Text describing the value returned from the `valueExpression`. This is used by the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ valueExpressionTitle?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ sqlWhere?: string; /** * A statistics object generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) function. If statistics for the field have already been generated, then pass the object here to avoid making a second statistics query to the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ statistics?: SummaryStatisticsResult; /** * A custom minimum value set by the user. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. This will be the lowest stop in the returned visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ minValue?: number; /** * A custom maximum value set by the user. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. This will be the uppermost stop in the returned visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ maxValue?: number; /** * Options for configuring the color portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ colorOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptions; /** * Options for configuring the size portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ sizeOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptions; /** * When generating 3D symbols, a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance is required. The relevant SceneView or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * Indicates if the size units of the symbols will be in meters. This should be `true` when generating visualizations with 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ worldScale?: boolean; @@ -22791,27 +22791,27 @@ declare namespace __esri { export interface univariateColorSizeCreateVisualVariablesParamsColorOptions extends Object { /** * Determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ theme?: string; /** * In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on a `theme` and the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ colorScheme?: ColorScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ legendOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions; @@ -22821,7 +22821,7 @@ declare namespace __esri { export interface univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ title: string; @@ -22831,21 +22831,21 @@ declare namespace __esri { export interface univariateColorSizeCreateVisualVariablesParamsSizeOptions extends Object { /** * When set to `all`, a single size variable that scales uniformly in all dimensions is generated. When set to `height`, the result contains two size visual variables: the first one sizes the height according to the field statistics, while the second defines a constant size for width and depth. **Possible Values:** all | height - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) - * + * * @default all */ axis?: boolean; /** * In authoring apps, the user may select a pre-defined size scheme. Pass the scheme object to this property to avoid getting one based on the `basemap`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ sizeScheme?: SizeScheme; /** * Provides options for setting a title to a field when an expression is provided instead of a field name. This title will represent the field in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ legendOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions; @@ -22855,7 +22855,7 @@ declare namespace __esri { export interface univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions extends Object { /** * The title used to represent the given field or expression in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) */ title: string; @@ -22863,43 +22863,43 @@ declare namespace __esri { /** * The result object of the [createVisualVariables()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#createVisualVariables) method. See the table below for details of each property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ export interface VisualVariablesResult extends Object { /** * Object containing visual variable and scheme information for the color portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ color: VisualVariablesResultColor; /** * Object containing visual variable and scheme information for the size portion of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ size: VisualVariablesResultSize; /** * Indicates whether default values were used in the absence of sufficient data and/or statistics from the layer. Default values are typically used when all features have the same field value or no value at all. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ defaultValuesUsed: boolean; /** * Basic statistics returned from a query to the service for the given field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ statistics: SummaryStatisticsResult; /** * The ID of the basemap used to determine the optimal fill color of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ basemapId: string; /** * Authoring information related to the creation of the visual variables. This includes inforamation related to UI inputs from sliders and selected themes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ authoringInfo: AuthoringInfo; @@ -22909,13 +22909,13 @@ declare namespace __esri { export interface ContinuousRendererResultColor extends Object { /** * A color visual variable configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ visualVariable: ColorVisualVariable; /** * The color scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ colorScheme: ColorScheme; @@ -22925,13 +22925,13 @@ declare namespace __esri { export interface ContinuousRendererResultSize extends Object { /** * The size visual variable(s) configured based on the statistics of the data and the view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ visualVariables: SizeVisualVariable[]; /** * The size scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#ContinuousRendererResult) */ sizeScheme: SizeScheme; @@ -22941,13 +22941,13 @@ declare namespace __esri { export interface VisualVariablesResultColor extends Object { /** * A color visual variable configured based on the statistics of the data and the given basemap and scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ visualVariable: ColorVisualVariable; /** * The color scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ colorScheme: ColorScheme; @@ -22957,13 +22957,13 @@ declare namespace __esri { export interface VisualVariablesResultSize extends Object { /** * The size visual variable(s) configured based on the statistics of the data and the view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ visualVariables: SizeVisualVariable[]; /** * The size scheme used by the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html#VisualVariablesResult) */ sizeScheme: SizeScheme; @@ -22971,22 +22971,22 @@ declare namespace __esri { /** * Function for generating class breaks for an input field in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) based on a given classification method and normalization type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html) */ interface classBreaks { /** * Generates class breaks for an input field (or expression) of a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) based on a given classification method and normalization type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) - * + * * @param params See the table below for details about parameters that may be passed to this function. * @param params.layer The layer from which to generate class breaks. * @param params.field The class breaks will be generated based on values of this field. If a field is provided, the values from the given field from all features will be queried in the service. * @param params.normalizationField The field by which to normalize the values returned from the given `field`. - * @param params.classificationMethod - * The method for classifying the data. See the table below for a list of possible values. - * + * @param params.classificationMethod + * The method for classifying the data. See the table below for a list of possible values. + * * | Possible Value | Description | * |---------------|------------ | * | natural-breaks | Data values that cluster are placed into a single class. Class breaks occur where gaps exist between clusters. You should use this method if your data is unevenly distributed; that is, many features have the same or similar values and there are gaps between groups of values. | @@ -23002,7 +23002,7 @@ declare namespace __esri { * @param params.sqlWhere A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. * @param params.view A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * @param params.features A subset of features for which to generate the class breaks. - * + * */ classBreaks(params: classBreaksClassBreaksParams): IPromise; } @@ -23015,87 +23015,87 @@ declare namespace __esri { export interface classBreaksClassBreaksParams extends Object { /** * The layer from which to generate class breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ layer: FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer; /** * The class breaks will be generated based on values of this field. If a field is provided, the values from the given field from all features will be queried in the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ field?: string; /** * The field by which to normalize the values returned from the given `field`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ normalizationField?: string; /** - * The method for classifying the data. See the table below for a list of possible values. - * + * The method for classifying the data. See the table below for a list of possible values. + * * | Possible Value | Description | * |---------------|------------ | * | natural-breaks | Data values that cluster are placed into a single class. Class breaks occur where gaps exist between clusters. You should use this method if your data is unevenly distributed; that is, many features have the same or similar values and there are gaps between groups of values. | * | equal-interval | Each class has an equal range of values; in other words, the difference between the high and low value is equal for each class. You should use this method if your data is evenly distributed and you want to emphasize the difference in values between the features. | * | quantile | Each class has roughly the same number of features. If your data is evenly distributed and you want to emphasize the difference in relative position between features, you should use the quantile classification method. If, for example, the point values are divided into five classes, points in the highest class would fall into the top fifth of all points. | * | standard-deviation | Class breaks are placed above and below the mean value at intervals of `1`, `0.5`, or `0.25` standard deviations until all the data values are included in a class. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ classificationMethod?: string; /** * When `classificationMethod = "standard-deviation"`, this sets the interval at which each class break should be set (e.g. `0.25`, `0.33`, `0.5`, `1`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ standardDeviationInterval?: number; /** * The minimum bounding value for the class breaks definition. Use this in conjunction with `maxValue` to generate class breaks between lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ minValue?: number; /** * The maximum bounding value for the class breaks definition. Use this in conjunction with `minValue` to generate class breaks between lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ maxValue?: number; /** * Indicates the number of classes to generate for the class breaks definition. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ numClasses?: number; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ valueExpression?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ sqlWhere?: string; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * A subset of features for which to generate the class breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) */ features?: Graphic[]; @@ -23103,31 +23103,31 @@ declare namespace __esri { /** * Object returned from the [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) method. This object describes classes generated from data in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) for a given field with a specified classification method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ export interface ClassBreaksResult extends Object { /** * An array of objects describing the class breaks generated from the [classBreaks()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#classBreaks) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ classBreaksInfos: ClassBreaksResultClassBreaksInfos[]; /** * The minimum value of features in the dataset. This will be the lower bound of the lowest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ minValue: number; /** * The maximum value of features in the dataset. This will be the upper bound of the highest class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ maxValue: number; /** * The normalization total if `normalizationType` is set to `percent-of-total` when generating class breaks with [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html#createClassBreaksRenderer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ normalizationTotal: number; @@ -23137,19 +23137,19 @@ declare namespace __esri { export interface ClassBreaksResultClassBreaksInfos extends Object { /** * The label describing the given class break for use in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ label: string; /** * The lower bound of the class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ minValue: number; /** * The upper bound of the class break. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-classBreaks.html#ClassBreaksResult) */ maxValue: number; @@ -23157,22 +23157,22 @@ declare namespace __esri { /** * Generates a histogram based on data in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) for a given field. The returned object can be used for displaying a histogram in the UI within visualization authoring applications and analytical apps that query and display statistics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) */ interface histogram { /** * Generates a histogram for data returned from a `field` in a given `layer`. The returned object can be used for displaying a histogram to the UI in visualization authoring applications and analytical apps that query and display statistics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) - * + * * @param params See the table below for details on parameters that may be passed to this function. * @param params.layer The layer for which to generate a histogram. * @param params.field The name of the numeric field for which the histogram will be generated. This property is ignored if a `valueExpression` is used. * @param params.normalizationField The field by which to normalize the values returned from the given `field`. - * @param params.classificationMethod - * The method for classifying the data. See the table below for a list of possible values. - * + * @param params.classificationMethod + * The method for classifying the data. See the table below for a list of possible values. + * * | Possible Value | Description | * |---------------|------------ | * | natural-breaks | Data values that cluster are placed into a single class. Class breaks occur where gaps exist between clusters. You should use this method if your data is unevenly distributed; that is, many features have the same or similar values and there are gaps between groups of values. | @@ -23188,7 +23188,7 @@ declare namespace __esri { * @param params.sqlWhere A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. * @param params.view A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * @param params.features A subset of features for which to generate the histogram. - * + * */ histogram(params: histogramHistogramParams): IPromise; } @@ -23201,89 +23201,89 @@ declare namespace __esri { export interface histogramHistogramParams extends Object { /** * The layer for which to generate a histogram. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ layer: FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer; /** * The name of the numeric field for which the histogram will be generated. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ field?: string; /** * The field by which to normalize the values returned from the given `field`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ normalizationField?: string; /** - * The method for classifying the data. See the table below for a list of possible values. - * + * The method for classifying the data. See the table below for a list of possible values. + * * | Possible Value | Description | * |---------------|------------ | * | natural-breaks | Data values that cluster are placed into a single class. Class breaks occur where gaps exist between clusters. You should use this method if your data is unevenly distributed; that is, many features have the same or similar values and there are gaps between groups of values. | * | equal-interval | Each class has an equal range of values; in other words, the difference between the high and low value is equal for each class. You should use this method if your data is evenly distributed and you want to emphasize the difference in values between the features. | * | quantile | Each class has roughly the same number of features. If your data is evenly distributed and you want to emphasize the difference in relative position between features, you should use the quantile classification method. If, for example, the point values are divided into five classes, points in the highest class would fall into the top fifth of all points. | * | standard-deviation | Class breaks are placed above and below the mean value at intervals of `1`, `0.5`, or `0.25` standard deviations until all the data values are included in a class. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ classificationMethod?: string; /** * When `classificationMethod = "standard-deviation"`, this sets the interval at which each class break should be set (e.g. `0.25`, `0.33`, `0.5`, `1`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ standardDeviationInterval?: number; /** * The minimum bounding value for the histogram. Use this in conjunction with `maxValue` to generate a histogram between custom lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ minValue?: number; /** * The maximum bounding value for the histogram. Use this in conjunction with `minValue` to generate a histogram between custom lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ maxValue?: number; /** * Indicates the number of classes to generate for the histogram. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) - * + * * @default 10 */ numBins?: number; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ valueExpression?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ sqlWhere?: string; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * A subset of features for which to generate the histogram. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) */ features?: Graphic[]; @@ -23291,25 +23291,25 @@ declare namespace __esri { /** * The result returned from the [histogram()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#histogram) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ export interface HistogramResult extends Object { /** * An array of objects representing each bin in the histogram. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ bins: HistogramResultBins[]; /** * The minimum value returned by the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ minValue: number; /** * The maximum value returned by the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ maxValue: number; @@ -23319,19 +23319,19 @@ declare namespace __esri { export interface HistogramResultBins extends Object { /** * The number of features that are contained between the indicated `minValue` and `maxValue`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ count: number; /** * The minimum value of the bin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ minValue: number; /** * The maximum value of the bin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html#HistogramResult) */ maxValue: number; @@ -23339,15 +23339,15 @@ declare namespace __esri { /** * Function for generating attribute statistics in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on values returned from a given field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) */ interface summaryStatistics { /** * Returns an object containing various statistics describing a set of values returned from a field (or expression) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) - * + * * @param params See the table below for details of each parameter. * @param params.layer The layer from which to generate statistics for the given `field`. * @param params.field The name of the numeric field for which the summary statistics will be generated. This property is ignored if a `valueExpression` is used. @@ -23359,7 +23359,7 @@ declare namespace __esri { * @param params.maxValue The maximum bounding value for the statistics calculation. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. * @param params.view A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * @param params.features A subset of features for which to calculate the statistics. - * + * */ summaryStatistics(params: summaryStatisticsSummaryStatisticsParams): IPromise; } @@ -23370,49 +23370,49 @@ declare namespace __esri { /** * The statistics returned from the [summaryStatistics()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ export interface SummaryStatisticsResult extends Object { /** * The average of all values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ avg: number; /** * The number of features evaluated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ count: number; /** * The maximum of all values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ max: number; /** * The minimum of all values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ min: number; /** * The standard deviation calculated from values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ stddev: number; /** * The sum of all values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ sum: number; /** * The calculated variance from all values returned from the field or expression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult) */ variance: number; @@ -23422,61 +23422,61 @@ declare namespace __esri { export interface summaryStatisticsSummaryStatisticsParams extends Object { /** * The layer from which to generate statistics for the given `field`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ layer: FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer; /** * The name of the numeric field for which the summary statistics will be generated. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ valueExpression?: string; /** * A SQL expression evaluating to a number. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ sqlWhere?: string; /** * The field by which to normalize the values returned from the given `field`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ normalizationField?: string; /** * The minimum bounding value for the statistics calculation. Use this in conjunction with `maxValue` to generate statistics between lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ minValue?: number; /** * The maximum bounding value for the statistics calculation. Use this in conjunction with `minValue` to generate statistics between lower and upper bounds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ maxValue?: number; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * A subset of features for which to calculate the statistics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html#summaryStatistics) */ features?: Graphic[]; @@ -23484,15 +23484,15 @@ declare namespace __esri { /** * A function that queries for unique values from a field in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html) */ interface uniqueValues { /** * Returns an object containing an array of unique values queried from a given field (or values returned from an expression) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) along with the total count of features that belong to the given category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) - * + * * @param params See the table below for details of each parameter. * @param params.layer The layer from which to query for unique values. * @param params.field The name of the numeric or string field from which the unique values will be obtained. This property is ignored if a `valueExpression` is used. @@ -23502,7 +23502,7 @@ declare namespace __esri { * @param params.returnAllCodedValues Indicates that all domain codes should be returned if the given field has domain values. * @param params.view A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. * @param params.features A subset of features for which to generate the unique values. - * + * */ uniqueValues(params: uniqueValuesUniqueValuesParams): IPromise; } @@ -23513,13 +23513,13 @@ declare namespace __esri { /** * An object that contains the unique values returned from the [uniqueValues()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) query of a layer's field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ export interface UniqueValuesResult extends Object { /** * An array of objects, each containing a unique value/type/category present in the field specified in the [uniqueValues()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) query. See table below for the specification of each object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ uniqueValueInfos: UniqueValuesResultUniqueValueInfos[]; @@ -23529,49 +23529,49 @@ declare namespace __esri { export interface uniqueValuesUniqueValuesParams extends Object { /** * The layer from which to query for unique values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ layer: FeatureLayer | SceneLayer | CSVLayer | PointCloudLayer; /** * The name of the numeric or string field from which the unique values will be obtained. This property is ignored if a `valueExpression` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ field?: string; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression that returns a number or string. This expression can reference field values using the `$feature` global variable. This property overrides the `field` property and therefore is used instead of an input `field` value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ valueExpression?: string; /** * A SQL expression evaluating to a number or string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ sqlExpression?: string; /** * A SQL where clause used to filter features for the statistics query. For example, this is useful in situations where you want to avoid dividing by zero as is the case with creating a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ sqlWhere?: string; /** * Indicates that all domain codes should be returned if the given field has domain values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ returnAllCodedValues?: boolean; /** * A [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) or [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance is required when a `valueExpression` is specified. - * + * * [Read more...](global.html) */ view?: View; /** * A subset of features for which to generate the unique values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#uniqueValues) */ features?: Graphic[]; @@ -23581,13 +23581,13 @@ declare namespace __esri { export interface UniqueValuesResultUniqueValueInfos extends Object { /** * A unique value representing a type or category of features in the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ value: string | number; /** * The number of features assigned the given `value` (or belonging to the given category). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-uniqueValues.html#UniqueValuesResult) */ count: number; @@ -23597,46 +23597,46 @@ declare namespace __esri { interface symbologyColor { /** * Clones a color scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#cloneScheme) - * + * * @param scheme The color scheme object to clone. - * + * */ cloneScheme(scheme: ColorScheme): ColorScheme; /** * Flips the colors in reverse order of the input color scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#flipColors) - * + * * @param scheme The color scheme to reverse. - * + * */ flipColors(scheme: ColorScheme): ColorScheme; /** * Returns all schemes matching the given color ramp. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getMatchingSchemes) - * + * * @param theme The name of the theme from which to get color schemes. * @param colors An array of colors used to match with schemes for the given theme. * @param geometryType The geometry type of the layer for which the color scheme will be applied. * @param worldScale Indicates whether 3D volumetric symbols will be used in the visualization. * @param view The [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance used to calculate the suggested sizes of the symbols. This is required for 3D visualizations. - * + * */ getMatchingSchemes(theme: string, colors: Color[], geometryType: string, worldScale?: boolean, view?: SceneView): ColorScheme[]; /** * Returns a primary scheme and secondary schemes defining symbol properties for data-driven color visualizions in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). The `basemap` parameter determines the color schemes of the graphics used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol colors for visualizing features against the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * @param params.theme + * @param params.theme * The theme determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | @@ -23645,16 +23645,16 @@ declare namespace __esri { * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * */ getSchemes(params: colorGetSchemesParams): ColorSchemes; /** * Returns metadata for the available themes. If a `basemap` is provided, returns themes that look best with the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getThemes) - * + * * @param basemap The [Esri basemap string](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) or object that will be used with the returned theme(s). - * + * */ getThemes(basemap?: string | Basemap): any[]; } @@ -23665,39 +23665,39 @@ declare namespace __esri { export interface colorGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol colors for visualizing features against the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) */ geometryType: string; /** * The theme determines which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) */ theme: string; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) */ worldScale?: boolean; @@ -23705,58 +23705,58 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize features with attribute data-driven color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorScheme) */ export type ColorScheme = ColorSchemeForPoint | ColorSchemeForPolyline | ColorSchemeForPolygon | ColorSchemeForMesh; /** * Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ export interface ColorSchemeForMesh extends Object { /** * The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: `//`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colorsForClassBreaks: ColorSchemeForMeshColorsForClassBreaks[]; /** * The opacity of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ opacity: number; @@ -23764,63 +23764,63 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize point features with attribute data-driven color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ export interface ColorSchemeForPoint extends Object { /** * The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: `//`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colorsForClassBreaks: ColorSchemeForPointColorsForClassBreaks[]; /** * Properties for defining the outline of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ outline: ColorSchemeForPointOutline; /** * The default size of the symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ size: number; /** * The opacity of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ opacity: number; @@ -23828,57 +23828,57 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ export interface ColorSchemeForPolygon extends Object { /** * The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: `//`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colorsForClassBreaks: ColorSchemeForPolygonColorsForClassBreaks[]; /** * Properties for defining the outline of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ outline: ColorSchemeForPolygonOutline; /** * The opacity of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ opacity: number; @@ -23886,57 +23886,57 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ export interface ColorSchemeForPolyline extends Object { /** * The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: `//`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ id: string; /** * Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below. - * + * * | Value | Description | Example | * | ----- | ----------- | ------- | * | high-to-low | High values are emphasized with strong colors. | ![high-to-low](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-high-to-low.png) | * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-above-and-below.png) | * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-centered-on.png) | * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/sm-extremes.png) | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ theme: string; /** * The continuous color ramp that will be applied to the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colors: Color[]; /** * The color of the symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ noDataColor: Color; /** * Predefined classed color schemes to use for the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colorsForClassBreaks: ColorSchemeForPolylineColorsForClassBreaks[]; /** * The default width of the symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ width: number; /** * The opacity of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ opacity: number; @@ -23944,25 +23944,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemes) */ export interface ColorSchemes extends Object { /** * The color scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemes) */ primaryScheme: ColorScheme; /** * Additional color schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemes) */ secondarySchemes: ColorScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemes) */ basemapId: string; @@ -23972,13 +23972,13 @@ declare namespace __esri { export interface ColorSchemeForMeshColorsForClassBreaks extends Object { /** * An array of hex color strings. Each color is assigned to a specific break in classed color visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ colors: Color[]; /** * The number of classes used in the classed color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForMesh) */ numClasses: number; @@ -23988,13 +23988,13 @@ declare namespace __esri { export interface ColorSchemeForPointColorsForClassBreaks extends Object { /** * An array of hex color strings. Each color is assigned to a specific break in classed color visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ colors: Color[]; /** * The number of classes used in the classed color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ numClasses: number; @@ -24004,13 +24004,13 @@ declare namespace __esri { export interface ColorSchemeForPointOutline extends Object { /** * The outline color of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ color: Color; /** * The width of the symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPoint) */ width: number; @@ -24020,13 +24020,13 @@ declare namespace __esri { export interface ColorSchemeForPolygonColorsForClassBreaks extends Object { /** * An array of hex color strings. Each color is assigned to a specific break in classed color visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ colors: Color[]; /** * The number of classes used in the classed color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ numClasses: number; @@ -24036,13 +24036,13 @@ declare namespace __esri { export interface ColorSchemeForPolygonOutline extends Object { /** * The outline color of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ color: Color; /** * The width of the symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolygon) */ width: number; @@ -24052,13 +24052,13 @@ declare namespace __esri { export interface ColorSchemeForPolylineColorsForClassBreaks extends Object { /** * An array of hex color strings. Each color is assigned to a specific break in classed color visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ colors: Color[]; /** * The number of classes used in the classed color visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-color.html#ColorSchemeForPolyline) */ numClasses: number; @@ -24068,24 +24068,24 @@ declare namespace __esri { interface symbologyLocation { /** * Clones a location scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#cloneScheme) - * + * * @param scheme The location scheme object to clone. - * + * */ cloneScheme(scheme: LocationScheme): LocationScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for location-only visualizions in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html). The `basemap` parameter determines the color of the graphics used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features on top of the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * */ getSchemes(params: locationGetSchemesParams): LocationSchemes; } @@ -24096,25 +24096,25 @@ declare namespace __esri { export interface locationGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features on top of the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#getSchemes) */ geometryType: string; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#getSchemes) */ worldScale?: boolean; @@ -24122,26 +24122,26 @@ declare namespace __esri { /** * Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationScheme) */ export type LocationScheme = LocationSchemeForPoint | LocationSchemeForPolyline | LocationSchemeForPolygon | LocationSchemeForMesh; /** * Properties defining the location-only symbology scheme used to visualize mesh features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForMesh) */ export interface LocationSchemeForMesh extends Object { /** * The color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForMesh) */ color: Color; /** * The opacity of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForMesh) */ opacity: number; @@ -24149,31 +24149,31 @@ declare namespace __esri { /** * Properties defining the location-only symbology scheme used to visualize point features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ export interface LocationSchemeForPoint extends Object { /** * The fill color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ color: Color; /** * Properties for defining the outline of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ outline: LocationSchemeForPointOutline; /** * The size of the marker symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ size: number; /** * The opacity of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ opacity: number; @@ -24181,25 +24181,25 @@ declare namespace __esri { /** * Properties defining the location-only symbology scheme used to visualize polygon features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ export interface LocationSchemeForPolygon extends Object { /** * The color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ color: Color; /** * Properties for defining the outline of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ outline: LocationSchemeForPolygonOutline; /** * The opacity of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ opacity: number; @@ -24207,25 +24207,25 @@ declare namespace __esri { /** * Properties defining the location-only symbology scheme used to visualize polyline features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ export interface LocationSchemeForPolyline extends Object { /** * The color of the line symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ color: Color; /** * The width of the line symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ width: number; /** * The opacity of the line symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolyline) */ opacity: number; @@ -24233,25 +24233,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemes) */ export interface LocationSchemes extends Object { /** * The location scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemes) */ primaryScheme: LocationScheme; /** * Additional location schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemes) */ secondarySchemes: LocationScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemes) */ basemapId: string; @@ -24261,13 +24261,13 @@ declare namespace __esri { export interface LocationSchemeForPointOutline extends Object { /** * The outline color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPoint) */ width: number; @@ -24277,13 +24277,13 @@ declare namespace __esri { export interface LocationSchemeForPolygonOutline extends Object { /** * The outline color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ color: Color; /** * The width of the fill symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-location.html#LocationSchemeForPolygon) */ width: number; @@ -24293,18 +24293,18 @@ declare namespace __esri { interface symbologyPredominance { /** * Clones a predominance scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#cloneScheme) - * + * * @param scheme The predominance scheme object to clone. - * + * */ cloneScheme(scheme: PredominanceScheme): PredominanceScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for predominance-based data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The `basemap` parameter determines the color of the symbols used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh @@ -24312,7 +24312,7 @@ declare namespace __esri { * @param params.theme Determines which set of primary and secondary color schemes to return **Possible Values:** default * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * */ getSchemes(params: predominanceGetSchemesParams): PredominanceSchemes; } @@ -24323,39 +24323,39 @@ declare namespace __esri { export interface predominanceGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) */ geometryType: string; /** * The number of unique values to include in the predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) */ numColors: number; /** * Determines which set of primary and secondary color schemes to return **Possible Values:** default - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) - * + * * @default default */ theme?: string; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; @@ -24363,32 +24363,32 @@ declare namespace __esri { /** * Defines the symbology scheme used to visualize predominance based on the layer's geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceScheme) */ export type PredominanceScheme = PredominanceSchemeForPoint | PredominanceSchemeForPolyline | PredominanceSchemeForPolygon | PredominanceSchemeForMesh; /** * Properties defining the symbology scheme used to visualize predominance for mesh features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ export interface PredominanceSchemeForMesh extends Object { /** * The fill colors of the mesh symbols used for each category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ noDataColor: Color; /** * The opacity of the symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh) */ opacity: number; @@ -24396,37 +24396,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize predominance for point features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ export interface PredominanceSchemeForPoint extends Object { /** * The fill colors of the point symbols used for each category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ colors: Color[]; /** * The color of the point symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ outline: PredominanceSchemeForPointOutline; /** * The opacity of the point symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ sizeScheme: SizeSchemeForPoint; @@ -24434,37 +24434,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize predominance for polygon features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ export interface PredominanceSchemeForPolygon extends Object { /** * The fill colors of the polygon symbols used for each category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ outline: PredominanceSchemeForPolygonOutline; /** * The opacity of the symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ sizeScheme: SizeSchemeForPolygon; @@ -24472,37 +24472,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize predominance for polyline features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ export interface PredominanceSchemeForPolyline extends Object { /** * The colors of the line symbols used for each category. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ colors: Color[]; /** * The color of the line symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ width: number; /** * The opacity of the line symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ opacity: number; /** * The scheme defining the size visual variable if included in a predominance visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline) */ sizeScheme: SizeSchemeForPolyline; @@ -24510,25 +24510,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemes) */ export interface PredominanceSchemes extends Object { /** * The predominance scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemes) */ primaryScheme: PredominanceScheme; /** * Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemes) */ secondarySchemes: PredominanceScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemes) */ basemapId: string; @@ -24538,13 +24538,13 @@ declare namespace __esri { export interface PredominanceSchemeForPointOutline extends Object { /** * The outline color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ color: Color; /** * The width of the marker symbol in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint) */ width: number; @@ -24554,13 +24554,13 @@ declare namespace __esri { export interface PredominanceSchemeForPolygonOutline extends Object { /** * The outline color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ color: Color; /** * The width of the fill symbol's outline in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon) */ width: number; @@ -24570,25 +24570,25 @@ declare namespace __esri { interface symbologyRelationship { /** * Clones a relationship (bivariate color) scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#cloneScheme) - * + * * @param scheme The relationship scheme object to clone. - * + * */ cloneScheme(scheme: RelationshipScheme): RelationshipScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth) data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The `basemap` parameter determines the color of the symbols used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol colors for visualizing features with the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh * @param params.theme Determines which set of primary and secondary color schemes to return **Possible Values:** default * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * */ getSchemes(params: relationshipGetSchemesParams): RelationshipSchemes; } @@ -24599,33 +24599,33 @@ declare namespace __esri { export interface relationshipGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol colors for visualizing features with the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) */ geometryType: string; /** * Determines which set of primary and secondary color schemes to return **Possible Values:** default - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) - * + * * @default default */ theme?: string; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; @@ -24633,38 +24633,38 @@ declare namespace __esri { /** * Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipScheme) */ export type RelationshipScheme = RelationshipSchemeForPoint | RelationshipSchemeForPolyline | RelationshipSchemeForPolygon | RelationshipSchemeForMesh; /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ export interface RelationshipSchemeForMesh extends Object { /** * The ID uniquely identifying the color scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ colorsForClassBreaks: RelationshipSchemeForMeshColorsForClassBreaks[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ noDataColor: Color; /** * The opacity of the fill symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ opacity: number; @@ -24672,43 +24672,43 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ export interface RelationshipSchemeForPoint extends Object { /** * The ID uniquely identifying the color scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ colorsForClassBreaks: RelationshipSchemeForPointColorsForClassBreaks[]; /** * The color of the point symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ outline: RelationshipSchemeForPointOutline; /** * The opacity of the point symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ opacity: number; /** * The size of the point symbol in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ size: number; @@ -24716,37 +24716,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ export interface RelationshipSchemeForPolygon extends Object { /** * The ID uniquely identifying the color scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ colorsForClassBreaks: RelationshipSchemeForPolygonColorsForClassBreaks[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ outline: RelationshipSchemeForPolygonOutline; /** * The opacity of the fill symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ opacity: number; @@ -24754,37 +24754,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ export interface RelationshipSchemeForPolyline extends Object { /** * The ID uniquely identifying the color scheme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ id: string; /** * Defines the colors to use in each bin of the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ colorsForClassBreaks: RelationshipSchemeForPolylineColorsForClassBreaks[]; /** * The color of the line symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ noDataColor: Color; /** * The opacity of the line symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ opacity: number; /** * The width of the line symbol in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ width: number; @@ -24792,25 +24792,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemes) */ export interface RelationshipSchemes extends Object { /** * The relationship scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemes) */ primaryScheme: RelationshipScheme; /** * Additional relationship schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemes) */ secondarySchemes: RelationshipScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemes) */ basemapId: string; @@ -24820,13 +24820,13 @@ declare namespace __esri { export interface RelationshipSchemeForMeshColorsForClassBreaks extends Object { /** * The colors of the fill symbols used for each bin in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh) */ numClasses: number; @@ -24836,13 +24836,13 @@ declare namespace __esri { export interface RelationshipSchemeForPointColorsForClassBreaks extends Object { /** * The fill colors of the point symbols used for each bin in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ numClasses: number; @@ -24852,13 +24852,13 @@ declare namespace __esri { export interface RelationshipSchemeForPointOutline extends Object { /** * The outline color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ color: Color; /** * The width of the outline in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint) */ width: number; @@ -24868,13 +24868,13 @@ declare namespace __esri { export interface RelationshipSchemeForPolygonColorsForClassBreaks extends Object { /** * The colors of the fill symbols used for each bin in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ numClasses: number; @@ -24884,13 +24884,13 @@ declare namespace __esri { export interface RelationshipSchemeForPolygonOutline extends Object { /** * The outline color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ color: Color; /** * The width of the outline in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon) */ width: number; @@ -24900,13 +24900,13 @@ declare namespace __esri { export interface RelationshipSchemeForPolylineColorsForClassBreaks extends Object { /** * The colors of the line symbols used for each bin in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ colors: Color[][]; /** * The number of breaks (rows/columns) for each variable in the relationship visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline) */ numClasses: number; @@ -24916,24 +24916,24 @@ declare namespace __esri { interface symbologySize { /** * Clones a size scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#cloneScheme) - * + * * @param scheme The SizeScheme object to clone. - * + * */ cloneScheme(scheme: SizeScheme): SizeScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for size-based data-driven visualizions in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). The `basemap` parameter determines the color of the graphics used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features against the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * */ getSchemes(params: sizeGetSchemesParams): SizeSchemes; } @@ -24944,25 +24944,25 @@ declare namespace __esri { export interface sizeGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features against the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#getSchemes) */ geometryType: string; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#getSchemes) */ worldScale?: boolean; @@ -24970,62 +24970,62 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize features with attribute data-driven size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeScheme) */ export type SizeScheme = SizeSchemeForPoint | SizeSchemeForPolyline | SizeSchemeForPolygon; /** * Properties defining the symbology scheme used to visualize point features driven by attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ export interface SizeSchemeForPoint extends Object { /** * The fill color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ color: Color; /** * The color of the marker symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ outline: SizeSchemeForPointOutline; /** * The default size of the marker symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ size: number; /** * The size of the marker symbol (in pixels or points) used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ noDataSize: number; /** * The minimum size of a marker symbol in pixels or points representing features with low data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ minSize: number; /** * The maximum size of a marker symbol in pixels or points representing features with high data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ maxSize: number; /** * The opacity of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ opacity: number; @@ -25033,25 +25033,25 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polygon features driven by attribute data. When visualized by size, polygons are represented with marker symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ export interface SizeSchemeForPolygon extends Object { /** * The scheme defining the symbology of the marker symbol used to represent polygon features by size. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ marker: SizeSchemeForPoint; /** * The schema defining the backgound symbol of the feature. This is a fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ background: SizeSchemeForPolygonBackground; /** * The opacity of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ opacity: number; @@ -25059,49 +25059,49 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polyline features driven by attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ export interface SizeSchemeForPolyline extends Object { /** * The color of the line symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ color: Color; /** * The color of the line symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ width: number; /** * The width of the line symbol in pixels or points used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ noDataWidth: number; /** * The minimum width of a line symbol in pixels or points representing features with low data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ minWidth: number; /** * The maximum width of a line symbol in pixels or points representing features with high data values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ maxWidth: number; /** * The opacity of the line symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolyline) */ opacity: number; @@ -25109,25 +25109,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemes) */ export interface SizeSchemes extends Object { /** * The size scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemes) */ primaryScheme: SizeScheme; /** * Additional size schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemes) */ secondarySchemes: SizeScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemes) */ basemapId: string; @@ -25137,13 +25137,13 @@ declare namespace __esri { export interface SizeSchemeForPointOutline extends Object { /** * The outline color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPoint) */ width: number; @@ -25153,13 +25153,13 @@ declare namespace __esri { export interface SizeSchemeForPolygonBackground extends Object { /** * The color of the fill symbol representing the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ color: Color; /** * Properties for defining the outline of the background fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ outline: SizeSchemeForPolygonBackgroundOutline; @@ -25169,13 +25169,13 @@ declare namespace __esri { export interface SizeSchemeForPolygonBackgroundOutline extends Object { /** * The outline color of the background fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ color: Color; /** * The width of the background fill symbol's outline in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-size.html#SizeSchemeForPolygon) */ width: number; @@ -25185,25 +25185,25 @@ declare namespace __esri { interface symbologyType { /** * Clones a type scheme object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#cloneScheme) - * + * * @param scheme The type scheme object to clone. - * + * */ cloneScheme(scheme: TypeScheme): TypeScheme; /** * Returns a primary scheme and secondary schemes defining symbol properties for type-based data-driven visualizations in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). The `basemap` parameter determines the color of the graphics used to visualize each feature. The `geometryType` determines which type of symbol to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) - * + * * @param params See the table below for details of each parameter that may be passed to this function. * @param params.basemap The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap. * @param params.geometryType The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh * @param params.theme Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. when the `CLASS_CODE` field is driving the visualization in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html)), or to return the other default primary schemes used in other unique value renderers generated for non-point cloud layer types. **Possible Values:** point-cloud-class | default * @param params.worldScale Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. * @param params.view The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * */ getSchemes(params: typeGetSchemesParams): TypeSchemes; } @@ -25214,33 +25214,33 @@ declare namespace __esri { export interface typeGetSchemesParams extends Object { /** * The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) */ basemap: string | Basemap; /** * The geometry type of the features to visualize. **Possible Values:** point | multipoint | polyline | polygon | mesh - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) */ geometryType: string; /** * Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. when the `CLASS_CODE` field is driving the visualization in a [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html)), or to return the other default primary schemes used in other unique value renderers generated for non-point cloud layer types. **Possible Values:** point-cloud-class | default - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) - * + * * @default default */ theme?: string; /** * Indicates if the size units of the scheme will be in meters. This should be `true` when the scheme is intended for 3D volumetric symbology. A `view` must be provided if this property is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) */ worldScale?: boolean; /** * The SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols. - * + * * [Read more...](global.html) */ view?: SceneView; @@ -25248,32 +25248,32 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize features with attribute data-driven types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeScheme) */ export type TypeScheme = TypeSchemeForPoint | TypeSchemeForPolyline | TypeSchemeForPolygon | TypeSchemeForMesh; /** * Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForMesh) */ export interface TypeSchemeForMesh extends Object { /** * The fill colors of the symbols comprising the theme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForMesh) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForMesh) */ noDataColor: Color; /** * The opacity of the symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForMesh) */ opacity: number; @@ -25281,37 +25281,37 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize point features driven by type-based attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ export interface TypeSchemeForPoint extends Object { /** * The fill colors of the point symbols comprising the theme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ colors: Color[]; /** * The color of the point symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ noDataColor: Color; /** * Properties for defining the outline of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ outline: TypeSchemeForPointOutline; /** * The default size of the point symbol in pixels, points, or real-world units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ size: number; /** * The opacity of the point symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ opacity: number; @@ -25319,31 +25319,31 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ export interface TypeSchemeForPolygon extends Object { /** * The fill colors of the symbols comprising the theme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ colors: Color[]; /** * The color of the fill symbol used to indicate features with no data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ noDataColor: Color; /** * Properties for defining the outline of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ outline: TypeSchemeForPolygonOutline; /** * The opacity of the symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ opacity: number; @@ -25351,31 +25351,31 @@ declare namespace __esri { /** * Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ export interface TypeSchemeForPolyline extends Object { /** * The colors of the line symbols comprising the theme. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ colors: Color[]; /** * The color of the line symbol used to indicate features with no data and features that are out of range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ noDataColor: Color; /** * The default width of the line symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ width: number; /** * The opacity of the line symbol (0 - 1). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolyline) */ opacity: number; @@ -25383,25 +25383,25 @@ declare namespace __esri { /** * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#getSchemes) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemes) */ export interface TypeSchemes extends Object { /** * The type scheme best suited for the given basemap and geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemes) */ primaryScheme: TypeScheme; /** * Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemes) */ secondarySchemes: TypeScheme[]; /** * The ID of the basemap associated with the given schemes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemes) */ basemapId: string; @@ -25411,13 +25411,13 @@ declare namespace __esri { export interface TypeSchemeForPointOutline extends Object { /** * The outline color of the marker symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ color: Color; /** * The width of the marker symbol in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPoint) */ width: number; @@ -25427,13 +25427,13 @@ declare namespace __esri { export interface TypeSchemeForPolygonOutline extends Object { /** * The outline color of the fill symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ color: Color; /** * The width of the fill symbol's outline in pixels or points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-symbology-type.html#TypeSchemeForPolygon) */ width: number; @@ -25442,71 +25442,71 @@ declare namespace __esri { interface AuthoringInfo extends Accessor, JSONSupport { /** * Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions. **Possible Values:** equal-interval | manual | natural-breaks | quantile | standard-deviation - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#classificationMethod) */ classificationMethod: string; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html) along with [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2). In the default visualization, the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field1: AuthoringInfoField1; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html) along with [field1](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1). In the default visualization, the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field2: AuthoringInfoField2; /** * An array of string values representing field names used for creating a [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fields) */ fields: string[]; /** * The focus of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html). This determines the orientation of the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#focus) */ focus: string; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. **Possible Values:** inches | feet | yards | miles | nautical-miles | millimeters | centimeters | decimeters | meters | kilometers | decimal-degrees - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#lengthUnit) */ lengthUnit: string; /** * The number of classes used to classify each field of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html). This determines the number of categories in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#numClasses) */ numClasses: number; /** * Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the `standard-deviation` classification method. **Possible Values:** 0.25 | 0.33 | 0.5 | 1 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#standardDeviationInterval) */ standardDeviationInterval: number; /** * Indicates the renderer type generated from one of the Smart Mapping functions. **Possible Values:** class-breaks-size | class-breaks-color | classed-color | classed-size | predominance | relationship | univariate-color-size - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#type) */ type: string; /** * Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#visualVariables) */ visualVariables: AuthoringInfoVisualVariable[]; /** * Creates a deep clone of the instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#clone) - * - * + * + * */ clone(): AuthoringInfo; } @@ -25524,61 +25524,61 @@ declare namespace __esri { interface AuthoringInfoProperties { /** * Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions. **Possible Values:** equal-interval | manual | natural-breaks | quantile | standard-deviation - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#classificationMethod) */ classificationMethod?: string; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html) along with [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2). In the default visualization, the values of this field are rendered along the vertical axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field1?: AuthoringInfoField1; /** * A numeric field used for generating a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html) along with [field1](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1). In the default visualization, the values of this field are rendered along the horizontal axis of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field2?: AuthoringInfoField2; /** * An array of string values representing field names used for creating a [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-predominance.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#fields) */ fields?: string[]; /** * The focus of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html). This determines the orientation of the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#focus) */ focus?: string; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. **Possible Values:** inches | feet | yards | miles | nautical-miles | millimeters | centimeters | decimeters | meters | kilometers | decimal-degrees - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#lengthUnit) */ lengthUnit?: string; /** * The number of classes used to classify each field of a [relationship renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-relationship.html). This determines the number of categories in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#numClasses) */ numClasses?: number; /** * Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the `standard-deviation` classification method. **Possible Values:** 0.25 | 0.33 | 0.5 | 1 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#standardDeviationInterval) */ standardDeviationInterval?: number; /** * Indicates the renderer type generated from one of the Smart Mapping functions. **Possible Values:** class-breaks-size | class-breaks-color | classed-color | classed-size | predominance | relationship | univariate-color-size - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#type) */ type?: string; /** * Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#visualVariables) */ visualVariables?: AuthoringInfoVisualVariableProperties[]; @@ -25588,25 +25588,25 @@ declare namespace __esri { export interface AuthoringInfoField1 extends Object { /** * The name of a numeric field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ field: string; /** * The name of a numeric field used to normalize the given `field`. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field1) */ minValue?: number; @@ -25616,25 +25616,25 @@ declare namespace __esri { export interface AuthoringInfoField2 extends Object { /** * The name of a numeric field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ field: string; /** * The name of a numeric field used to normalize the given `field`. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ normalizationField?: string; /** * The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ maxValue?: number; /** * The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#field2) */ minValue?: number; @@ -25643,65 +25643,65 @@ declare namespace __esri { interface AuthoringInfoVisualVariable extends Accessor, JSONSupport { /** * If an age or timeline renderer was generated, indicates the end time of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#endTime) */ endTime: string | number; /** * Indicates the field name used for generating the data-driven visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#field) */ field: string; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue) */ maxSliderValue: number; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue) */ minSliderValue: number; /** * If an age or timeline renderer was generated, indicates the start time of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#startTime) */ startTime: string | number; /** * If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made. **Possible Values:** percent | percent-of-total | ratio - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#style) */ style: string; /** * Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions. **Possible Values:** above-and-below | centered-on | extremes | high-to-low - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#theme) */ theme: string; /** * The type of visual variable generated. **Possible Values:** color | size | opacity - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#type) */ type: string; /** * If an age or timeline renderer was generated, indicates the time units used. **Possible Values:** seconds | minutes | hours | days | months | years - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#units) */ units: string; /** * Creates a deep clone of the instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#clone) - * - * + * + * */ clone(): AuthoringInfoVisualVariable; } @@ -25719,55 +25719,55 @@ declare namespace __esri { interface AuthoringInfoVisualVariableProperties { /** * If an age or timeline renderer was generated, indicates the end time of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#endTime) */ endTime?: string | number; /** * Indicates the field name used for generating the data-driven visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#field) */ field?: string; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue) */ maxSliderValue?: number; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue) */ minSliderValue?: number; /** * If an age or timeline renderer was generated, indicates the start time of the visualization. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#startTime) */ startTime?: string | number; /** * If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made. **Possible Values:** percent | percent-of-total | ratio - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#style) */ style?: string; /** * Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions. **Possible Values:** above-and-below | centered-on | extremes | high-to-low - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#theme) */ theme?: string; /** * The type of visual variable generated. **Possible Values:** color | size | opacity - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#type) */ type?: string; /** * If an age or timeline renderer was generated, indicates the time units used. **Possible Values:** seconds | minutes | hours | days | months | years - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfoVisualVariable.html#units) */ units?: string; @@ -25776,23 +25776,23 @@ declare namespace __esri { interface HeatmapColorStop extends Accessor { /** * The color to shade a given pixel based on its calculated pixel intensity [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color) */ color: Color; /** * The ratio of a pixel's intensity value to the [minPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minPixelIntensity) of the renderer. The ratio of each pixel is matched to the corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) */ ratio: number; /** * Creates a deep clone of the color stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#clone) - * - * + * + * */ clone(): HeatmapColorStop; } @@ -25808,13 +25808,13 @@ declare namespace __esri { interface HeatmapColorStopProperties { /** * The color to shade a given pixel based on its calculated pixel intensity [ratio](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color) */ color?: Color | number[] | string; /** * The ratio of a pixel's intensity value to the [minPixelIntensity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html#minPixelIntensity) of the renderer. The ratio of each pixel is matched to the corresponding [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#color). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-HeatmapColorStop.html#ratio) */ ratio?: number; @@ -25824,11 +25824,11 @@ declare namespace __esri { interface supportJsonUtils { /** * Creates a new instance of an appropriate [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input `json` parameter often comes from a response to a query operation in the REST API or a [toJSON()](http://pro.arcgis.com/en/pro-app/tool-reference/conversion/features-to-json.htm) method from another ArcGIS product. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for details and examples of when and how to use this function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-jsonUtils.html#fromJSON) - * + * * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/renderer-objects.htm) for examples of the structure of various input JSON objects. - * + * */ fromJSON(json: any): Renderer; } @@ -25838,31 +25838,31 @@ declare namespace __esri { interface UniqueValueRenderer extends Renderer, VisualVariablesMixin { /** * This property is only relevant When symbolizing polygon features with marker symbols (or [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html)) in the [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) of this renderer. This is usually done when adding a [SizeVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) to the [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#visualVariables)) in a bivariate visualization (color indicates a type-based value and size indicates the value of a separate numeric field). Use this property to set a background [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) (or [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html) if visualizing data in 3D) to visualize the boundaries of each polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol: FillSymbol | PolygonSymbol3D; /** * Label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol). The [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) is used to draw all features with unspecified, unmatched values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultLabel) */ defaultLabel: string; /** - * The default symbol used to draw a feature whose value is not matched or specified by the renderer. If `null`, unmatched features will not be assigned a symbol. + * The default symbol used to draw a feature whose value is not matched or specified by the renderer. If `null`, unmatched features will not be assigned a symbol. * > **Known Limitations** SceneLayers with a `mesh` [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) will display unmatching features with a generic symbol even if the `defaultSymbol` is `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) */ defaultSymbol: Symbol; /** * The name of the attribute field the renderer uses to match unique values or types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) */ field: string; /** - * If needed, specifies the name of an additional attribute field the renderer will use to match values. For example, if you specify two fields: + * If needed, specifies the name of an additional attribute field the renderer will use to match values. For example, if you specify two fields: * ```js * var renderer = { * type: "unique-value", // autocasts as new UniqueValueRenderer() @@ -25881,15 +25881,15 @@ declare namespace __esri { * ] * }; * ``` - * + * * All combinations of values of [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) and `field2` are unique values and * may have their own symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) */ field2: string; /** - * If needed, specify the name of a third attribute field the renderer will use to match values. For example, if you specify three fields: + * If needed, specify the name of a third attribute field the renderer will use to match values. For example, if you specify three fields: * ```js * var renderer = { * type: "unique-value", // autocasts as new UniqueValueRenderer() @@ -25909,84 +25909,84 @@ declare namespace __esri { * ] * }; * ``` - * + * * All combinations of values of [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field), [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2), and `field3` are unique values and * may have their own symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) */ field3: string; /** * String inserted between the values if multiple attribute fields are specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#fieldDelimiter) */ fieldDelimiter: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ legendOptions: UniqueValueRendererLegendOptions; /** * The type of Renderer. For UniqueValueRenderer this value is always `unique-value`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#type) */ readonly type: "unique-value"; /** * Each element in the array is an object that provides information about a unique value associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ uniqueValueInfos: UniqueValueRendererUniqueValueInfos[]; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to either a string or a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. This property is typically used as an alternative to [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) for data-driven visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) */ valueExpression: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) property. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpressionTitle) */ valueExpressionTitle: string; /** * Adds a unique value and symbol to the renderer. You can provide the value and its associated symbol as individual arguments or as an info object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#addUniqueValueInfo) - * + * * @param valueOrInfo The value to match. The value can be provided as an individual argument or as an [info object described in uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos). * @param symbol The symbol used to represent features matching the specified `value`. - * + * */ addUniqueValueInfo(valueOrInfo: string | number | any, symbol?: Symbol | SymbolProperties): void; /** * Creates a deep clone of the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#clone) - * - * + * + * */ clone(): UniqueValueRenderer; /** * Returns rendering and legend information (as defined by the renderer) associated with the given graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#getUniqueValueInfo) - * + * * @param graphic The graphic whose rendering and legend information will be returned. - * + * */ getUniqueValueInfo(graphic: Graphic): any; /** * Removes a unique value from the renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#removeUniqueValueInfo) - * + * * @param value Value to remove from [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos). - * + * */ removeUniqueValueInfo(value: string): void; } @@ -25994,7 +25994,7 @@ declare namespace __esri { interface UniqueValueRendererConstructor { /** * UniqueValueRenderer allows you to symbolize features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on one or more matching string attributes. This is typically done by using unique colors, fill styles, or images to represent features with equal values in a string field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) */ @@ -26008,31 +26008,31 @@ declare namespace __esri { interface UniqueValueRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * This property is only relevant When symbolizing polygon features with marker symbols (or [IconSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html)) in the [uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) of this renderer. This is usually done when adding a [SizeVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) to the [visualVariables](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#visualVariables)) in a bivariate visualization (color indicates a type-based value and size indicates the value of a separate numeric field). Use this property to set a background [FillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) (or [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html) if visualizing data in 3D) to visualize the boundaries of each polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#backgroundFillSymbol) */ backgroundFillSymbol?: FillSymbolProperties | PolygonSymbol3DProperties; /** * Label used in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) to describe features assigned the [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol). The [default symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) is used to draw all features with unspecified, unmatched values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultLabel) */ defaultLabel?: string; /** - * The default symbol used to draw a feature whose value is not matched or specified by the renderer. If `null`, unmatched features will not be assigned a symbol. + * The default symbol used to draw a feature whose value is not matched or specified by the renderer. If `null`, unmatched features will not be assigned a symbol. * > **Known Limitations** SceneLayers with a `mesh` [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) will display unmatching features with a generic symbol even if the `defaultSymbol` is `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#defaultSymbol) */ defaultSymbol?: SymbolProperties; /** * The name of the attribute field the renderer uses to match unique values or types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) */ field?: string; /** - * If needed, specifies the name of an additional attribute field the renderer will use to match values. For example, if you specify two fields: + * If needed, specifies the name of an additional attribute field the renderer will use to match values. For example, if you specify two fields: * ```js * var renderer = { * type: "unique-value", // autocasts as new UniqueValueRenderer() @@ -26051,15 +26051,15 @@ declare namespace __esri { * ] * }; * ``` - * + * * All combinations of values of [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) and `field2` are unique values and * may have their own symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2) */ field2?: string; /** - * If needed, specify the name of a third attribute field the renderer will use to match values. For example, if you specify three fields: + * If needed, specify the name of a third attribute field the renderer will use to match values. For example, if you specify three fields: * ```js * var renderer = { * type: "unique-value", // autocasts as new UniqueValueRenderer() @@ -26079,40 +26079,40 @@ declare namespace __esri { * ] * }; * ``` - * + * * All combinations of values of [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field), [field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2), and `field3` are unique values and * may have their own symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3) */ field3?: string; /** * String inserted between the values if multiple attribute fields are specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#fieldDelimiter) */ fieldDelimiter?: string; /** * An object providing options for displaying the renderer in the Legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ legendOptions?: UniqueValueRendererLegendOptions; /** * Each element in the array is an object that provides information about a unique value associated with the renderer. Each object has the following specification: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ uniqueValueInfos?: UniqueValueRendererUniqueValueInfos[]; /** * An [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression evaluating to either a string or a number. This expression can reference field values using the `$feature` global variable and perform mathematical calculations and logical evaluations at runtime. This property is typically used as an alternative to [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field) for data-driven visualizations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) */ valueExpression?: string; /** * The title identifying and describing the associated [Arcade](https://developers.arcgis.com/javascript/latest/guide/arcade/index.html) expression as defined in the [valueExpression](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpression) property. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) in the absence of a provided `title` in the [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpressionTitle) */ valueExpressionTitle?: string; @@ -26122,7 +26122,7 @@ declare namespace __esri { export interface UniqueValueRendererLegendOptions extends Object { /** * Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) and takes precedence over a [field alias](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias) or [valueExpressionTitle](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#valueExpressionTitle). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#legendOptions) */ title?: string; @@ -26132,19 +26132,19 @@ declare namespace __esri { export interface UniqueValueRendererUniqueValueInfos extends Object { /** * The unique value used to classify features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ value: string | number; /** * The symbol used to style features whose value matches `value`. This value may be autocast by specifying the symbol `type`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ symbol: Symbol; /** * Label used to describe features matched to this unique value in the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos) */ label?: string; @@ -26152,18 +26152,18 @@ declare namespace __esri { interface VisualVariablesMixin { /** - * Visual variables define the parameters for data-driven geographic visualizations of numeric data. They allow you to easily map continuous ramps of [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable), [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable), [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable), and/or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) to minimum and maximum data values of one of the layer's numeric attribute fields. Visual variables can primarily be used in two ways. **1**. Thematic mapping Visual variables allow you to easily create stunning visualizations based on thematic attributes (e.g. population, education, rank, money, magnitude, etc.) in either 2D or 3D. This is accomplished by mapping data values from a numeric field attribute to color, size, and/or opacity values. The renderer then takes over and re-sizes or shades features based on the value of the given field and its position relative to the minimum and maximum values. The sample below uses three visual variables (size, color, and opacity). [![renderer-unique-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-unique-vv.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-2d/index.html) **2**. Mapping real-world sizes The [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) visual variable can be used to visualize the true sizes of features (e.g. tree canopy, road width, building height, etc.) based on their size in the real world. This can be particularly powerful when working in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). The image below shows a layer of building footprints that uses visual variables to extrude each feature to the true height of the buildings based on data stored in an attribute field. [![renderer-vv-rw](https://developers.arcgis.com/javascript/assets/img/samples/2-extrude-height.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-buildings-3d/index.html) The `visualVariables` property of the renderer is an array of objects called "visual variables". Each object must indicate the type of visual variable to apply (e.g. color, size, opacity, rotation), the numeric field from which to drive the visualization, and the ramp of visual values to map to the data. The following list identifies each visual variable type and provides a link to the specification table of each. - * + * Visual variables define the parameters for data-driven geographic visualizations of numeric data. They allow you to easily map continuous ramps of [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable), [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable), [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable), and/or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) to minimum and maximum data values of one of the layer's numeric attribute fields. Visual variables can primarily be used in two ways. **1**. Thematic mapping Visual variables allow you to easily create stunning visualizations based on thematic attributes (e.g. population, education, rank, money, magnitude, etc.) in either 2D or 3D. This is accomplished by mapping data values from a numeric field attribute to color, size, and/or opacity values. The renderer then takes over and re-sizes or shades features based on the value of the given field and its position relative to the minimum and maximum values. The sample below uses three visual variables (size, color, and opacity). [![renderer-unique-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-unique-vv.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-2d/index.html) **2**. Mapping real-world sizes The [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) visual variable can be used to visualize the true sizes of features (e.g. tree canopy, road width, building height, etc.) based on their size in the real world. This can be particularly powerful when working in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). The image below shows a layer of building footprints that uses visual variables to extrude each feature to the true height of the buildings based on data stored in an attribute field. [![renderer-vv-rw](https://developers.arcgis.com/javascript/assets/img/samples/2-extrude-height.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-buildings-3d/index.html) The `visualVariables` property of the renderer is an array of objects called "visual variables". Each object must indicate the type of visual variable to apply (e.g. color, size, opacity, rotation), the numeric field from which to drive the visualization, and the ramp of visual values to map to the data. The following list identifies each visual variable type and provides a link to the specification table of each. + * * Type | Object Specification | Legend Example * -----|----------------------|--------------- * color | [ColorVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-color-vv.png) * size | [SizeVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-size-vv.png) * opacity | [OpacityVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-opacity-vv.png) * rotation | [RotationVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) | - - * - * See the [Visualize features with realistic 3D symbols](https://developers.arcgis.com/javascript/latest/sample-code/visualization-trees-realistic/index.html) for an example of using multiple visual variables to visualize your data. + * + * See the [Visualize features with realistic 3D symbols](https://developers.arcgis.com/javascript/latest/sample-code/visualization-trees-realistic/index.html) for an example of using multiple visual variables to visualize your data. * > **Known Limitations** Color and opacity visual variables must not have more than 8 stops and size visual variables must not have more than 6 stops. This does not apply to variables driven by view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VisualVariablesMixin.html#visualVariables) */ visualVariables: any[]; @@ -26179,18 +26179,18 @@ declare namespace __esri { interface VisualVariablesMixinProperties { /** - * Visual variables define the parameters for data-driven geographic visualizations of numeric data. They allow you to easily map continuous ramps of [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable), [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable), [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable), and/or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) to minimum and maximum data values of one of the layer's numeric attribute fields. Visual variables can primarily be used in two ways. **1**. Thematic mapping Visual variables allow you to easily create stunning visualizations based on thematic attributes (e.g. population, education, rank, money, magnitude, etc.) in either 2D or 3D. This is accomplished by mapping data values from a numeric field attribute to color, size, and/or opacity values. The renderer then takes over and re-sizes or shades features based on the value of the given field and its position relative to the minimum and maximum values. The sample below uses three visual variables (size, color, and opacity). [![renderer-unique-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-unique-vv.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-2d/index.html) **2**. Mapping real-world sizes The [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) visual variable can be used to visualize the true sizes of features (e.g. tree canopy, road width, building height, etc.) based on their size in the real world. This can be particularly powerful when working in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). The image below shows a layer of building footprints that uses visual variables to extrude each feature to the true height of the buildings based on data stored in an attribute field. [![renderer-vv-rw](https://developers.arcgis.com/javascript/assets/img/samples/2-extrude-height.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-buildings-3d/index.html) The `visualVariables` property of the renderer is an array of objects called "visual variables". Each object must indicate the type of visual variable to apply (e.g. color, size, opacity, rotation), the numeric field from which to drive the visualization, and the ramp of visual values to map to the data. The following list identifies each visual variable type and provides a link to the specification table of each. - * + * Visual variables define the parameters for data-driven geographic visualizations of numeric data. They allow you to easily map continuous ramps of [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable), [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable), [opacity](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable), and/or [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) to minimum and maximum data values of one of the layer's numeric attribute fields. Visual variables can primarily be used in two ways. **1**. Thematic mapping Visual variables allow you to easily create stunning visualizations based on thematic attributes (e.g. population, education, rank, money, magnitude, etc.) in either 2D or 3D. This is accomplished by mapping data values from a numeric field attribute to color, size, and/or opacity values. The renderer then takes over and re-sizes or shades features based on the value of the given field and its position relative to the minimum and maximum values. The sample below uses three visual variables (size, color, and opacity). [![renderer-unique-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/renderer-unique-vv.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-multivariate-2d/index.html) **2**. Mapping real-world sizes The [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) visual variable can be used to visualize the true sizes of features (e.g. tree canopy, road width, building height, etc.) based on their size in the real world. This can be particularly powerful when working in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). The image below shows a layer of building footprints that uses visual variables to extrude each feature to the true height of the buildings based on data stored in an attribute field. [![renderer-vv-rw](https://developers.arcgis.com/javascript/assets/img/samples/2-extrude-height.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-buildings-3d/index.html) The `visualVariables` property of the renderer is an array of objects called "visual variables". Each object must indicate the type of visual variable to apply (e.g. color, size, opacity, rotation), the numeric field from which to drive the visualization, and the ramp of visual values to map to the data. The following list identifies each visual variable type and provides a link to the specification table of each. + * * Type | Object Specification | Legend Example * -----|----------------------|--------------- * color | [ColorVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#ColorVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-color-vv.png) * size | [SizeVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-size-vv.png) * opacity | [OpacityVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#OpacityVisualVariable) | ![legend-color-vv](https://developers.arcgis.com/javascript/assets/img/apiref/renderers/legend-opacity-vv.png) * rotation | [RotationVisualVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#RotationVisualVariable) | - - * - * See the [Visualize features with realistic 3D symbols](https://developers.arcgis.com/javascript/latest/sample-code/visualization-trees-realistic/index.html) for an example of using multiple visual variables to visualize your data. + * + * See the [Visualize features with realistic 3D symbols](https://developers.arcgis.com/javascript/latest/sample-code/visualization-trees-realistic/index.html) for an example of using multiple visual variables to visualize your data. * > **Known Limitations** Color and opacity visual variables must not have more than 8 stops and size visual variables must not have more than 6 stops. This does not apply to variables driven by view scale. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VisualVariablesMixin.html#visualVariables) */ visualVariables?: any[]; @@ -26200,12 +26200,12 @@ declare namespace __esri { interface request { /** * Retrieves data from a remote server or uploads a file from a user's computer. If the request returns an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html), the error object will include the details specified in [EsriErrorDetails](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) - * + * * @param url The request URL. * @param options The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) for available properties. - * + * */ esriRequest(url: string, options?: RequestOptions): IPromise; } @@ -26216,55 +26216,55 @@ declare namespace __esri { /** * The specification of the [details object](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#details) returned in an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ export interface EsriErrorDetails extends Object { /** * A function to retrieve headers sent from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ getHeader: GetHeader; /** * The status of the http request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ httpStatus: number; /** * The error message code. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ messageCode: string; /** * Additional error message(s). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ messages: string[]; /** * The query parameters sent with the http request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ requestOptions: any; /** * Indicates if the request required https. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ ssl: boolean; /** * The error message subcode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ subCode: number; /** * The URL of the request that returned an error message. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails) */ url: string; @@ -26274,19 +26274,19 @@ declare namespace __esri { /** * An object with the following properties that describe the request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ export interface RequestOptions extends Object { /** * If the request URL points to a web server that requires parameters, specify them here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ query?: any; /** * Response format. When this value is `image` the `headers` and `timeout` options are ignored. **Possible Values:** json | xml | text | blob | array-buffer | document | image - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ responseType?: string; @@ -26295,7 +26295,7 @@ declare namespace __esri { * ```js * const controller = new AbortController(); * const signal = controller.signal; - * + * * esriRequest(url, { signal }) * .then((response) => { * // The request went OK @@ -26307,61 +26307,61 @@ declare namespace __esri { * console.error('Error encountered', err); * } * }); - * + * * // Abort requests that are aware of the controller's signal * controller.abort(); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ signal?: AbortSignal; /** * Headers to use for the request. This is an object whose property names are header names. This option is ignored when `responseType = "image"`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ headers?: any; /** * Indicates the amount of time in milliseconds to wait for a response from the server. Set to `0` to wait for the response indefinitely. This option is ignored when `responseType = "image"`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ timeout?: number; /** * Indicates if the request should be made using the HTTP POST method. By default, this is determined automatically based on the request size. **Possible Values:** auto | post - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ method?: string; /** * If uploading a file, specify the form data or element used to submit the file here. If a form element is specified, the parameters of the `query` will be added to the URL. If not specified, then query parameters will only be added to the URL when a GET request is used. If POST is used, then query parameters will be added to the body. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ body?: FormData | HTMLFormElement | string; /** * Indicates the request should use the proxy. By default this is determined automatically based on the domain of the request url. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ useProxy?: boolean; /** * Indicates whether to send an extra query parameter to ensure the server doesn't supply cached values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ cacheBust?: boolean; /** - * Indicates if and how requests to ArcGIS Services are authenticated. Only applicable when [`esriConfig.request.useIdentity = true`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request). - * + * Indicates if and how requests to ArcGIS Services are authenticated. Only applicable when [`esriConfig.request.useIdentity = true`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#request). + * * | Known Value | Description | * |-------------|-------------| * | auto | The user will be signed in when a secure resource is requested. | * | anonymous | An error will be returned when a secure resource is requested. | * | immediate | The user will be signed in before the resource is requested. | * | no-prompt | Checks for whether the user is already signed in. If so, no additional prompts display for sign-in. | - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) */ authMode?: string; @@ -26369,37 +26369,37 @@ declare namespace __esri { /** * Returns a promise that resolves to an object with the following specification. If the request returns an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html), the error object will include the details specified in [EsriErrorDetails](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#EsriErrorDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ export interface RequestResponse extends Object { /** * The requested data. Should match the `responseType` with the data return type. Possible types are: [json](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [xml](https://developer.mozilla.org/en-US/docs/Web/API/XMLDocument), [text](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob), [array-buffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), [document](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDocument), and [image](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ data?: any; /** * The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestOptions) for available properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ requestOptions?: RequestOptions; /** * Indicates if the request required https. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ ssl?: boolean; /** * The URL used to request the data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ url?: string; /** * Method for getting a header sent from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#RequestResponse) */ getHeader?: GetHeader; @@ -26408,51 +26408,51 @@ declare namespace __esri { interface ActionBase { /** * Indicates whether the action is currently active. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#active) - * + * * @default false */ active: boolean; /** * Adds a CSS class to the action's node. Can be used in conjunction with the `image` property or by itself. Any icon font may be used in this property. The [Esri Icon Font](https://developers.arcgis.com/javascript/latest/guide/esri-icon-font/index.html) is automatically made available via the ArcGIS API for JavaScript for you to use in styling custom actions. To use one of these provided icon fonts, you must prefix the class name with `esri-`. For example, the default `zoom-to` action in [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) uses the font `esri-icon-zoom-in-magnifying-glass`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#className) */ className: string; /** * Indicates whether this action is disabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#disabled) - * + * * @default false */ disabled: boolean; /** * The name of the ID assigned to this action. This is used for differentiating actions when listening to the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#event:trigger-action) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#id) */ id: string; /** * The title of the action. _For popups_: When there are fewer than three actions defined in a popup, this text is displayed to the right of the icon or image representing the action. If there are three or more actions in the popup, then this text is used as a tooltip on the action. _For LayerList_: The first action is displayed in the layerlist with an icon. The layerlist has a menu that will display all actions with their titles - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#title) */ title: string; /** * Specifies the type of action. Choose between ["button"](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or ["toggle"](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). Currently, these two are the only supported types. A "slider" type will follow-up in a future release. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#type) - * + * * @default null */ type: string; /** * Indicates if the action is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionBase.html#visible) - * + * * @default true */ visible: boolean; @@ -26469,17 +26469,17 @@ declare namespace __esri { interface ActionButton extends ActionBase { /** * The URL to an image that will be used to represent the action. This property will be used as a background image for the node. It may be used in conjunction with the `className` property or by itself. If neither `image` nor `className` are specified, a default icon ![default icon](https://developers.arcgis.com/javascript/assets/img/guide/whats-new/41/default-action.png) will display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#image) */ image: string; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html#clone) - * - * + * + * */ clone(): ActionButton; } @@ -26496,10 +26496,10 @@ declare namespace __esri { interface ActionToggle extends ActionBase { /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html#clone) - * - * + * + * */ clone(): ActionToggle; } @@ -26515,8 +26515,8 @@ declare namespace __esri { interface LayersMixin { /** - * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). This property only contains interactive operational layers, such as [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [WebTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) and {@link module:esri/layers/GraphicsLayer GraphicsLayers} that may be queried, assigned different renderers, analyzed, etc. It does not include [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html). A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) is a collection of one or more features, or {@link module:esri/Graphic graphics}, that represent real-world phenomena. Each feature contains a {@link module:esri/symbols/Symbol symbol} and [geographic data](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in [popup windows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) and used for {@link module:esri/renderers/Renderer rendering the layer}. Layers may be added in the [constructor](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#constructors-summary), with the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) methods, or directly to the layers collection using [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#addMany). - * > A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) may only be added to one parent. Adding the same layer to multiple [Maps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [GroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent. + * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). This property only contains interactive operational layers, such as [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [WebTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) and {@link module:esri/layers/GraphicsLayer GraphicsLayers} that may be queried, assigned different renderers, analyzed, etc. It does not include [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html). A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) is a collection of one or more features, or {@link module:esri/Graphic graphics}, that represent real-world phenomena. Each feature contains a {@link module:esri/symbols/Symbol symbol} and [geographic data](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in [popup windows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) and used for {@link module:esri/renderers/Renderer rendering the layer}. Layers may be added in the [constructor](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#constructors-summary), with the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) methods, or directly to the layers collection using [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#addMany). + * > A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) may only be added to one parent. Adding the same layer to multiple [Maps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [GroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent. * > ```js * > var layer = new GraphicsLayer(); * > // The layer belongs to map1 @@ -26525,74 +26525,74 @@ declare namespace __esri { * > // and implicitly does: map1.layers.remove(layer) * > map2.layers.add(layer); * > ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) */ layers: Collection; /** * Adds a layer to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) - * + * * @param layer Layer or a Promise<Layer> to be added to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). * @param index A layer can be added at a specified index in the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) and the index is normalized. - * + * */ add(layer: Layer | IPromise, index?: number): void; /** * Adds a layer or an array of layers to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) - * + * * @param layers Layer(s) to be added to the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). * @param index A layer can be added at a specified index in the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers). If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the [layers collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) and the index is normalized. - * + * */ addMany(layers: Layer[], index?: number): void; /** * Returns a layer based on the given layer id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#findLayerById) - * + * * @param layerId The ID assigned to the layer. - * + * */ findLayerById(layerId: string): Layer; /** * Removes the specified layer from the layers collection. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#remove) - * + * * @param layer Layer to remove from the layers collection. - * + * */ remove(layer: Layer): Layer; /** * Removes all layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#removeAll) - * - * + * + * */ removeAll(): Layer[]; /** * Removes the specified layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#removeMany) - * + * * @param layers Array of layers to remove from the layers collection. - * + * */ removeMany(layers: Layer[]): Layer[]; /** * Changes the layer order. The first layer added is always the base layer, even if its order is changed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#reorder) - * + * * @param layer The layer to be moved. * @param index The index location for placing the layer. The bottom-most layer has an index of `0`. - * + * */ reorder(layer: Layer, index: number): Layer; } @@ -26607,8 +26607,8 @@ declare namespace __esri { interface LayersMixinProperties { /** - * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). This property only contains interactive operational layers, such as [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [WebTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) and {@link module:esri/layers/GraphicsLayer GraphicsLayers} that may be queried, assigned different renderers, analyzed, etc. It does not include [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html). A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) is a collection of one or more features, or {@link module:esri/Graphic graphics}, that represent real-world phenomena. Each feature contains a {@link module:esri/symbols/Symbol symbol} and [geographic data](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in [popup windows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) and used for {@link module:esri/renderers/Renderer rendering the layer}. Layers may be added in the [constructor](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#constructors-summary), with the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) methods, or directly to the layers collection using [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#addMany). - * > A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) may only be added to one parent. Adding the same layer to multiple [Maps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [GroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent. + * A collection of operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html). This property only contains interactive operational layers, such as [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [WebTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html) and {@link module:esri/layers/GraphicsLayer GraphicsLayers} that may be queried, assigned different renderers, analyzed, etc. It does not include [basemaps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html). A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) is a collection of one or more features, or {@link module:esri/Graphic graphics}, that represent real-world phenomena. Each feature contains a {@link module:esri/symbols/Symbol symbol} and [geographic data](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in [popup windows](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) and used for {@link module:esri/renderers/Renderer rendering the layer}. Layers may be added in the [constructor](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#constructors-summary), with the [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#addMany) methods, or directly to the layers collection using [add()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#add) or [addMany()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#addMany). + * > A [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) may only be added to one parent. Adding the same layer to multiple [Maps](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [GroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent. * > ```js * > var layer = new GraphicsLayer(); * > // The layer belongs to map1 @@ -26617,7 +26617,7 @@ declare namespace __esri { * > // and implicitly does: map1.layers.remove(layer) * > map2.layers.add(layer); * > ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-LayersMixin.html#layers) */ layers?: CollectionProperties | LayerProperties[]; @@ -26625,7 +26625,7 @@ declare namespace __esri { /** * A convenience module for importing [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) classes when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/guide/typescript-setup/index.html). For example, rather than importing symbols one at a time like this: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols.html) */ interface symbols { @@ -26636,10 +26636,10 @@ declare namespace __esri { interface Callout3D extends Accessor, JSONSupport { /** * Creates a deep clone of the callout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html#clone) - * - * + * + * */ clone(): Callout3D; } @@ -26647,7 +26647,7 @@ declare namespace __esri { interface Callout3DConstructor { /** * When symbols have an offset from their position, it's important to still see what the real location is. This can be achieved with callouts: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-Callout3D.html) */ @@ -26665,39 +26665,39 @@ declare namespace __esri { interface LineCallout3D extends Callout3D { /** * The border settings of the callout line. The border of the callout line can be used to improve the contrast of the callout line color against various background colors. If the border is `null`, then no border will be visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ border: LineCallout3DBorder; /** * The color of the callout line. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#color) - * + * * @default black */ color: Color; /** * The width of the callout line in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#size) - * + * * @default 1px */ size: number; /** * For LineCallout3D the type is always `line`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#type) */ type: string; /** * Creates a deep clone of the callout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#clone) - * - * + * + * */ clone(): LineCallout3D; } @@ -26705,7 +26705,7 @@ declare namespace __esri { interface LineCallout3DConstructor { /** * This type of callout displays a line to connect a symbol or a label with its actual location in the scene. For example when displaying points of interest in a city, visualizing them with a callout line helps to understand where the points are actually located: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html) */ @@ -26719,29 +26719,29 @@ declare namespace __esri { interface LineCallout3DProperties extends Callout3DProperties { /** * The border settings of the callout line. The border of the callout line can be used to improve the contrast of the callout line color against various background colors. If the border is `null`, then no border will be visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) */ border?: LineCallout3DBorderProperties; /** * The color of the callout line. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#color) - * + * * @default black */ color?: Color | number[] | string; /** * The width of the callout line in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#size) - * + * * @default 1px */ size?: number | string; /** * For LineCallout3D the type is always `line`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#type) */ type?: string; @@ -26751,9 +26751,9 @@ declare namespace __esri { export interface LineCallout3DBorderProperties extends Object { /** * The color of the callout line border. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) - * + * * @default white */ color?: Color; @@ -26762,9 +26762,9 @@ declare namespace __esri { export interface LineCallout3DBorder extends AnonymousAccessor { /** * The color of the callout line border. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html#border) - * + * * @default white */ color?: Color; @@ -26773,35 +26773,35 @@ declare namespace __esri { interface Edges3D extends Accessor, JSONSupport { /** * The color of the edges. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#color) - * + * * @default black */ color: Color; /** * A size in points by which to extend edges beyond their original end points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#extensionLength) - * + * * @default "0" */ extensionLength: number; /** * The size of the edges in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#size) - * + * * @default 1px */ size: number; /** * Creates a deep clone of the edges. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#clone) - * - * + * + * */ clone(): Edges3D; } @@ -26809,7 +26809,7 @@ declare namespace __esri { interface Edges3DConstructor { /** * Edges3D is the base class for symbol classes that add edge rendering visualization to existing symbols. Edge rendering visualization is specific for 3D visualizations and can only be applied to [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html) on [MeshSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html) or [ExtrudeSymbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html) on [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html) */ @@ -26823,25 +26823,25 @@ declare namespace __esri { interface Edges3DProperties { /** * The color of the edges. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#color) - * + * * @default black */ color?: Color | number[] | string; /** * A size in points by which to extend edges beyond their original end points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#extensionLength) - * + * * @default "0" */ extensionLength?: number | string; /** * The size of the edges in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-Edges3D.html#size) - * + * * @default 1px */ size?: number | string; @@ -26850,17 +26850,17 @@ declare namespace __esri { interface SketchEdges3D extends Edges3D { /** * For SketchEdges3D the type is always `sketch`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#type) */ type: "sketch"; /** * Creates a deep clone of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#clone) - * - * + * + * */ clone(): SketchEdges3D; } @@ -26868,7 +26868,7 @@ declare namespace __esri { interface SketchEdges3DConstructor { /** * SketchEdges3D is a symbol type that visualizes edges of [3D Object SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), extruded polygons or mesh geometries with a sketched line. It can be used to emphasize the form of 3D objects and to improve the three-dimensional spatial understanding. A sketched line aims to look like a hand-drawn line. In architecture this is useful for visualizing planned urban projects. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html) */ @@ -26882,7 +26882,7 @@ declare namespace __esri { interface SketchEdges3DProperties extends Edges3DProperties { /** * For SketchEdges3D the type is always `sketch`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SketchEdges3D.html#type) */ type?: "sketch"; @@ -26891,17 +26891,17 @@ declare namespace __esri { interface SolidEdges3D extends Edges3D { /** * For SolidEdges3D the type is always `solid`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#type) */ type: "solid"; /** * Creates a deep clone of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#clone) - * - * + * + * */ clone(): SolidEdges3D; } @@ -26909,7 +26909,7 @@ declare namespace __esri { interface SolidEdges3DConstructor { /** * SolidEdges3D is a symbol type that visualizes edges of [3D Object SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), extruded polygons or mesh geometries with a solid line. It can be used to emphasize the form of 3D objects and to improve the three-dimensional spatial understanding. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html) */ @@ -26923,7 +26923,7 @@ declare namespace __esri { interface SolidEdges3DProperties extends Edges3DProperties { /** * For SolidEdges3D the type is always `solid`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-edges-SolidEdges3D.html#type) */ type?: "solid"; @@ -26932,31 +26932,31 @@ declare namespace __esri { interface ExtrudeSymbol3DLayer extends Symbol3DLayer { /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#edges) */ edges: Edges3D; /** * The height of the extrusion in meters. Negative values will extrude the polygon surface downward towards or below the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#size) - * + * * @default 1 */ size: number; /** * For ExtrudeSymbol3DLayer the type is always `extrude`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#type) */ readonly type: "extrude"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#clone) - * - * + * + * */ clone(): ExtrudeSymbol3DLayer; } @@ -26964,7 +26964,7 @@ declare namespace __esri { interface ExtrudeSymbol3DLayerConstructor { /** * ExtrudeSymbol3DLayer is used to render [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries by extruding them upward from the ground, creating a 3D volumetric object. This is done with a [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html) */ @@ -26978,15 +26978,15 @@ declare namespace __esri { interface ExtrudeSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#edges) */ edges?: Edges3DProperties; /** * The height of the extrusion in meters. Negative values will extrude the polygon surface downward towards or below the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ExtrudeSymbol3DLayer.html#size) - * + * * @default 1 */ size?: number; @@ -26995,7 +26995,7 @@ declare namespace __esri { interface FillSymbol extends Symbol { /** * The outline of the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#outline) */ outline: SimpleLineSymbol; @@ -27004,7 +27004,7 @@ declare namespace __esri { interface FillSymbolConstructor { /** * Fill symbols are used to draw [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) graphics in a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) or a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). To create new fill symbols, use either [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) or [PictureFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html) */ @@ -27018,7 +27018,7 @@ declare namespace __esri { interface FillSymbolProperties extends SymbolProperties { /** * The outline of the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html#outline) */ outline?: SimpleLineSymbolProperties; @@ -27027,29 +27027,29 @@ declare namespace __esri { interface FillSymbol3DLayer extends Symbol3DLayer { /** * Sets the contour edges on 3D Objects. This is only applicable for [MeshSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html). ![symbol3D-edges-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbol3d-edges-solid-2.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#edges) */ edges: Edges3D; /** * The outline used to draw a line around the filled geometry. This property is not supported in [MeshSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html) symbol layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ outline: FillSymbol3DLayerOutline; /** * For FillSymbol3DLayer the type is always `fill`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#type) */ readonly type: "fill"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#clone) - * - * + * + * */ clone(): FillSymbol3DLayer; } @@ -27057,7 +27057,7 @@ declare namespace __esri { interface FillSymbol3DLayerConstructor { /** * FillSymbol3DLayer is used to render the surfaces of flat 2D [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometries and 3D volumetric meshes in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html) */ @@ -27071,13 +27071,13 @@ declare namespace __esri { interface FillSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Sets the contour edges on 3D Objects. This is only applicable for [MeshSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html). ![symbol3D-edges-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbol3d-edges-solid-2.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#edges) */ edges?: Edges3DProperties; /** * The outline used to draw a line around the filled geometry. This property is not supported in [MeshSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html) symbol layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ outline?: FillSymbol3DLayerOutlineProperties; @@ -27087,13 +27087,13 @@ declare namespace __esri { export interface FillSymbol3DLayerOutlineProperties extends Object { /** * The color of the outline. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ color?: Color | number[] | string; /** * The width of the outline in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ size?: number | string; @@ -27102,13 +27102,13 @@ declare namespace __esri { export interface FillSymbol3DLayerOutline extends AnonymousAccessor { /** * The color of the outline. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ color: Color; /** * The width of the outline in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol3DLayer.html#outline) */ size: number; @@ -27116,55 +27116,55 @@ declare namespace __esri { interface Font extends Accessor, JSONSupport { /** - * The text decoration. **Possible Values:** underline | line-through | none + * The text decoration. **Possible Values:** underline | line-through | none * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#decoration) - * + * * @default none */ decoration: "underline" | "line-through" | "none"; /** * The font family of the text. The possible values are dependent upon the: layer type, rendering mechanism, and if you working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [Labeling guide page](https://developers.arcgis.com/javascript/latest/guide/labeling/index.html) for detailed explanation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) - * + * * @default sans-serif */ family: string; /** * The font size in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) - * + * * @default 9 */ size: number; /** - * The text style. Specifies whether a font should be styled: normal, italic, or oblique. **Possible Values:** normal | italic | oblique + * The text style. Specifies whether a font should be styled: normal, italic, or oblique. **Possible Values:** normal | italic | oblique * > **Known Limitations** `oblique` is not supported in 2D [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#style) - * + * * @default normal */ style: "normal" | "italic" | "oblique"; /** - * The text weight. Specifies the level of boldness. **Possible Values:** normal | bold | bolder | lighter + * The text weight. Specifies the level of boldness. **Possible Values:** normal | bold | bolder | lighter * > **Known Limitations** `bolder` and `lighter` are not supported in 2D [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#weight) - * + * * @default normal */ weight: "normal" | "bold" | "bolder" | "lighter"; /** * Creates a deep clone of the font object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#clone) - * - * + * + * */ clone(): Font; } @@ -27181,45 +27181,45 @@ declare namespace __esri { interface FontProperties { /** - * The text decoration. **Possible Values:** underline | line-through | none + * The text decoration. **Possible Values:** underline | line-through | none * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#decoration) - * + * * @default none */ decoration?: "underline" | "line-through" | "none"; /** * The font family of the text. The possible values are dependent upon the: layer type, rendering mechanism, and if you working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [Labeling guide page](https://developers.arcgis.com/javascript/latest/guide/labeling/index.html) for detailed explanation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#family) - * + * * @default sans-serif */ family?: string; /** * The font size in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) - * + * * @default 9 */ size?: number | string; /** - * The text style. Specifies whether a font should be styled: normal, italic, or oblique. **Possible Values:** normal | italic | oblique + * The text style. Specifies whether a font should be styled: normal, italic, or oblique. **Possible Values:** normal | italic | oblique * > **Known Limitations** `oblique` is not supported in 2D [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#style) - * + * * @default normal */ style?: "normal" | "italic" | "oblique"; /** - * The text weight. Specifies the level of boldness. **Possible Values:** normal | bold | bolder | lighter + * The text weight. Specifies the level of boldness. **Possible Values:** normal | bold | bolder | lighter * > **Known Limitations** `bolder` and `lighter` are not supported in 2D [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) labels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#weight) - * + * * @default normal */ weight?: "normal" | "bold" | "bolder" | "lighter"; @@ -27228,47 +27228,47 @@ declare namespace __esri { interface IconSymbol3DLayer extends Symbol3DLayer { /** * The positioning of the icon relative to the geometry. **Possible values:** center | left | right | top | bottom | top-left | top-right | bottom-left | bottom-right - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) - * + * * @default center */ anchor: string; /** * The outline of the icon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ outline: IconSymbol3DLayerOutline; /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. If both properties are present, `href` takes precedence and `primitive` is ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) - * + * * @default { primitive: "circle" } */ resource: IconSymbol3DLayerResource; /** * The size of the icon in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#size) - * + * * @default 12 */ size: number; /** * For IconSymbol3DLayer the type is always `icon`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#type) */ readonly type: "icon"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#clone) - * - * + * + * */ clone(): IconSymbol3DLayer; } @@ -27276,7 +27276,7 @@ declare namespace __esri { interface IconSymbol3DLayerConstructor { /** * IconSymbol3DLayer is used to render [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries using a flat 2D icon (e.g. a circle) with a [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) features may also be rendered with IconSymbol3DLayers, but the icon symbol layer must be contained within a [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), not a [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) in that scenario. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html) */ @@ -27290,31 +27290,31 @@ declare namespace __esri { interface IconSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The positioning of the icon relative to the geometry. **Possible values:** center | left | right | top | bottom | top-left | top-right | bottom-left | bottom-right - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#anchor) - * + * * @default center */ anchor?: string; /** * The outline of the icon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) */ outline?: IconSymbol3DLayerOutlineProperties; /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. If both properties are present, `href` takes precedence and `primitive` is ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) - * + * * @default { primitive: "circle" } */ resource?: IconSymbol3DLayerResource; /** * The size of the icon in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#size) - * + * * @default 12 */ size?: number | string; @@ -27324,17 +27324,17 @@ declare namespace __esri { export interface IconSymbol3DLayerOutlineProperties extends Object { /** * The color of the outline. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) - * + * * @default black */ color?: Color | number[] | string; /** * The width of the outline in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) - * + * * @default 1.125 */ size?: number | string; @@ -27343,17 +27343,17 @@ declare namespace __esri { export interface IconSymbol3DLayerOutline extends AnonymousAccessor { /** * The color of the outline. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) - * + * * @default black */ color?: Color; /** * The width of the outline in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#outline) - * + * * @default 1.125 */ size?: number; @@ -27362,8 +27362,8 @@ declare namespace __esri { export interface IconSymbol3DLayerResource extends Object { /** - * Uses a built-in shape. See the table below for list of possible values. - * + * Uses a built-in shape. See the table below for list of possible values. + * * Value | Description * ------|------------ * circle | ![s3d-icon-circle](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-icon-circle.png) @@ -27371,14 +27371,14 @@ declare namespace __esri { * cross | ![s3d-icon-cross](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-icon-cross.png) * x | ![s3d-icon-x](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-icon-x.png) * kite | ![s3d-icon-kite](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-icon-kite.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ primitive?: string; /** * The URL or data URI for the image. If the external resource is an SVG then the SVG root node must have a set width and height, otherwise it will not render at the correct size. SVG is not supported in IE11. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-IconSymbol3DLayer.html#resource) */ href?: string; @@ -27387,29 +27387,29 @@ declare namespace __esri { interface LabelSymbol3D extends Symbol3D { /** * Settings for adding a callout visualization to the symbol. Callouts are drawn from the point feature location that is being symbolized, to the vertical offset of the symbol. This property has no effect if [verticalOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) is not set. At the moment only callouts of type `line` are supported. See [LineCallout3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) */ callout: Callout3D; /** * For LabelSymbol3D the type is always `label-3d`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#type) */ readonly type: "label-3d"; /** * Shifts the symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels. For points displayed with a [callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) `verticalOffset` should be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ verticalOffset: LabelSymbol3DVerticalOffset; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#clone) - * - * + * + * */ clone(): LabelSymbol3D; } @@ -27417,7 +27417,7 @@ declare namespace __esri { interface LabelSymbol3DConstructor { /** * LabelSymbol3D is used to render labels for features from a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This symbol type is not supported in 2D MapViews. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) */ @@ -27431,13 +27431,13 @@ declare namespace __esri { interface LabelSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. Callouts are drawn from the point feature location that is being symbolized, to the vertical offset of the symbol. This property has no effect if [verticalOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) is not set. At the moment only callouts of type `line` are supported. See [LineCallout3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) */ callout?: Callout3DProperties; /** * Shifts the symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels. For points displayed with a [callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#callout) `verticalOffset` should be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ verticalOffset?: LabelSymbol3DVerticalOffsetProperties; @@ -27447,19 +27447,19 @@ declare namespace __esri { export interface LabelSymbol3DVerticalOffsetProperties extends Object { /** * The vertical symbol offset in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ screenLength?: number; /** * The minimum vertical symbol offset in world units. It acts as a lower bound to avoid the vertical offset becoming too small. In the following animation the green symbol on the left has `minWorldLength = 20` and for the orange symbol on the right `minWorldLength` has not been set: ![minWorldLength-on](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-minWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ minWorldLength?: number; /** * The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big. In the following animation the green symbols have `maxWorldLength = 50` and orange symbols don't have `maxWorldLength` set: ![maxWorldLength](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-maxWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ maxWorldLength?: number; @@ -27468,19 +27468,19 @@ declare namespace __esri { export interface LabelSymbol3DVerticalOffset extends AnonymousAccessor { /** * The vertical symbol offset in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ screenLength: number; /** * The minimum vertical symbol offset in world units. It acts as a lower bound to avoid the vertical offset becoming too small. In the following animation the green symbol on the left has `minWorldLength = 20` and for the orange symbol on the right `minWorldLength` has not been set: ![minWorldLength-on](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-minWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ minWorldLength?: number; /** * The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big. In the following animation the green symbols have `maxWorldLength = 50` and orange symbols don't have `maxWorldLength` set: ![maxWorldLength](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-maxWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html#verticalOffset) */ maxWorldLength?: number; @@ -27489,17 +27489,17 @@ declare namespace __esri { interface LineSymbol extends Symbol { /** * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#color) - * + * * @default "black" */ color: Color; /** * The width of the symbol in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#width) - * + * * @default 0.75 */ width: number; @@ -27508,7 +27508,7 @@ declare namespace __esri { interface LineSymbolConstructor { /** * Line symbols are used to draw [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html) */ @@ -27522,17 +27522,17 @@ declare namespace __esri { interface LineSymbolProperties extends SymbolProperties { /** * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#color) - * + * * @default "black" */ color?: Color | number[] | string; /** * The width of the symbol in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#width) - * + * * @default 0.75 */ width?: number | string; @@ -27541,17 +27541,17 @@ declare namespace __esri { interface LineSymbol3D extends Symbol3D { /** * For LineSymbol3D the type is always `line-3d`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#type) */ readonly type: "line-3d"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html#clone) - * - * + * + * */ clone(): LineSymbol3D; } @@ -27559,7 +27559,7 @@ declare namespace __esri { interface LineSymbol3DConstructor { /** * LineSymbol3D is used to render features with [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This symbol type is not supported in 2D MapViews. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html) */ @@ -27577,25 +27577,25 @@ declare namespace __esri { interface LineSymbol3DLayer extends Symbol3DLayer { /** * The width of the line in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#size) - * + * * @default "1px" */ size: number; /** * For LineSymbol3DLayer the type is always `line`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#type) */ readonly type: "line"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#clone) - * - * + * + * */ clone(): LineSymbol3DLayer; } @@ -27603,7 +27603,7 @@ declare namespace __esri { interface LineSymbol3DLayerConstructor { /** * LineSymbol3DLayer renders [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometries using a flat 2D line with a [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html) */ @@ -27617,9 +27617,9 @@ declare namespace __esri { interface LineSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The width of the line in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3DLayer.html#size) - * + * * @default "1px" */ size?: number | string; @@ -27627,29 +27627,29 @@ declare namespace __esri { interface MarkerSymbol extends Symbol { /** - * The angle of the marker in degrees. + * The angle of the marker in degrees. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#angle) - * + * * @default 0 */ angle: number; /** - * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#xoffset) - * + * * @default 0 */ xoffset: number; /** - * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#yoffset) - * + * * @default 0 */ yoffset: number; @@ -27658,7 +27658,7 @@ declare namespace __esri { interface MarkerSymbolConstructor { /** * Marker symbols are used to draw [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) graphics in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or individual [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). To create new marker symbols, use either [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html) or [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) */ @@ -27671,29 +27671,29 @@ declare namespace __esri { interface MarkerSymbolProperties extends SymbolProperties { /** - * The angle of the marker in degrees. + * The angle of the marker in degrees. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#angle) - * + * * @default 0 */ angle?: number; /** - * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#xoffset) - * + * * @default 0 */ xoffset?: number | string; /** - * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#yoffset) - * + * * @default 0 */ yoffset?: number | string; @@ -27702,17 +27702,17 @@ declare namespace __esri { interface MeshSymbol3D extends Symbol3D { /** * For MeshSymbol3D, the type is always `mesh-3d`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#type) */ readonly type: "mesh-3d"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html#clone) - * - * + * + * */ clone(): MeshSymbol3D; } @@ -27720,7 +27720,7 @@ declare namespace __esri { interface MeshSymbol3DConstructor { /** * MeshSymbol3D is used to render 3D mesh features in a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This symbol type is not supported in 2D MapViews. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MeshSymbol3D.html) */ @@ -27741,78 +27741,78 @@ declare namespace __esri { * * For `sphere`, `cube` and `diamond` primitives, the origin is at the center. * * For `cylinder`, `cone`, `inverted-cone` and `tetrahedron` primitives, the origin is at the bottom. * * For `href` resources, the origin coincides with the origin of the 3D model. - * - * + * + * * **Possible Values:** center | top | bottom | origin - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) - * + * * @default origin */ anchor: string; /** * The depth, or diameter from north to south, of the object in meters. If `undefined`, the depth will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) - * + * * @default 10 */ depth: number; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). The rotation is specified in degrees and is relative to the y-axis. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the heading of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#heading) */ heading: number; /** * The height of the object in meters. If `undefined`, the height will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height) - * + * * @default 10 */ height: number; /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the points. If both properties are present, `primitive` takes precedence and `href` is ignored. When using the `href` property, external 3D models must be present in a specific format, which can be generated using the ArcGIS Pro SDK. [See these instructions](https://github.com/Esri/arcgis-pro-sdk-community-samples/tree/master/Map-Authoring/ExportWeb3DObjectResource#exportweb3dobjectresource) to learn how to generate a custom 3D model for use in this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) - * + * * @default { primitive: "sphere" } */ resource: ObjectSymbol3DLayerResource; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). The rotation is specified in degrees and is relative to the x-axis. At 0 degrees, the model is level. A positive value lifts the left part and lowers the right part of the model. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the roll of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#roll) */ roll: number; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). The rotation is specified in degrees and is relative to the y-axis. At 0 degrees, the model is level. A positive value points lifts the front and lowers the back of the model. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the tilt of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#tilt) */ tilt: number; /** * For ObjectSymbol3DLayer the type is always `object`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#type) */ readonly type: "object"; /** * The width, or diameter from east to west, of the object in meters. If `undefined`, the width will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width) - * + * * @default 10 */ width: number; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#clone) - * - * + * + * */ clone(): ObjectSymbol3DLayer; } @@ -27820,7 +27820,7 @@ declare namespace __esri { interface ObjectSymbol3DLayerConstructor { /** * ObjectSymbol3DLayer is used to render [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries using a volumetric 3D shape (e.g., a sphere or cylinder) with a [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) features may also be rendered with ObjectSymbol3DLayers, but the object symbol layer must be contained in a [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), not a [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) in this scenario. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html) */ @@ -27837,62 +27837,62 @@ declare namespace __esri { * * For `sphere`, `cube` and `diamond` primitives, the origin is at the center. * * For `cylinder`, `cone`, `inverted-cone` and `tetrahedron` primitives, the origin is at the bottom. * * For `href` resources, the origin coincides with the origin of the 3D model. - * - * + * + * * **Possible Values:** center | top | bottom | origin - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#anchor) - * + * * @default origin */ anchor?: string; /** * The depth, or diameter from north to south, of the object in meters. If `undefined`, the depth will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#depth) - * + * * @default 10 */ depth?: number; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). The rotation is specified in degrees and is relative to the y-axis. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the heading of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#heading) */ heading?: number; /** * The height of the object in meters. If `undefined`, the height will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#height) - * + * * @default 10 */ height?: number; /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the points. If both properties are present, `primitive` takes precedence and `href` is ignored. When using the `href` property, external 3D models must be present in a specific format, which can be generated using the ArcGIS Pro SDK. [See these instructions](https://github.com/Esri/arcgis-pro-sdk-community-samples/tree/master/Map-Authoring/ExportWeb3DObjectResource#exportweb3dobjectresource) to learn how to generate a custom 3D model for use in this property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) - * + * * @default { primitive: "sphere" } */ resource?: ObjectSymbol3DLayerResource; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). The rotation is specified in degrees and is relative to the x-axis. At 0 degrees, the model is level. A positive value lifts the left part and lowers the right part of the model. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the roll of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#roll) */ roll?: number; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). The rotation is specified in degrees and is relative to the y-axis. At 0 degrees, the model is level. A positive value points lifts the front and lowers the back of the model. If the symbol resource is aligned such that its forward facing side points in the direction of the y-axis (the y-axis always points North in WGS84 or WebMercator coordinates), its upwards facing side is pointing in the direction of the z-axis, and its right-hand side points in the direction of the x-axis (the x-axis always points East in WGS84 or WebMercator coordinates), then this angle corresponds to the tilt of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#tilt) */ tilt?: number; /** * The width, or diameter from east to west, of the object in meters. If `undefined`, the width will be calculated to maintain the original proportions of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#width) - * + * * @default 10 */ width?: number; @@ -27901,8 +27901,8 @@ declare namespace __esri { export interface ObjectSymbol3DLayerResource extends Object { /** - * Uses a built-in shape. See the table below for possible values. - * + * Uses a built-in shape. See the table below for possible values. + * * Value | Description * ------|------------ * sphere | ![s3d-object-sphere](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-object-sphere.png) @@ -27912,14 +27912,14 @@ declare namespace __esri { * inverted-cone | ![s3d-object-inverted-cone](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-object-inverted-cone.png) * diamond | ![s3d-object-diamond](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-object-diamond.png) * tetrahedron | ![s3d-object-tetrahedron](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-object-tetrahedron.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ primitive?: string; /** * The URL to the 3D model. [See these instructions](https://github.com/Esri/arcgis-pro-sdk-community-samples/tree/master/Map-Authoring/ExportWeb3DObjectResource#exportweb3dobjectresource) to learn how to create a custom 3D model. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html#resource) */ href?: string; @@ -27928,25 +27928,25 @@ declare namespace __esri { interface PathSymbol3DLayer extends Symbol3DLayer { /** * The diameter of the tube in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#size) - * + * * @default 1 */ size: number; /** * For PathSymbol3DLayer, the type is always `path`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#type) */ readonly type: "path"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#clone) - * - * + * + * */ clone(): PathSymbol3DLayer; } @@ -27954,7 +27954,7 @@ declare namespace __esri { interface PathSymbol3DLayerConstructor { /** * PathSymbol3DLayer renders [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometries using a volumetric 3D tube with a [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html) */ @@ -27968,9 +27968,9 @@ declare namespace __esri { interface PathSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The diameter of the tube in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PathSymbol3DLayer.html#size) - * + * * @default 1 */ size?: number; @@ -27979,71 +27979,71 @@ declare namespace __esri { interface PictureFillSymbol extends FillSymbol { /** * The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#height) - * + * * @default 12 */ height: number; /** * For PictureFillSymbol the type is always `picture-fill`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#type) */ readonly type: "picture-fill"; /** * The URL to the image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#url) */ url: string; /** * The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#width) - * + * * @default 12 */ width: number; /** * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xoffset) - * + * * @default 0 */ xoffset: number; /** * The scale factor on the x axis of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xscale) - * + * * @default 1 */ xscale: number; /** * The offset on the y-axis in pixels or points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yoffset) - * + * * @default 0 */ yoffset: number; /** * The scale factor on the y axis of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yscale) - * + * * @default 1 */ yscale: number; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#clone) - * - * + * + * */ clone(): PictureFillSymbol; } @@ -28051,7 +28051,7 @@ declare namespace __esri { interface PictureFillSymbolConstructor { /** * PictureFillSymbol uses an image in a repeating pattern to symbolize polygon features in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). A [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#url) must point to a valid image. In addition, the symbol can have an optional [outline](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#outline), which is defined by a [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). PictureFillSymbols may be applied to polygon features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or an individual [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html) */ @@ -28065,55 +28065,55 @@ declare namespace __esri { interface PictureFillSymbolProperties extends FillSymbolProperties { /** * The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#height) - * + * * @default 12 */ height?: number | string; /** * The URL to the image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#url) */ url?: string; /** * The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#width) - * + * * @default 12 */ width?: number | string; /** * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xoffset) - * + * * @default 0 */ xoffset?: number | string; /** * The scale factor on the x axis of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#xscale) - * + * * @default 1 */ xscale?: number; /** * The offset on the y-axis in pixels or points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yoffset) - * + * * @default 0 */ yoffset?: number | string; /** * The scale factor on the y axis of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureFillSymbol.html#yscale) - * + * * @default 1 */ yscale?: number; @@ -28122,42 +28122,42 @@ declare namespace __esri { interface PictureMarkerSymbol extends MarkerSymbol { /** * The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#height) - * + * * @default 12 */ height: number; /** * For PictureMarkerSymbol the type is always `picture-marker`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#type) */ readonly type: "picture-marker"; /** - * The URL to the image. To avoid CORS issues with this symbol, do one of the following: + * The URL to the image. To avoid CORS issues with this symbol, do one of the following: * * Make certain that the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) is hosted on a [CORS enabled server](https://enable-cors.org/server.html). * * Use an [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) hosted on the same domain as the application. * * Install a proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) */ url: string; /** * The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#width) - * + * * @default 12 */ width: number; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#clone) - * - * + * + * */ clone(): PictureMarkerSymbol; } @@ -28165,7 +28165,7 @@ declare namespace __esri { interface PictureMarkerSymbolConstructor { /** * PictureMarkerSymbol renders [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) graphics in either a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) using an image. A [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) must point to a valid image. PictureMarkerSymbols may be applied to point features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or individual [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). The image below depicts a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) whose point features are styled with a [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html) */ @@ -28179,26 +28179,26 @@ declare namespace __esri { interface PictureMarkerSymbolProperties extends MarkerSymbolProperties { /** * The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#height) - * + * * @default 12 */ height?: number | string; /** - * The URL to the image. To avoid CORS issues with this symbol, do one of the following: + * The URL to the image. To avoid CORS issues with this symbol, do one of the following: * * Make certain that the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) is hosted on a [CORS enabled server](https://enable-cors.org/server.html). * * Use an [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) hosted on the same domain as the application. * * Install a proxy. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#url) */ url?: string; /** * The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html#width) - * + * * @default 12 */ width?: number | string; @@ -28207,29 +28207,29 @@ declare namespace __esri { interface PointSymbol3D extends Symbol3D { /** * Settings for adding a callout visualization to the symbol. Callouts are drawn from the point feature location that is being symbolized, to the vertical offset of the symbol. This property has no effect if [verticalOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) is not set. At the moment only callouts of type line are supported. See [LineCallout3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) */ callout: Callout3D; /** * For PointSymbol3D the type is always `point-3d`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#type) */ readonly type: "point-3d"; /** * Shifts the symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels. For points displayed with a [callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) `verticalOffset` should be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ verticalOffset: PointSymbol3DVerticalOffset; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#clone) - * - * + * + * */ clone(): PointSymbol3D; } @@ -28237,7 +28237,7 @@ declare namespace __esri { interface PointSymbol3DConstructor { /** * PointSymbol3D is used to render features with [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This symbol type is not supported in 2D MapViews. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) */ @@ -28251,13 +28251,13 @@ declare namespace __esri { interface PointSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. Callouts are drawn from the point feature location that is being symbolized, to the vertical offset of the symbol. This property has no effect if [verticalOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) is not set. At the moment only callouts of type line are supported. See [LineCallout3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-callouts-LineCallout3D.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) */ callout?: Callout3DProperties; /** * Shifts the symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels. For points displayed with a [callout](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#callout) `verticalOffset` should be set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ verticalOffset?: PointSymbol3DVerticalOffsetProperties; @@ -28267,19 +28267,19 @@ declare namespace __esri { export interface PointSymbol3DVerticalOffsetProperties extends Object { /** * The vertical symbol offset in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ screenLength?: number; /** * The minimum vertical symbol offset in world units. It acts as a lower bound to avoid vertical offset becoming too small. In the following animation the green symbol on the left has `minWorldLength = 20` and for the orange symbol on the right `minWorldLength` has not been set: ![minWorldLength-on](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-minWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ minWorldLength?: number; /** * The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big. In the following animation the green symbols have `maxWorldLength = 50` and orange symbols don't have `maxWorldLength` set: ![maxWorldLength](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-maxWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ maxWorldLength?: number; @@ -28288,19 +28288,19 @@ declare namespace __esri { export interface PointSymbol3DVerticalOffset extends AnonymousAccessor { /** * The vertical symbol offset in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ screenLength: number; /** * The minimum vertical symbol offset in world units. It acts as a lower bound to avoid vertical offset becoming too small. In the following animation the green symbol on the left has `minWorldLength = 20` and for the orange symbol on the right `minWorldLength` has not been set: ![minWorldLength-on](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-minWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ minWorldLength?: number; /** * The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big. In the following animation the green symbols have `maxWorldLength = 50` and orange symbols don't have `maxWorldLength` set: ![maxWorldLength](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3D-line-callout-maxWorldLength.gif) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html#verticalOffset) */ maxWorldLength?: number; @@ -28309,17 +28309,17 @@ declare namespace __esri { interface PolygonSymbol3D extends Symbol3D { /** * For PolygonSymbol3D the type is always `polygon-3d`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#type) */ readonly type: "polygon-3d"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html#clone) - * - * + * + * */ clone(): PolygonSymbol3D; } @@ -28327,7 +28327,7 @@ declare namespace __esri { interface PolygonSymbol3DConstructor { /** * PolygonSymbol3D is used to render features with [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This symbol type is not supported in 2D MapViews. Polygon features may also be rendered as points with icons or objects at the centroid of each polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html) */ @@ -28345,15 +28345,15 @@ declare namespace __esri { interface SimpleFillSymbol extends FillSymbol { /** * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) - * + * * @default [0, 0, 0, 0.25] - black, semitransparent */ color: Color; /** - * The fill style. Possible values are listed in the table below: - * + * The fill style. Possible values are listed in the table below: + * * Value | Description * ------|------------- * backward-diagonal | ![sfs-backward-diagonal](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-backward-diagonal.png) @@ -28364,27 +28364,27 @@ declare namespace __esri { * none | The polygon has no fill. * solid | ![sfs-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-solid.png) * vertical | ![sfs-vertical](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-vertical.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) - * + * * @default solid */ style: string; /** * For SimpleFillSymbol the type is always `simple-fill`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#type) */ readonly type: "simple-fill"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#clone) - * - * + * + * */ clone(): SimpleFillSymbol; } @@ -28392,7 +28392,7 @@ declare namespace __esri { interface SimpleFillSymbolConstructor { /** * SimpleFillSymbol is used for rendering 2D polygons in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It can be filled with a solid [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color), or a [pattern](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style). In addition, the symbol can have an optional [outline](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#outline), which is defined by a [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) */ @@ -28406,15 +28406,15 @@ declare namespace __esri { interface SimpleFillSymbolProperties extends FillSymbolProperties { /** * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) - * + * * @default [0, 0, 0, 0.25] - black, semitransparent */ color?: Color | number[] | string; /** - * The fill style. Possible values are listed in the table below: - * + * The fill style. Possible values are listed in the table below: + * * Value | Description * ------|------------- * backward-diagonal | ![sfs-backward-diagonal](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-backward-diagonal.png) @@ -28425,11 +28425,11 @@ declare namespace __esri { * none | The polygon has no fill. * solid | ![sfs-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-solid.png) * vertical | ![sfs-vertical](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sfs-vertical.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) - * + * * @default solid */ style?: string; @@ -28437,51 +28437,51 @@ declare namespace __esri { interface SimpleLineSymbol extends LineSymbol { /** - * Specifies the cap style. The cap is the end node of a polyline, or the end of a line segment that does not connect with another segment of the same polyline. See the table below for possible values. - * + * Specifies the cap style. The cap is the end node of a polyline, or the end of a line segment that does not connect with another segment of the same polyline. See the table below for possible values. + * * Possible Value | Example * ---------------|--------- * butt | ![sls-cap-butt](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-butt.png) * round | ![sls-cap-round](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-round.png) * square | ![sls-cap-square](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-square.png) - * - * > **Known Limitations** + * + * > **Known Limitations** * * This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * This property does not persist when applied to a symbol used in a layer saved to a web map or portal item. See the [web map specification](https://developers.arcgis.com/web-map-specification/objects/esriSLS_symbol/) for more details about properties that persist when a SimpleLineSymbol is saved to an ArcGIS Online or Portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#cap) - * + * * @default round */ cap: "butt" | "round" | "square"; /** - * Specifies the join style. A `join` refers to the joint of a polyline, or the end of a line segment that connects to another segment of the same polyline. See the table below for possible values. - * + * Specifies the join style. A `join` refers to the joint of a polyline, or the end of a line segment that connects to another segment of the same polyline. See the table below for possible values. + * * Possible Value | Example * ---------------|--------- * bevel | ![sls-join-bevel](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-bevel.png) * miter | ![sls-join-miter](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-miter.png) * round | ![sls-join-round](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-round.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#join) - * + * * @default round */ join: "miter" | "round" | "bevel"; /** - * Size threshold for showing mitered line joins. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * Size threshold for showing mitered line joins. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#miterLimit) - * + * * @default 0.75 */ miterLimit: number; /** - * Specifies the line style. Possible values are listed in the table below: - * + * Specifies the line style. Possible values are listed in the table below: + * * Value | Description * ------|------------- * dash | ![sls-dash](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-dash.png) @@ -28496,27 +28496,27 @@ declare namespace __esri { * short-dash-dot-dot | ![sls-short-dash-dot-dot](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-short-dash-dot-dot.png) * short-dot | ![sls-short-dot](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-short-dot.png) * solid | ![sls-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-solid.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#style) - * + * * @default solid */ style: string; /** * For SimpleLineSymbol, the type is always `simple-line`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#type) */ readonly type: "simple-line"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#clone) - * - * + * + * */ clone(): SimpleLineSymbol; } @@ -28524,7 +28524,7 @@ declare namespace __esri { interface SimpleLineSymbolConstructor { /** * SimpleLineSymbol is used for rendering 2D [polyline geometries](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). SimpleLineSymbol is also used for rendering outlines for [marker symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html) and [fill symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-FillSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) */ @@ -28537,51 +28537,51 @@ declare namespace __esri { interface SimpleLineSymbolProperties extends LineSymbolProperties { /** - * Specifies the cap style. The cap is the end node of a polyline, or the end of a line segment that does not connect with another segment of the same polyline. See the table below for possible values. - * + * Specifies the cap style. The cap is the end node of a polyline, or the end of a line segment that does not connect with another segment of the same polyline. See the table below for possible values. + * * Possible Value | Example * ---------------|--------- * butt | ![sls-cap-butt](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-butt.png) * round | ![sls-cap-round](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-round.png) * square | ![sls-cap-square](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-cap-square.png) - * - * > **Known Limitations** + * + * > **Known Limitations** * * This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * This property does not persist when applied to a symbol used in a layer saved to a web map or portal item. See the [web map specification](https://developers.arcgis.com/web-map-specification/objects/esriSLS_symbol/) for more details about properties that persist when a SimpleLineSymbol is saved to an ArcGIS Online or Portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#cap) - * + * * @default round */ cap?: "butt" | "round" | "square"; /** - * Specifies the join style. A `join` refers to the joint of a polyline, or the end of a line segment that connects to another segment of the same polyline. See the table below for possible values. - * + * Specifies the join style. A `join` refers to the joint of a polyline, or the end of a line segment that connects to another segment of the same polyline. See the table below for possible values. + * * Possible Value | Example * ---------------|--------- * bevel | ![sls-join-bevel](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-bevel.png) * miter | ![sls-join-miter](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-miter.png) * round | ![sls-join-round](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/sls-join-round.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#join) - * + * * @default round */ join?: "miter" | "round" | "bevel"; /** - * Size threshold for showing mitered line joins. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * Size threshold for showing mitered line joins. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#miterLimit) - * + * * @default 0.75 */ miterLimit?: number | string; /** - * Specifies the line style. Possible values are listed in the table below: - * + * Specifies the line style. Possible values are listed in the table below: + * * Value | Description * ------|------------- * dash | ![sls-dash](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-dash.png) @@ -28596,11 +28596,11 @@ declare namespace __esri { * short-dash-dot-dot | ![sls-short-dash-dot-dot](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-short-dash-dot-dot.png) * short-dot | ![sls-short-dot](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-short-dot.png) * solid | ![sls-solid](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sls-solid.png) - * + * * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#style) - * + * * @default solid */ style?: string; @@ -28608,38 +28608,38 @@ declare namespace __esri { interface SimpleMarkerSymbol extends MarkerSymbol { /** - * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. + * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. * > The `color` property does not apply to marker symbols defined with the `cross` or `x` [style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style). Since these styles are wholly comprised of outlines, you must modify the [outline.color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) property to set the color of symbols with those styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#color) - * + * * @default [255, 255, 255, 0.25] - white, semitransparent */ color: Color; /** * The outline of the marker symbol. The `color` property of this object directly modifies the overall color of marker symbols defined with the `cross` or `x` [style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) */ outline: SimpleLineSymbol; /** - * The SVG path of the icon. + * The SVG path of the icon. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#path) */ path: string; /** * The size of the marker in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#size) - * + * * @default 12 */ size: number; /** - * The marker style. Possible values are in the table below. - * + * The marker style. Possible values are in the table below. + * * Value | Description * ------|------------ * circle | ![sms_circle](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-circle.png) @@ -28647,26 +28647,26 @@ declare namespace __esri { * diamond | ![sms_diamond](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-diamond.png) * square | ![sms_square](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-square.png) * x | ![sms_x](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-x.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style) - * + * * @default circle */ style: string; /** * For SimpleMarkerSymbol the type is always `simple-marker`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#type) */ readonly type: "simple-marker"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#clone) - * - * + * + * */ clone(): SimpleMarkerSymbol; } @@ -28674,7 +28674,7 @@ declare namespace __esri { interface SimpleMarkerSymbolConstructor { /** * SimpleMarkerSymbol is used for rendering 2D [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometries with a simple shape and [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#color) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It may be filled with a solid [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#color) and have an optional [outline](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline), which is defined with a [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html) */ @@ -28687,38 +28687,38 @@ declare namespace __esri { interface SimpleMarkerSymbolProperties extends MarkerSymbolProperties { /** - * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. + * The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. * > The `color` property does not apply to marker symbols defined with the `cross` or `x` [style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style). Since these styles are wholly comprised of outlines, you must modify the [outline.color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) property to set the color of symbols with those styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#color) - * + * * @default [255, 255, 255, 0.25] - white, semitransparent */ color?: Color | number[] | string; /** * The outline of the marker symbol. The `color` property of this object directly modifies the overall color of marker symbols defined with the `cross` or `x` [style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#outline) */ outline?: SimpleLineSymbolProperties; /** - * The SVG path of the icon. + * The SVG path of the icon. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#path) */ path?: string; /** * The size of the marker in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#size) - * + * * @default 12 */ size?: number | string; /** - * The marker style. Possible values are in the table below. - * + * The marker style. Possible values are in the table below. + * * Value | Description * ------|------------ * circle | ![sms_circle](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-circle.png) @@ -28726,10 +28726,10 @@ declare namespace __esri { * diamond | ![sms_diamond](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-diamond.png) * square | ![sms_square](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-square.png) * x | ![sms_x](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols-sms-x.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html#style) - * + * * @default circle */ style?: string; @@ -28739,11 +28739,11 @@ declare namespace __esri { interface symbolsSupportJsonUtils { /** * Creates a new instance of an appropriate [Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input `json` parameter often comes from a response to a query operation in the REST API or a [toJSON()](http://pro.arcgis.com/en/pro-app/tool-reference/conversion/features-to-json.htm) method from another ArcGIS product. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for details and examples of when and how to use this function. When you create a [MarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html), [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html) or [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html) from a JSON object, you may specify a property angle to rotate the symbol. Be aware that the angle in the JSON is different from [MarkerSymbol.angle](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-MarkerSymbol.html#angle). The angle in the JSON follows the traditional ArcGIS specification and is rotated counter-clockwise, whereas the angle in the symbol is rotated clockwise. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-jsonUtils.html#fromJSON) - * + * * @param json A JSON representation of the instance in the ArcGIS format. See the [ArcGIS REST API documentation](https://developers.arcgis.com/documentation/common-data-types/symbol-objects.htm) for examples of the structure of various input JSON objects. - * + * */ fromJSON(json: any): Symbol; } @@ -28754,9 +28754,9 @@ declare namespace __esri { interface symbolPreview { /** * Generates a preview image of a given symbol that can be displayed in a custom widget or other DOM element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) - * + * * @param symbol The symbol for which to generate a preview image. * @param options Formatting options for the symbol preview image. * @param options.node The parent node to append to the symbol. @@ -28766,7 +28766,7 @@ declare namespace __esri { * @param options.scale Indicates whether to scale the symbol preview. * @param options.disableUpsampling Indicates whether to disable upsampling for raster images. * @param options.symbolConfig For "tall" symbols in portrait view, then the `tall` value should be used here. - * + * */ renderPreviewHTML(symbol: Symbol, options?: symbolPreviewRenderPreviewHTMLOptions): IPromise; } @@ -28777,43 +28777,43 @@ declare namespace __esri { export interface symbolPreviewRenderPreviewHTMLOptions extends Object { /** * The parent node to append to the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ node?: HTMLElement; /** * The size of the symbol preview in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ size?: number; /** * The maximum size of the symbol preview in points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ maxSize?: number; /** * The opacity of the layer represented by the `symbol`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ opacity?: number; /** * Indicates whether to scale the symbol preview. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ scale?: boolean; /** * Indicates whether to disable upsampling for raster images. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ disableUpsampling?: boolean; /** * For "tall" symbols in portrait view, then the `tall` value should be used here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-symbolPreview.html#renderPreviewHTML) */ symbolConfig?: string; @@ -28822,7 +28822,7 @@ declare namespace __esri { interface Symbol extends Accessor, JSONSupport { /** * The symbol type. **Possible values:** simple-marker | picture-marker | simple-line | cartographic-line-symbol | simple-fill | picture-fill | text | shield-label-symbol | point-3d | line-3d | polygon-3d | mesh-3d | label-3d - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html#type) */ readonly type: string; @@ -28831,7 +28831,7 @@ declare namespace __esri { interface SymbolConstructor { /** * Symbol is the base class for all symbols. Symbols represent point, line, polygon, and mesh geometries as vector graphics within a [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). Symbols can only be set directly on individual [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) in a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) or in [View.graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics). Otherwise they are assigned to a [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) that is applied to a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) */ @@ -28849,13 +28849,13 @@ declare namespace __esri { interface Symbol3D extends Symbol { /** * The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). This information is part of the WebScene persistence model and may be used to understand where a symbol was originally sourced from. It does not affect actual appearance or rendering of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleOrigin: Symbol3DStyleOrigin; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the `type` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#symbolLayers) */ symbolLayers: Collection; @@ -28864,7 +28864,7 @@ declare namespace __esri { interface Symbol3DConstructor { /** * Symbol3D is the base class for all 3D symbols. It is used to render 2D [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), and [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) and 3D mesh features in a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html). All 3D symbols must be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) instance; there is no support for 3D rendering in [MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) */ @@ -28878,13 +28878,13 @@ declare namespace __esri { interface Symbol3DProperties extends SymbolProperties { /** * The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). This information is part of the WebScene persistence model and may be used to understand where a symbol was originally sourced from. It does not affect actual appearance or rendering of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleOrigin?: Symbol3DStyleOrigin; /** * A Collection of [Symbol3DLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) objects used to visualize the graphic or feature. Individual symbol layers may be autocast as objects and specified using the `type` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#symbolLayers) */ symbolLayers?: CollectionProperties; @@ -28894,19 +28894,19 @@ declare namespace __esri { export interface Symbol3DStyleOrigin extends Object { /** * a well-known esri-provided style, such as `EsriThematicShapesStyle` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleName?: string; /** * url to a style definition - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ styleUrl?: string; /** * name of the symbol in the style referenced by styleName or styleUrl - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html#styleOrigin) */ name: string; @@ -28915,13 +28915,13 @@ declare namespace __esri { interface Symbol3DLayer extends Accessor, JSONSupport { /** * The material used to shade the geometry. For `material` properties, see the documentation of the individual symbol layer classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html#material) */ material: any; /** - * The 3D symbol layer type. See the table below for a list of possible values. - * + * The 3D symbol layer type. See the table below for a list of possible values. + * * Value | Description * ------|------------ * icon | ![s3d-icon](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-icon-circle.png) @@ -28931,8 +28931,8 @@ declare namespace __esri { * fill | ![s3d-fill](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-fill-solid.png) * extrusion | ![s3d-extrusion](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-extrude-solid.png) * text | ![s3d-text](https://developers.arcgis.com/javascript/assets/img/apiref/symbols/symbols3d-label-text.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html#type) */ readonly type: string; @@ -28941,7 +28941,7 @@ declare namespace __esri { interface Symbol3DLayerConstructor { /** * Symbol layers are used to define the visualization of [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), and mesh geometries rendered with [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html). [3D symbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) may only be used to render features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), or standalone [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). There is no support for 3D symbols in 2D [MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) */ @@ -28955,7 +28955,7 @@ declare namespace __esri { interface Symbol3DLayerProperties { /** * The material used to shade the geometry. For `material` properties, see the documentation of the individual symbol layer classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html#material) */ material?: any; @@ -28963,133 +28963,133 @@ declare namespace __esri { interface TextSymbol extends Symbol { /** - * The angle of the text. `0` is horizontal and the angle moves clockwise. + * The angle of the text. `0` is horizontal and the angle moves clockwise. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#angle) - * + * * @default 0 */ angle: number; /** * The background color of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#backgroundColor) */ backgroundColor: Color; /** * The border color of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineColor) */ borderLineColor: Color; /** * The border size or width of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineSize) */ borderLineSize: number; /** * The color of the text. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#color) */ color: Color; /** - * The font used to style the text. + * The font used to style the text. * > **Known Limitations** This property is not fully supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#font) */ font: Font; /** - * The color of the text symbol's halo. To include a halo in the TextSymbol, you must also set the size of the halo in [haloSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize). - * > **Known Limitations** + * The color of the text symbol's halo. To include a halo in the TextSymbol, you must also set the size of the halo in [haloSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize). + * > **Known Limitations** * * Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor) */ haloColor: Color; /** - * The size in points of the text symbol's halo. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). To include a halo in the TextSymbol, you must also set the color of the halo in [haloColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor). - * > **Known Limitations** + * The size in points of the text symbol's halo. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). To include a halo in the TextSymbol, you must also set the color of the halo in [haloColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor). + * > **Known Limitations** * * Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize) */ haloSize: number; /** - * Adjusts the horizontal alignment of the text in multi-line labels. **Possible Values:** left | right | center | justify + * Adjusts the horizontal alignment of the text in multi-line labels. **Possible Values:** left | right | center | justify * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#horizontalAlignment) - * + * * @default center */ horizontalAlignment: string; /** * Determines whether to adjust the spacing between characters in the text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#kerning) - * + * * @default true */ kerning: boolean; /** - * Determines whether every character in the text string is rotated. + * Determines whether every character in the text string is rotated. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#rotated) - * + * * @default false */ rotated: boolean; /** * The text string to display in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#text) */ text: string; /** * For TextSymbol, the type is always `text`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#type) */ readonly type: "text"; /** - * Adjusts the vertical alignment of the text. **Possible Values:** baseline | top | middle | bottom + * Adjusts the vertical alignment of the text. **Possible Values:** baseline | top | middle | bottom * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#verticalAlignment) - * + * * @default baseline */ verticalAlignment: string; /** - * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#xoffset) - * + * * @default 0 */ xoffset: number; /** - * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#yoffset) - * + * * @default 0 */ yoffset: number; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#clone) - * - * + * + * */ clone(): TextSymbol; } @@ -29097,7 +29097,7 @@ declare namespace __esri { interface TextSymbolConstructor { /** * Text symbols are used to define the graphic for displaying labels on a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), and [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html), in a 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Text symbols can also be used to define the symbol property of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). With this class, you may alter the [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#color), [font](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#font), [halo](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize), and other properties of the label graphic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html) */ @@ -29110,117 +29110,117 @@ declare namespace __esri { interface TextSymbolProperties extends SymbolProperties { /** - * The angle of the text. `0` is horizontal and the angle moves clockwise. + * The angle of the text. `0` is horizontal and the angle moves clockwise. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#angle) - * + * * @default 0 */ angle?: number; /** * The background color of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#backgroundColor) */ backgroundColor?: Color | number[] | string; /** * The border color of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineColor) */ borderLineColor?: Color | number[] | string; /** * The border size or width of the label's bounding box. This property is only supported for [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#borderLineSize) */ borderLineSize?: number; /** * The color of the text. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with `r`, `g`, `b`, and `a` properties; or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#color) */ color?: Color | number[] | string; /** - * The font used to style the text. + * The font used to style the text. * > **Known Limitations** This property is not fully supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#font) */ font?: FontProperties; /** - * The color of the text symbol's halo. To include a halo in the TextSymbol, you must also set the size of the halo in [haloSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize). - * > **Known Limitations** + * The color of the text symbol's halo. To include a halo in the TextSymbol, you must also set the size of the halo in [haloSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize). + * > **Known Limitations** * * Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor) */ haloColor?: Color | number[] | string; /** - * The size in points of the text symbol's halo. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). To include a halo in the TextSymbol, you must also set the color of the halo in [haloColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor). - * > **Known Limitations** + * The size in points of the text symbol's halo. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). To include a halo in the TextSymbol, you must also set the color of the halo in [haloColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloColor). + * > **Known Limitations** * * Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#haloSize) */ haloSize?: number | string; /** - * Adjusts the horizontal alignment of the text in multi-line labels. **Possible Values:** left | right | center | justify + * Adjusts the horizontal alignment of the text in multi-line labels. **Possible Values:** left | right | center | justify * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#horizontalAlignment) - * + * * @default center */ horizontalAlignment?: string; /** * Determines whether to adjust the spacing between characters in the text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#kerning) - * + * * @default true */ kerning?: boolean; /** - * Determines whether every character in the text string is rotated. + * Determines whether every character in the text string is rotated. * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#rotated) - * + * * @default false */ rotated?: boolean; /** * The text string to display in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#text) */ text?: string; /** - * Adjusts the vertical alignment of the text. **Possible Values:** baseline | top | middle | bottom + * Adjusts the vertical alignment of the text. **Possible Values:** baseline | top | middle | bottom * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#verticalAlignment) - * + * * @default baseline */ verticalAlignment?: string; /** - * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#xoffset) - * + * * @default 0 */ xoffset?: number | string; /** - * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). + * The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). * > **Known Limitations** This property is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html#yoffset) - * + * * @default 0 */ yoffset?: number | string; @@ -29229,43 +29229,43 @@ declare namespace __esri { interface TextSymbol3DLayer extends Symbol3DLayer { /** * The font of the text label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#font) */ font: Font; /** * The halo surrounding the text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ halo: TextSymbol3DLayerHalo; /** * Size of the text label in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). When set, this property overrides the [font.size](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#size) - * + * * @default 9 */ size: number; /** * The text to be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#text) */ text: string; /** * For TextSymbol3DLayer the type is always `text`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#type) */ readonly type: "text"; /** * Creates a deep clone of the symbol layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#clone) - * - * + * + * */ clone(): TextSymbol3DLayer; } @@ -29273,7 +29273,7 @@ declare namespace __esri { interface TextSymbol3DLayerConstructor { /** * TextSymbol3DLayer is used to draw text labels for features of any geometry type. This is typically done by adding it to a [LabelSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LabelSymbol3D.html) in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) does not support 3D symbols. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html) */ @@ -29287,27 +29287,27 @@ declare namespace __esri { interface TextSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The font of the text label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#font) */ font?: FontProperties; /** * The halo surrounding the text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) */ halo?: TextSymbol3DLayerHaloProperties; /** * Size of the text label in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). When set, this property overrides the [font.size](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Font.html#size) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#size) - * + * * @default 9 */ size?: number | string; /** * The text to be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#text) */ text?: string; @@ -29317,17 +29317,17 @@ declare namespace __esri { export interface TextSymbol3DLayerHaloProperties extends Object { /** * The color of the halo. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) - * + * * @default black */ color?: Color | number[] | string; /** * The size of the halo in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) - * + * * @default 0 */ size?: number | string; @@ -29336,17 +29336,17 @@ declare namespace __esri { export interface TextSymbol3DLayerHalo extends AnonymousAccessor { /** * The color of the halo. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) - * + * * @default black */ color?: Color; /** * The size of the halo in points. This value may be autocast with a string expressing size in points or pixels (e.g. `12px`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol3DLayer.html#halo) - * + * * @default 0 */ size?: number; @@ -29355,49 +29355,49 @@ declare namespace __esri { interface WebStyleSymbol extends Symbol { /** * The name of the symbol within the web style. Each symbol in a web style is identified by a unique name. Only [Esri-provided web style symbol names](https://developers.arcgis.com/javascript/latest/guide/esri-web-style-symbols/index.html) can be referenced here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#name) */ name: string; /** * The portal that contains the web style this symbol refers to. Only required when [styleName](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) is set. Defaults to the value in [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) (e.g. https://www.arcgis.com). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) */ portal: Portal; /** * A registered web style name. Only [Esri-provided web style names](https://developers.arcgis.com/javascript/latest/guide/esri-web-style-symbols/index.html) can be referenced here. Requires [portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) property to be set. Can not be used in conjunction with [styleUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl). See class description for example. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) */ styleName: string; /** * URL that points to the web style definition. Cannot be used in conjunction with [styleName](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) and [portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal). See class description for example. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl) */ styleUrl: string; /** * For WebStyleSymbol the type is always `web-style`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#type) */ readonly type: "web-style"; /** * Creates a deep clone of the symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#clone) - * - * + * + * */ clone(): WebStyleSymbol; /** * Downloads and returns the [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) instance the WebStyleSymbol refers to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#fetchSymbol) - * - * + * + * */ fetchSymbol(): IPromise; } @@ -29405,7 +29405,7 @@ declare namespace __esri { interface WebStyleSymbolConstructor { /** * WebStyleSymbol is a class used to conveniently create realistic and thematic 3D symbols. It is a wrapper for creating [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html) objects that point to a web style resource available in the API. This symbol type is not supported in 2D MapViews. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) */ @@ -29419,25 +29419,25 @@ declare namespace __esri { interface WebStyleSymbolProperties extends SymbolProperties { /** * The name of the symbol within the web style. Each symbol in a web style is identified by a unique name. Only [Esri-provided web style symbol names](https://developers.arcgis.com/javascript/latest/guide/esri-web-style-symbols/index.html) can be referenced here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#name) */ name?: string; /** * The portal that contains the web style this symbol refers to. Only required when [styleName](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) is set. Defaults to the value in [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) (e.g. https://www.arcgis.com). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) */ portal?: PortalProperties; /** * A registered web style name. Only [Esri-provided web style names](https://developers.arcgis.com/javascript/latest/guide/esri-web-style-symbols/index.html) can be referenced here. Requires [portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal) property to be set. Can not be used in conjunction with [styleUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl). See class description for example. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) */ styleName?: string; /** * URL that points to the web style definition. Cannot be used in conjunction with [styleName](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleName) and [portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#portal). See class description for example. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html#styleUrl) */ styleUrl?: string; @@ -29446,12 +29446,12 @@ declare namespace __esri { interface ClosestFacilityTask extends Task { /** * Solves the closest facility. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html#solve) - * + * * @param params Defines the parameters of the closest facility analysis. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ solve(params: ClosestFacilityParameters, requestOptions?: any): IPromise; } @@ -29459,7 +29459,7 @@ declare namespace __esri { interface ClosestFacilityTaskConstructor { /** * Helps you find closest facilities around any location (incident) on a network. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html) */ @@ -29475,19 +29475,19 @@ declare namespace __esri { interface FindTask extends Task { /** * The geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-FindTask.html#gdbVersion) */ gdbVersion: string; /** * Sends a request to the ArcGIS REST map service resource to perform a search based on the input [params](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-FindTask.html#execute) - * + * * @param params Specifies the layers and fields that are used for the search. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(params: FindParameters, requestOptions?: any): IPromise; } @@ -29495,7 +29495,7 @@ declare namespace __esri { interface FindTaskConstructor { /** * Search a map service exposed by the ArcGIS Server REST API based on a string value. The search can be conducted on a single field of a single layer, on many fields of a layer, or on many fields of many layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-FindTask.html) */ @@ -29507,7 +29507,7 @@ declare namespace __esri { interface FindTaskProperties extends TaskProperties { /** * The geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-FindTask.html#gdbVersion) */ gdbVersion?: string; @@ -29516,198 +29516,198 @@ declare namespace __esri { interface GeometryService extends Task { /** * Computes the area and length for the input [polygons](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#areasAndLengths) - * + * * @param areasAndLengthsParameters Specify the input polygons and optionally the linear and area units. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ areasAndLengths(areasAndLengthsParameters: AreasAndLengthsParameters, requestOptions?: any): IPromise; /** * The Auto Complete operation is performed on a geometry service resource. The AutoComplete operation simplifies the process of constructing new polygons that are adjacent to other polygons. It constructs polygons that fill in the gaps between existing polygons and a set of polylines. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#autoComplete) - * + * * @param polygons The array of polygons that will provide boundaries for new polygons. * @param polylines An array of polylines that will provide the remaining boundaries for new polygons. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ autoComplete(polygons: Polygon[], polylines: Polyline[], requestOptions?: any): IPromise; /** * Creates buffer polygons at a specified distance around the given geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#buffer) - * + * * @param bufferParameters Specifies the input geometries, buffer distances, and other options. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ buffer(bufferParameters: BufferParameters, requestOptions?: any): IPromise; /** * The convexHull operation is performed on a geometry service resource. It returns the convex hull of the input geometry. The input geometry can be a point, multipoint, polyline or polygon. The hull is typically a polygon but can also be a polyline or point in degenerate cases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#convexHull) - * + * * @param geometries The geometries whose convex hull is to be created. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ convexHull(geometries: Geometry[], requestOptions?: any): IPromise; /** * The cut operation is performed on a geometry service resource. This operation splits the input polyline or polygon where it crosses a cutting polyline. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#cut) - * + * * @param geometries The polylines or polygons to be cut. * @param cutter The polyline that will be used to divide the target into pieces where it crosses the target. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ cut(geometries: Geometry[], cutter: Polyline, requestOptions?: any): IPromise; /** * The densify operation is performed on a geometry service resource. This operation densifies geometries by plotting points between existing vertices. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#densify) - * + * * @param densifyParameters The DensifyParameters objects contains `geometries`, `geodesic`, `lengthUnit`, and `maxSegmentLength` properties. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ densify(densifyParameters: DensifyParameters, requestOptions?: any): IPromise; /** * The difference operation is performed on a geometry service resource. This operation constructs the set-theoretic difference between an array of geometries and another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#difference) - * + * * @param geometries An array of points, multipoints, polylines or polygons. * @param geometry A single geometry of any type, with a dimension equal to or greater than the items in geometries. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ difference(geometries: Geometry[], geometry: Geometry, requestOptions?: any): IPromise; /** * Measures the planar or geodesic distance between geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#distance) - * + * * @param params Sets the input geometries to measure, distance units, and other parameters. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ distance(params: DistanceParameters, requestOptions?: any): IPromise; /** * Converts an array of well-known strings into xy-coordinates based on the conversion type and spatial reference supplied by the user. Only available with ArcGIS Server 10.3 or above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#fromGeoCoordinateString) - * + * * @param params See the object specifications table below for the structure of the `params` object. * @param params.strings An array of formatted strings as specified by `conversionType`. Example: `["01N AA 66021 00000" , "11S NT 00000 62155" , "31U BT 94071 65288"]` * @param params.sr The spatial reference or well-known ID to convert the input string coordinates to. * @param params.conversionType The conversion type of the input strings. **Possible Values:** mrgs | usng | utm | geo-ref | gars | dms | ddm | dd * @param params.conversionMode Conversion options for mrgs, utm and gars conversion types. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/from-geocoordinatestring.htm) for possible values and their descriptions. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ fromGeoCoordinateString(params: GeometryServiceFromGeoCoordinateStringParams, requestOptions?: any): IPromise; /** * Generalizes the input geometries using the Douglas-Peucker algorithm. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#generalize) - * + * * @param params An array of geometries to generalize and a maximum deviation. Optionally set the deviation units. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ generalize(params: GeneralizeParameters, requestOptions?: any): IPromise; /** * The intersect operation is performed on a geometry service resource. This operation constructs the set-theoretic intersection between an array of geometries and another geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#intersect) - * + * * @param geometries An array of points, multipoints, polylines, or polygons. * @param intersector A single geometry of any type, of dimension equal to or greater than the dimension of the items in `geometries`. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ intersect(geometries: Geometry[], intersector: Geometry, requestOptions?: any): IPromise; /** * Calculates an interior point for each polygon specified. These interior points can be used by clients for labeling the polygons. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#labelPoints) - * + * * @param polygons The polygon graphics to process. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ labelPoints(polygons: Polygon[], requestOptions?: any): IPromise; /** * Gets the lengths for a [Geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html) when the geometry type is [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#lengths) - * + * * @param params Specify the polylines and optionally the length unit and the geodesic length option. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ lengths(params: LengthsParameters, requestOptions?: any): IPromise; /** * Constructs the offset of the input geometries based on a planar distance. If the offsetDistance is positive the constructed offset will be on the right side of the geometry. Left side offsets are constructed with negative values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#offset) - * + * * @param params Set the geometries to offset, distance, and units. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ offset(params: OffsetParameters, requestOptions?: any): IPromise; /** * Projects a set of geometries to a new spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#project) - * + * * @param params The input projection parameters. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ project(params: ProjectParameters, requestOptions?: any): IPromise; /** * Computes the set of pairs of geometries from the input geometry arrays that belong to the specified relation. Both arrays are assumed to be in the same spatial reference. The relations are evaluated in 2D. Z-coordinates are not used. Geometry types cannot be mixed within an array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#relation) - * + * * @param params The set of parameters required to perform the comparison. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ relation(params: RelationParameters, requestOptions?: any): IPromise; /** * The reshape operation is performed on a geometry service resource. It reshapes a [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) or a part of a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) using a reshaping line. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#reshape) - * + * * @param targetGeometry The Polyline or Polygon to be reshaped. * @param reshaper The single-part polyline that performs the reshaping. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ reshape(targetGeometry: Geometry, reshaper: Geometry, requestOptions?: any): IPromise; /** * Alters the given geometries to make their definitions topologically legal with respect to their geometry type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#simplify) - * + * * @param geometries The geometries to simplify. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ simplify(geometries: Geometry[], requestOptions?: any): IPromise; /** * Converts an array of XY-coordinates into well-known strings based on the conversion type and spatial reference supplied by the user. Only available with ArcGIS Server 10.3 or above. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) - * + * * @param params See the object specifications table below for the structure of the `params` object. * @param params.sr The spatial reference (or WKID of the spatial reference) of the XY-coordinates to be converted. * @param params.coordinates An array of XY-coordinates (in JSON format) to be converted. @@ -29717,27 +29717,27 @@ declare namespace __esri { * @param params.rounding If `true`, then numeric portions of the string are rounded to the nearest whole magnitude as specified by `numOfDigits`. Otherwise, numeric portions of the string are truncated. The rounding parameter applies only to conversion types `mgrs`, `usng` and `geo-ref`. * @param params.addSpaces If `true`, then spaces are added between components of the string. The `addSpaces` parameter applies only to conversion types `mgrs`, `usng` and `utm`. The default value for `mgrs` is `false` , while the default value for both `usng` and `utm` is `true`. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ toGeoCoordinateString(params: GeometryServiceToGeoCoordinateStringParams, requestOptions?: any): IPromise; /** * Trims or extends the input polylines using the user specified guide polyline. When trimming features, the portion to the left of the cutting line is preserved in the output and the rest is discarded. If the input polyline is not cut or extended then an empty polyline is added to the output array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#trimExtend) - * + * * @param params Input parameters for the `trimExtend` operation. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ trimExtend(params: TrimExtendParameters, requestOptions?: any): IPromise; /** * The union operation is performed on a geometry service resource. This operation constructs the set-theoretic union of the geometries in the input array. All inputs must be of the same type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#union) - * + * * @param geometries An array of the geometries to be unioned. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ union(geometries: Geometry[], requestOptions?: any): IPromise; } @@ -29745,7 +29745,7 @@ declare namespace __esri { interface GeometryServiceConstructor { /** * Represents a geometry service resource exposed by the ArcGIS REST API. It is used to perform various operations on geometries such as project, simplify, buffer, and relationships. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html) */ @@ -29762,27 +29762,27 @@ declare namespace __esri { export interface GeometryServiceFromGeoCoordinateStringParams extends Object { /** * An array of formatted strings as specified by `conversionType`. Example: `["01N AA 66021 00000" , "11S NT 00000 62155" , "31U BT 94071 65288"]` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#fromGeoCoordinateString) */ strings: string[]; /** * The spatial reference or well-known ID to convert the input string coordinates to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#fromGeoCoordinateString) */ sr: SpatialReference | string | number; /** * The conversion type of the input strings. **Possible Values:** mrgs | usng | utm | geo-ref | gars | dms | ddm | dd - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#fromGeoCoordinateString) - * + * * @default mrgs */ conversionType?: string; /** * Conversion options for mrgs, utm and gars conversion types. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/from-geocoordinatestring.htm) for possible values and their descriptions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#fromGeoCoordinateString) */ conversionMode?: string; @@ -29792,45 +29792,45 @@ declare namespace __esri { export interface GeometryServiceToGeoCoordinateStringParams extends Object { /** * The spatial reference (or WKID of the spatial reference) of the XY-coordinates to be converted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ sr: SpatialReference | string | number; /** * An array of XY-coordinates (in JSON format) to be converted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ coordinates: number[][]; /** * The conversion type of the input strings. **Possible values:** mgrs | usng | utm | geo-ref | gars | dms | ddm | dd - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ conversionType: string; /** * Conversion options for mgrs and utm conversion types. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/to-geocoordinatestring.htm) for valid conversion modes and their descriptions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ conversionMode?: string; /** * The number of digits to output for each of the numerical portions in the string. The default value depends of `conversionType`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/from-geocoordinatestring.htm) for default values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ numOfDigits?: number; /** * If `true`, then numeric portions of the string are rounded to the nearest whole magnitude as specified by `numOfDigits`. Otherwise, numeric portions of the string are truncated. The rounding parameter applies only to conversion types `mgrs`, `usng` and `geo-ref`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) - * + * * @default true */ rounding?: boolean; /** * If `true`, then spaces are added between components of the string. The `addSpaces` parameter applies only to conversion types `mgrs`, `usng` and `utm`. The default value for `mgrs` is `false` , while the default value for both `usng` and `utm` is `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html#toGeoCoordinateString) */ addSpaces?: boolean; @@ -29839,128 +29839,128 @@ declare namespace __esri { interface Geoprocessor extends Task { /** * The spatial reference of the output geometries. If not specified, the output geometries will be in the spatial reference of the input geometries. If [processSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#processSpatialReference) is specified and `outSpatialReference` is not specified, the output geometries will be in the spatial reference of the process spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The spatial reference that the model will use to perform geometry operations. If `processSpatialReference` is specified and [outputSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#outputSpatialReference) is not specified, the output geometries will be in the spatial reference of the process spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#processSpatialReference) */ processSpatialReference: SpatialReference; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#updateDelay) - * + * * @default 1000 */ updateDelay: number; /** * Cancels an asynchronous geoprocessing job. Requires an ArcGIS Server 10.1 service or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#cancelJob) - * + * * @param jobId A string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ cancelJob(jobId: string, requestOptions?: any): IPromise; /** * Cancels the periodic job status updates automatically initiated when [submitJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#submitJob) is invoked for the job identified by `jobId`. You can still obtain the status of this job by calling the [checkJobStatus()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#checkJobStatus) method at your own discretion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#cancelJobStatusUpdates) - * + * * @param jobId A string that uniquely identifies the job for which the job updates are cancelled. - * + * */ cancelJobStatusUpdates(jobId: string): void; /** * Sends a request to the GP Task for the current state of the job identified by `jobId`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#checkJobStatus) - * + * * @param jobId The jobId returned from [JobInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html). * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ checkJobStatus(jobId: string, requestOptions?: any): IPromise; /** * Sends a request to the server to execute a synchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#execute) - * + * * @param params ``` * Specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters: * * `` Input_Points * * `` Distance - * - * - * The `params` argument would then be an Object of the form: + * + * + * The `params` argument would then be an Object of the form: * ``` * { * Input_Points: , * Distance: * } - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(params: any, requestOptions?: any): IPromise; /** * Sends a request to the GP Task to get the task result identified by `jobId` and `resultName`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultData) - * + * * @param jobId The jobId returned from [JobInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html). * @param resultName The name of the result parameter as defined in Services Directory. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getResultData(jobId: string, resultName: string, requestOptions?: any): IPromise; /** * Sends a request to the GP Task to get the task result identified by `jobId` and `resultName` as an image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultImage) - * + * * @param jobId The jobId returned from [JobInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html). * @param resultName The name of the result parameter as defined in the Services Directory. * @param imageParams Specifies the properties of the result image. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getResultImage(jobId: string, resultName: string, imageParams: ImageParameters, requestOptions?: any): IPromise; /** * Get the task result identified by `jobId` as an [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html). This method supports MapImageLayer 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultMapImageLayer) - * + * * @param jobId The jobId returned from [JobInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html). - * + * */ getResultMapImageLayer(jobId: string): MapImageLayer; /** * Submits a job to the server for asynchronous processing by the GP task. The task execution results can be retrieved using the [getResultData()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultData), [getResultImage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultImage), or [getResultMapImageLayer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#getResultMapImageLayer) methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#submitJob) - * + * * @param params ``` * specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters: * * `` Input_Points * * `` Distance - * - * - * The `params` argument would then be an Object of the form: + * + * + * The `params` argument would then be an Object of the form: * ``` * { * Input_Points: , * Distance: * } - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ submitJob(params: any, requestOptions?: any): IPromise; } @@ -29976,21 +29976,21 @@ declare namespace __esri { interface GeoprocessorProperties extends TaskProperties { /** * The spatial reference of the output geometries. If not specified, the output geometries will be in the spatial reference of the input geometries. If [processSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#processSpatialReference) is specified and `outSpatialReference` is not specified, the output geometries will be in the spatial reference of the process spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The spatial reference that the model will use to perform geometry operations. If `processSpatialReference` is specified and [outputSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#outputSpatialReference) is not specified, the output geometries will be in the spatial reference of the process spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#processSpatialReference) */ processSpatialReference?: SpatialReferenceProperties; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Geoprocessor.html#updateDelay) - * + * * @default 1000 */ updateDelay?: number; @@ -29999,19 +29999,19 @@ declare namespace __esri { interface IdentifyTask extends Task { /** * Specifies the geodatabase version to display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-IdentifyTask.html#gdbVersion) */ gdbVersion: string; /** * Sends a request to the ArcGIS REST map service resource to identify features based on the [IdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html) specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-IdentifyTask.html#execute) - * + * * @param params Specifies the criteria used to identify the features. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(params: IdentifyParameters, requestOptions?: any): IPromise; } @@ -30019,7 +30019,7 @@ declare namespace __esri { interface IdentifyTaskConstructor { /** * Performs an identify operation on the layers of a map service exposed by the ArcGIS Server REST API. Use [IdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html) to set the parameters for the identify operation and [IdentifyResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html) to work with the results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-IdentifyTask.html) */ @@ -30031,7 +30031,7 @@ declare namespace __esri { interface IdentifyTaskProperties extends TaskProperties { /** * Specifies the geodatabase version to display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-IdentifyTask.html#gdbVersion) */ gdbVersion?: string; @@ -30040,12 +30040,12 @@ declare namespace __esri { interface ImageServiceIdentifyTask extends Task { /** * Sends a request to the ArcGIS REST image service resource to identify content based on the [ImageServiceIdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html) specified in the `params` argument. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ImageServiceIdentifyTask.html#execute) - * + * * @param params Specifies the criteria used to identify the features. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(params: ImageServiceIdentifyParameters, requestOptions?: any): IPromise; } @@ -30065,28 +30065,28 @@ declare namespace __esri { interface Locator extends Task { /** * Limit the results to one or more categories. For example "Populated Place" or "airport". Only applicable when using the World Geocode Service. View the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#categories) */ categories: string[]; /** * Limits the results to only search in the country provided. For example `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. See the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#countryCode) */ countryCode: string; /** * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Find address candidates for multiple input addresses. This method requires an ArcGIS Server 10.1 or greater geocode service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressesToLocations) - * + * * @param params See specifications below. * @param params.addresses ``` * The input addresses in the format supported by the geocode service. If the service supports 'Single Line Input' the input addresses will be in the following format: @@ -30098,17 +30098,17 @@ declare namespace __esri { * @param params.countryCode Limits the results to only search in the country provided. For example `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. See the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. * @param params.categories Limit result to one or more categories. For example, "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service. See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ addressesToLocations(params: LocatorAddressesToLocationsParams, requestOptions?: any): IPromise; /** * Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) - * + * * @param params Specify at least the address and optionally other properties. See the object specifications table below. * @param params.address visit the ArcGIS Online Geocoding Service help for more details on the World Geocoder. - * The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the associated geocode service resource. For example, if the *addressFields* of a geocode service resource includes fields with the following names: Street, City, State and Zone, then the address argument is of the form: + * The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the associated geocode service resource. For example, if the *addressFields* of a geocode service resource includes fields with the following names: Street, City, State and Zone, then the address argument is of the form: * ```js * { * Street: "1234 W Main St", @@ -30116,16 +30116,16 @@ declare namespace __esri { * State: "WA", * Zone: "99027" * } - * + * * ``` - * + * * Locators published using ArcGIS 10 or later support a single line address field, which * can be specified using the following syntax where field_name is the name of the single * line address field. You can find this name by viewing the help or services directory for * your locator services. Common values are *SingleLine* and *SingleLineFieldName*: - * + * * ```js - * var address = { "field_name": "380 New York St, Redlands, CA 92373" }; + * var address = { "field_name": "380 New York St, Redlands, CA 92373" }; * ``` * The Services Directory can be used to find out the required and optional address fields * and the correct names for the input name fields. If you are using the World Geocoding Service @@ -30139,32 +30139,32 @@ declare namespace __esri { * @param params.outFields The list of fields included in the returned result set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. For non-intersection addresses you can specify the candidate fields as defined in the geocode service. For intersection addresses you can specify the intersection candidate fields. * @param params.searchExtent Defines the extent within which the geocode server will search. Requires ArcGIS Server version 10.1 or greater. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override `requestOptions` defined during construction). - * + * */ addressToLocations(params: LocatorAddressToLocationsParams, requestOptions?: any): IPromise; /** * Locates an address based on a given point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#locationToAddress) - * + * * @param location The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service. * @param distance The distance in meters from the given location within which a matching address should be searched. If this parameter is not provided or an invalid value is provided, a default value of 0 meters is used. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ locationToAddress(location: Point, distance?: number, requestOptions?: any): IPromise; /** * Get character by character auto complete suggestions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) - * + * * @param params An object that defines suggest parameters. See specifications below. * @param params.categories A place or address type which can be used to filter suggest results. The parameter supports input of single category values or multiple comma-separated values. * @param params.distance Used with the `location` property. The `distance` property specifies the radial distance from the location. * @param params.location Defines a normalized location point that is used with the distance parameter to sort geocoding candidates based upon their proximity to the given location. * @param params.text The input text entered by a user which is used by the suggest operation to generate a list of possible matches. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ suggestLocations(params: LocatorSuggestLocationsParams, requestOptions?: any): IPromise; } @@ -30172,7 +30172,7 @@ declare namespace __esri { interface LocatorConstructor { /** * Represents a geocode service resource exposed by the ArcGIS Server REST API. It is used to generate candidates for an address. It is also used to generate batch results for a set of addresses. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html) */ @@ -30184,19 +30184,19 @@ declare namespace __esri { interface LocatorProperties extends TaskProperties { /** * Limit the results to one or more categories. For example "Populated Place" or "airport". Only applicable when using the World Geocode Service. View the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#categories) */ categories?: string[]; /** * Limits the results to only search in the country provided. For example `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. See the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#countryCode) */ countryCode?: string; /** * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; @@ -30212,19 +30212,19 @@ declare namespace __esri { * "Single Line Input":"440 Arguello Blvd, 94118" * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressesToLocations) */ addresses: any[]; /** * Limits the results to only search in the country provided. For example `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. See the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressesToLocations) */ countryCode: string; /** * Limit result to one or more categories. For example, "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service. See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressesToLocations) */ categories: string[]; @@ -30233,7 +30233,7 @@ declare namespace __esri { export interface LocatorAddressToLocationsParams extends Object { /** - * The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the associated geocode service resource. For example, if the *addressFields* of a geocode service resource includes fields with the following names: Street, City, State and Zone, then the address argument is of the form: + * The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the associated geocode service resource. For example, if the *addressFields* of a geocode service resource includes fields with the following names: Street, City, State and Zone, then the address argument is of the form: * ```js * { * Street: "1234 W Main St", @@ -30241,75 +30241,75 @@ declare namespace __esri { * State: "WA", * Zone: "99027" * } - * + * * ``` - * + * * Locators published using ArcGIS 10 or later support a single line address field, which * can be specified using the following syntax where field_name is the name of the single * line address field. You can find this name by viewing the help or services directory for * your locator services. Common values are *SingleLine* and *SingleLineFieldName*: - * + * * ```js - * var address = { "field_name": "380 New York St, Redlands, CA 92373" }; + * var address = { "field_name": "380 New York St, Redlands, CA 92373" }; * ``` * The Services Directory can be used to find out the required and optional address fields * and the correct names for the input name fields. If you are using the World Geocoding Service * visit the ArcGIS Online Geocoding Service help for more details on the World Geocoder. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ address: any; /** * Limit result to one or more categories. For example, "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service. See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ categories: string[]; /** * Limit result to a specific country. For example, "US" for United States or "SE" for Sweden. Only applies to the World Geocode Service. See Geocode coverage (World Geocoding Service) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ countryCode: string; /** * Used in combination with `location` option to weight returned results within this distance (meters). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ distance: number; /** * Allows the results of single geocode transactions to be persisted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ forStorage: boolean; /** * Used in combination with `distance` option to weight returned results for a specified area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ location: Point; /** * A `suggestLocations` result ID (magicKey). Used to query for a specific results information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ magicKey: string; /** * Maximum results to return from the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ maxLocations: number; /** * The list of fields included in the returned result set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. For non-intersection addresses you can specify the candidate fields as defined in the geocode service. For intersection addresses you can specify the intersection candidate fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ outFields: string[]; /** * Defines the extent within which the geocode server will search. Requires ArcGIS Server version 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations) */ searchExtent: Extent; @@ -30319,25 +30319,25 @@ declare namespace __esri { export interface LocatorSuggestLocationsParams extends Object { /** * A place or address type which can be used to filter suggest results. The parameter supports input of single category values or multiple comma-separated values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) */ categories: string[]; /** * Used with the `location` property. The `distance` property specifies the radial distance from the location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) */ distance: number; /** * Defines a normalized location point that is used with the distance parameter to sort geocoding candidates based upon their proximity to the given location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) */ location: Point; /** * The input text entered by a user which is used by the suggest operation to generate a list of possible matches. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) */ text: string; @@ -30345,25 +30345,25 @@ declare namespace __esri { /** * Describes the object representing the result of the [suggestLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#suggestLocations) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#SuggestionResult) */ export interface SuggestionResult extends Object { /** * Indicates if the result is a Collection. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#SuggestionResult) */ isCollection: boolean; /** * ID used in combination with the `text` property to uniquely identify a suggestion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#SuggestionResult) */ magicKey: string; /** * The string name of the suggested location to geocode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#SuggestionResult) */ text: string; @@ -30372,29 +30372,29 @@ declare namespace __esri { interface PrintTask extends Task { /** * The mode for the print task execution. **Possible Values:** async | sync - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#mode) - * + * * @default sync */ readonly mode: string; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#updateDelay) - * + * * @default 1000 */ updateDelay: number; /** * Sends a request to the print service to create a printable static image of the map using the options specified in the [PrintParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#execute) - * + * * @param params Defines the printing options. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(params: PrintParameters, requestOptions?: any): IPromise; } @@ -30402,7 +30402,7 @@ declare namespace __esri { interface PrintTaskConstructor { /** * The PrintTask generates a printer-ready version of the map using an [Export Web Map Task](https://developers.arcgis.com/rest/services-reference/export-web-map-task.htm) available with ArGIS Server 10.1 and later. This class is used when you want to have more granular control over the user interface, for example, if you want to provide users the ability to define what appears on the printed page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html) */ @@ -30414,9 +30414,9 @@ declare namespace __esri { interface PrintTaskProperties extends TaskProperties { /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#updateDelay) - * + * * @default 1000 */ updateDelay?: number; @@ -30424,13 +30424,13 @@ declare namespace __esri { /** * Represents the reponse of the [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#execute) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#PrintResponse) */ export interface PrintResponse extends Object { /** * URL pointing to the location of the generated printout of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html#PrintResponse) */ url: string; @@ -30439,69 +30439,69 @@ declare namespace __esri { interface QueryTask extends Task { /** * Specify the geodatabase version to query. Requires ArcGIS Server service 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#gdbVersion) */ gdbVersion: string; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the layer specified in the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#url). The result is returned as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which can be accessed using the `.then()` method. A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) contains an array of [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) features, which can be added to the map. This array will not be populated if no results are found. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#execute) - * + * * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ execute(query: Query | QueryProperties, requestOptions?: any): IPromise; /** * Query information about attachments associated with features from a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) specified in the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#url). It will return an error if the layer does not support [attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeAttachmentQuery) - * + * * @param attachmentQuery Specifies the attachment parameters for query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeAttachmentQuery(attachmentQuery: AttachmentQuery | AttachmentQueryProperties, requestOptions?: any): IPromise; /** * Gets a count of the number of features that satisfy the input query. Valid for layers published with 10.0 SP1. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeForCount) - * + * * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeForCount(query: Query | QueryProperties, requestOptions?: any): IPromise; /** * Gets the extent of the features that satisfy the input query. The count of features that satisfy the input query is returned upon resolution as well. At 10.3, this option is only available for [hosted feature services](https://doc.arcgis.com/en/arcgis-online/share-maps/hosted-web-layers.htm). At 10.3.1, this option is available for all feature services and map service layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeForExtent) - * + * * @param params Specifies the attributes and spatial filter of the query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeForExtent(params: Query, requestOptions?: any): IPromise; /** * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against the layer specified in the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#url). The result is an array of the object IDs of features that satisfy the input query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeForIds) - * + * * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeForIds(query: Query | QueryProperties, requestOptions?: any): IPromise; /** * Executes a [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html) against the layer or table specified in the [url](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#url). If the query is successful, the returned results are [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) grouped by source layer or table objectIds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeRelationshipQuery) - * + * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeRelationshipQuery(relationshipQuery: RelationshipQuery | RelationshipQueryProperties, requestOptions?: any): IPromise; } @@ -30509,7 +30509,7 @@ declare namespace __esri { interface QueryTaskConstructor { /** * Executes different types of query operations on a layer. The most common method used in this class is [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#execute), which executes the query as defined in the [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) object that is passed as a parameter to the function. `QueryTask.execute()` returns a Promise that resolves to a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html), which contains the features in the layer that satisfy the [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html) */ @@ -30521,7 +30521,7 @@ declare namespace __esri { interface QueryTaskProperties extends TaskProperties { /** * Specify the geodatabase version to query. Requires ArcGIS Server service 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#gdbVersion) */ gdbVersion?: string; @@ -30529,43 +30529,43 @@ declare namespace __esri { /** * The AttachmentInfo returns information about attachments associated with a feature. This resource is available only if the [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) has attachments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ export interface AttachmentInfo extends Object { /** * The content type of the attachment. For example, `image/jpeg`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) for more information on supported attachment types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ contentType: string; /** * The identifier for the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ id: number; /** * The name of the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ name: string; /** * The parent or the feature object id of the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ parentObjectId: number; /** * The size of the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ size: number; /** * The URL of the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#AttachmentInfo) */ url: string; @@ -30574,12 +30574,12 @@ declare namespace __esri { interface RouteTask extends Task { /** * Solves the route against the route layer with the route parameters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html#solve) - * + * * @param params Route parameters used as input to generate the route. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ solve(params: RouteParameters, requestOptions?: any): IPromise; } @@ -30587,7 +30587,7 @@ declare namespace __esri { interface RouteTaskConstructor { /** * Find routes between two or more locations and optionally get driving directions. The RouteTask uses ArcGIS Server network analysis services to calculate routes. Network analysis services allow you to solve simple routing problems as well as complex ones that take into account multiple stops, barriers, and time windows. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) */ @@ -30603,12 +30603,12 @@ declare namespace __esri { interface ServiceAreaTask extends Task { /** * Determines the service area based on a set of parameters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html#solve) - * + * * @param params The parameters needed to define the service area. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ solve(params: ServiceAreaParameters, requestOptions?: any): IPromise; } @@ -30616,7 +30616,7 @@ declare namespace __esri { interface ServiceAreaTaskConstructor { /** * ServiceAreaTask helps you find service areas around any location on a network. A network service area is a region that encompasses all accessible streets (streets that are within a specified impedance). For instance, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html) */ @@ -30632,31 +30632,31 @@ declare namespace __esri { interface AddressCandidate extends Accessor, JSONSupport { /** * Address of the candidate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#address) */ address: string; /** * Name value pairs of field name and field value as defined in `outFields` in [Locator.addressToLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#attributes) */ attributes: any; /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#extent) */ extent: Extent; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object representing the location of the [address](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#address). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#location) */ location: Point; /** * Numeric score between `0` and `100` for geocode candidates. A candidate with a score of `100` means a perfect match, and `0` means no match. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#score) */ score: number; @@ -30675,31 +30675,31 @@ declare namespace __esri { interface AddressCandidateProperties { /** * Address of the candidate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#address) */ address?: string; /** * Name value pairs of field name and field value as defined in `outFields` in [Locator.addressToLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html#addressToLocations). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#attributes) */ attributes?: any; /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#extent) */ extent?: ExtentProperties; /** * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object representing the location of the [address](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#address). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#location) */ location?: PointProperties; /** * Numeric score between `0` and `100` for geocode candidates. A candidate with a score of `100` means a perfect match, and `0` means no match. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AddressCandidate.html#score) */ score?: number; @@ -30708,42 +30708,42 @@ declare namespace __esri { interface AreasAndLengthsParameters extends Accessor { /** * The area unit in which areas of polygons will be calculated. Use the strings listed below or [any other valid area unit](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | hectares | square-miles | square-kilometers | square-meters | square-feet | square-yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#areaUnit) */ areaUnit: string; /** - * Defines the type of calculation for the geometry. The type can be one of the following: - * + * Defines the type of calculation for the geometry. The type can be one of the following: + * * Value | Description * ------|------------ * planar | Planar measurements use 2D Cartesian mathematics to calculate length. Use this type if the length needs to be calculated in the input spatial reference. Otherwise use `preserveShape`. * geodesic | Use this type to calculate an area or length using only the vertices of the polygon to define the lines connecting the vertices as geodesic segments independent of the actual shape of the polygon. **Note:** a geodesic segment is the shortest path between two points on an ellipsoid. * preserve-shape | Calculate the area or length of the geometry on the surface of the Earth ellipsoid (for geometries defined in a projected or geographic coordinate system). This method preserves the shape of the geometry in its coordinate system, which means the true area or length will be calculated for the geometry that is displayed on the map. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#calculationType) */ calculationType: string; /** * The length unit in which perimeters of polygons will be calculated. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#lengthUnit) */ lengthUnit: string; /** * Polygon geometries for which to compute areas and lengths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#polygons) */ polygons: Polygon[]; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -30759,32 +30759,32 @@ declare namespace __esri { interface AreasAndLengthsParametersProperties { /** * The area unit in which areas of polygons will be calculated. Use the strings listed below or [any other valid area unit](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.AreaUnit.Code.ACRE). **Possible Values:** acres | hectares | square-miles | square-kilometers | square-meters | square-feet | square-yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#areaUnit) */ areaUnit?: string; /** - * Defines the type of calculation for the geometry. The type can be one of the following: - * + * Defines the type of calculation for the geometry. The type can be one of the following: + * * Value | Description * ------|------------ * planar | Planar measurements use 2D Cartesian mathematics to calculate length. Use this type if the length needs to be calculated in the input spatial reference. Otherwise use `preserveShape`. * geodesic | Use this type to calculate an area or length using only the vertices of the polygon to define the lines connecting the vertices as geodesic segments independent of the actual shape of the polygon. **Note:** a geodesic segment is the shortest path between two points on an ellipsoid. * preserve-shape | Calculate the area or length of the geometry on the surface of the Earth ellipsoid (for geometries defined in a projected or geographic coordinate system). This method preserves the shape of the geometry in its coordinate system, which means the true area or length will be calculated for the geometry that is displayed on the map. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#calculationType) */ calculationType?: string; /** * The length unit in which perimeters of polygons will be calculated. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#lengthUnit) */ lengthUnit?: string; /** * Polygon geometries for which to compute areas and lengths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AreasAndLengthsParameters.html#polygons) */ polygons?: PolygonProperties[]; @@ -30793,53 +30793,53 @@ declare namespace __esri { interface AttachmentQuery extends Accessor, JSONSupport { /** * The file format that is supported by query attachment. For example, `image/jpeg`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) for more information on supported attachment types. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#attachmentTypes) */ attachmentTypes: string[]; /** * The definition expression to be applied to the layer. Only features that satisfy the definition expression and are in the list of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds) will be returned. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#definitionExpression) */ definitionExpression: string; /** * An array of globalIds for the features in the layer being queried. The query results will return attachments only for specified global ids. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#globalIds) */ globalIds: number[]; /** * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). Default Value is `10`. If not provided, but an instance of AttachmentQuery has a `start` property, then the default value of `num` is `maxRecordCount`. The maximum value for this parameter is the value of the layer's `maxRecordCount` of the service, which can be found at the REST endpoint of the feature layer. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#num) */ num: number; /** * An array of objectIds of the features to be queried for attachments. When the feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property is `false`, it only accepts a single `objectId`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds) */ objectIds: number[]; /** * The file size of the attachment is specified in bytes. You can enter a file size range [1000,15000] to query for attachments. The query result will return all attachments within the specified file size range (1000 - 15000). Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#size) */ size: number[]; /** * This option fetches query results by skipping a specified number of records. The query results start from the next record. The default value is `0`. This parameter only applies when the feature layer's [capabilities.query.supportsPagination](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is `true`. You can use this option to fetch records that are beyond `maxRecordCount`. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#start) */ start: number; /** * Creates a deep clone of AttachmentQuery object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#clone) - * - * + * + * */ clone(): AttachmentQuery; } @@ -30847,7 +30847,7 @@ declare namespace __esri { interface AttachmentQueryConstructor { /** * This class defines parameters for executing queries for feature attachments from a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). Once an AttachmentQuery object's properties are defined, it can then be passed into the [QueryTask.executeAttachmentQuery()](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeAttachmentQuery) or [FeatureLayer.queryAttachments()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttachments) methods, which will return attachmentInfos grouped by the source feature objectIds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html) */ @@ -30861,43 +30861,43 @@ declare namespace __esri { interface AttachmentQueryProperties { /** * The file format that is supported by query attachment. For example, `image/jpeg`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-attachments-feature-service-layer-.htm) for more information on supported attachment types. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#attachmentTypes) */ attachmentTypes?: string[]; /** * The definition expression to be applied to the layer. Only features that satisfy the definition expression and are in the list of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds) will be returned. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#definitionExpression) */ definitionExpression?: string; /** * An array of globalIds for the features in the layer being queried. The query results will return attachments only for specified global ids. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#globalIds) */ globalIds?: number[]; /** * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). Default Value is `10`. If not provided, but an instance of AttachmentQuery has a `start` property, then the default value of `num` is `maxRecordCount`. The maximum value for this parameter is the value of the layer's `maxRecordCount` of the service, which can be found at the REST endpoint of the feature layer. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#num) */ num?: number; /** * An array of objectIds of the features to be queried for attachments. When the feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property is `false`, it only accepts a single `objectId`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#objectIds) */ objectIds?: number[]; /** * The file size of the attachment is specified in bytes. You can enter a file size range [1000,15000] to query for attachments. The query result will return all attachments within the specified file size range (1000 - 15000). Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#size) */ size?: number[]; /** * This option fetches query results by skipping a specified number of records. The query results start from the next record. The default value is `0`. This parameter only applies when the feature layer's [capabilities.query.supportsPagination](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is `true`. You can use this option to fetch records that are beyond `maxRecordCount`. Requires an ArcGIS Server service 10.5 or greater and feature layer's [capabilities.query.supportsAttachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) to be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-AttachmentQuery.html#start) */ start?: number; @@ -30906,53 +30906,53 @@ declare namespace __esri { interface BufferParameters extends Accessor { /** * The spatial reference in which the geometries are buffered. If `bufferSpatialReference` is not specified, the geometries are buffered in the spatial reference specified by `outSpatialReference`. If `outSpatialReference` is also not specified, they are buffered in the spatial reference of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#bufferSpatialReference) */ bufferSpatialReference: SpatialReference; /** * The distances the input features are buffered. The distance units are specified by `unit`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#distances) */ distances: number[]; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to generate a buffer polygon using a geodesic distance. The `bufferSpatialReference` property is ignored when geodesic is set to `true`. Requires ArcGIS Server 10.1 or greater geometry service. For more information, see the ArcGIS REST API documentation on the GeometryService buffer operation and the geodesic property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#geodesic) */ geodesic: boolean; /** * The input geometries to buffer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#geometries) */ geometries: Geometry[]; /** * The spatial reference for the returned geometries. If `outSpatialReference` is not specified, the output geometries are in the spatial reference specified by `bufferSpatialReference`. If `bufferSpatialReference` also is not specified, they are in the spatial reference of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * If `true`, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#unionResults) */ unionResults: boolean; /** * The units for calculating each buffer distance. If `unit` is not specified, the units are derived from `bufferSpatialReference`. If `bufferSpatialReference` is not specified, the units are derived from the features. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#unit) */ unit: string; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -30968,43 +30968,43 @@ declare namespace __esri { interface BufferParametersProperties { /** * The spatial reference in which the geometries are buffered. If `bufferSpatialReference` is not specified, the geometries are buffered in the spatial reference specified by `outSpatialReference`. If `outSpatialReference` is also not specified, they are buffered in the spatial reference of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#bufferSpatialReference) */ bufferSpatialReference?: SpatialReferenceProperties; /** * The distances the input features are buffered. The distance units are specified by `unit`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#distances) */ distances?: number[]; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to generate a buffer polygon using a geodesic distance. The `bufferSpatialReference` property is ignored when geodesic is set to `true`. Requires ArcGIS Server 10.1 or greater geometry service. For more information, see the ArcGIS REST API documentation on the GeometryService buffer operation and the geodesic property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#geodesic) */ geodesic?: boolean; /** * The input geometries to buffer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The spatial reference for the returned geometries. If `outSpatialReference` is not specified, the output geometries are in the spatial reference specified by `bufferSpatialReference`. If `bufferSpatialReference` also is not specified, they are in the spatial reference of the features. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * If `true`, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#unionResults) */ unionResults?: boolean; /** * The units for calculating each buffer distance. If `unit` is not specified, the units are derived from `bufferSpatialReference`. If `bufferSpatialReference` is not specified, the units are derived from the features. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-BufferParameters.html#unit) */ unit?: string; @@ -31013,241 +31013,241 @@ declare namespace __esri { interface ClosestFacilityParameters extends Accessor { /** * The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#accumulateAttributes) */ accumulateAttributes: string[]; /** * An array of attribute parameter values that determine which network elements can be used by a vehicle. View the object specifications below for properties of the individual objects in this array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#attributeParameterValues) */ attributeParameterValues: ClosestFacilityParametersAttributeParameterValues[]; /** * The cutoff value used to determine when to stop traversing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#defaultCutoff) */ defaultCutoff: number; /** * The number of facilities to find. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#defaultTargetFacilityCount) */ defaultTargetFacilityCount: number; /** * The language used when generating driving directions. This parameter applies only when [returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) parameter is set to `true`. If an unsupported language code is specified, the service returns the directions using the default language, English. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsLanguage) */ directionsLanguage: string; /** * The length units used when computing driving directions. This parameter applies only when [returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) parameter is set to `true`. If not specified the task will use the value defined by the routing network layer is used. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsLengthUnits) */ directionsLengthUnits: string; /** * Defines the amount of direction information returned. The default value is standard. **Possible Values:** complete | complete-no-events | instructions-only | standard | summary-only - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsOutputType) */ directionsOutputType: string; /** * The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsStyleName) */ directionsStyleName: string; /** * The name of the attribute field that contains the drive time values. If not specified, the task will use the attribute field defined by the routing network layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsTimeAttribute) */ directionsTimeAttribute: string; /** * When `true`, restricted network elements should be considered when finding network locations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements: boolean; /** * The set of facilities loaded as network locations during analysis. These can be specified as either a [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#facilities) */ facilities: DataLayer | FeatureSet; /** * The network attribute name used as the impedance attribute in analysis. The default is as defined in the routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set `impedanceAttribute = 'Time'` for quickest route and `impedanceAttribute = 'Length'` for shortest drive, assuming the service has those two esriNAUTCost attributes. View the [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm) ArcGIS desktop help topic for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#impedanceAttribute) */ impedanceAttribute: string; /** * The set of incidents loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#incidents) */ incidents: DataLayer | FeatureSet; /** * The output geometry precision. When `0`, no generalization of the output geometry is performed. Positive values represent the `MaximumAllowableOffset` parameter used by generalize. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: string; /** - * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your RouteTask. - * + * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your RouteTask. + * * Possible Value | Description * ---------------|------------ * none | No lines are returned * straight | Only returns straight lines * true-shape | Return the true shape of the lines * true-shape-with-measure | Return the true shape of the lines with their measurements - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputLines) */ outputLines: string; /** * The well-known id of the spatial reference or the spatial reference object for the geometries returned with the analysis results. If `outSpatialReference` is not specified, the geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference | string; /** * The set of point barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#pointBarriers) */ pointBarriers: DataLayer | FeatureSet; /** * The set of polygon barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#polygonBarriers) */ polygonBarriers: DataLayer | FeatureSet; /** * The set of polyline barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#polylineBarriers) */ polylineBarriers: DataLayer | FeatureSet; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under Network Dataset > Network Attributes. You can also specify a value of none to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. Use `["none"]` to override the service defaults and specify that no restrictions should be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#restrictionAttributes) */ restrictionAttributes: string[]; /** * Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your module:"esri/tasks/ClosestFacilityTask". **Possible Values:** allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#restrictUTurns) */ restrictUTurns: string; /** * Indicates whether the service should generate driving directions for each route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) - * + * * @default false */ returnDirections: boolean; /** * If `true`, facilities will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnFacilities) - * + * * @default false */ returnFacilities: boolean; /** * If `true`, incidents will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnIncidents) - * + * * @default false */ returnIncidents: boolean; /** * If `true`, point barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPointBarriers) - * + * * @default false */ returnPointBarriers: boolean; /** * If `true`, polygon barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers: boolean; /** * If `true`, polyline barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers: boolean; /** * When `true`, closest facility routes will be generated and returned in the route property of each [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnRoutes) - * + * * @default true */ returnRoutes: boolean; /** * The arrival or departure date and time. For example, if the travelDirection is set to `to-facility` and `timeOfDayUsage` is set to `end` and `timeOfDay` is set to 8:00 a.m., the returned route(s) will be setup to arrive at the facility at 8:00 a.m. local time. *Requires ArcGIS Server service version 10.1 or greater.* - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#timeOfDay) */ timeOfDay: Date; /** * Defines the way the `timeOfDay` value is used. The default value is defined in the network layer. *Requires ArcGIS Server service version 10.1 or greater.* **Possible Values:** start | end - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#timeOfDayUsage) */ timeOfDayUsage: string; /** - * Options for traveling to or from the facility. Default values are defined by the network layer. - * + * Options for traveling to or from the facility. Default values are defined by the network layer. + * * Possible Value | Description * ---------------|------------ * from-facility | Sets travel direction from the facility * to-facility | Sets travel direction to the facility - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#travelDirection) */ travelDirection: string; /** * If `true`, the hierarchy attribute for the network will be used in analysis. The default is defined in the routing network layer used by the [ClosestFacilityTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#useHierarchy) - * + * * @default false */ useHierarchy: boolean; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -31255,7 +31255,7 @@ declare namespace __esri { interface ClosestFacilityParametersConstructor { /** * Input parameters for [ClosestFacilityTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html) */ @@ -31267,231 +31267,231 @@ declare namespace __esri { interface ClosestFacilityParametersProperties { /** * The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#accumulateAttributes) */ accumulateAttributes?: string[]; /** * An array of attribute parameter values that determine which network elements can be used by a vehicle. View the object specifications below for properties of the individual objects in this array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#attributeParameterValues) */ attributeParameterValues?: ClosestFacilityParametersAttributeParameterValues[]; /** * The cutoff value used to determine when to stop traversing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#defaultCutoff) */ defaultCutoff?: number; /** * The number of facilities to find. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#defaultTargetFacilityCount) */ defaultTargetFacilityCount?: number; /** * The language used when generating driving directions. This parameter applies only when [returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) parameter is set to `true`. If an unsupported language code is specified, the service returns the directions using the default language, English. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsLanguage) */ directionsLanguage?: string; /** * The length units used when computing driving directions. This parameter applies only when [returnDirections](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) parameter is set to `true`. If not specified the task will use the value defined by the routing network layer is used. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsLengthUnits) */ directionsLengthUnits?: string; /** * Defines the amount of direction information returned. The default value is standard. **Possible Values:** complete | complete-no-events | instructions-only | standard | summary-only - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsOutputType) */ directionsOutputType?: string; /** * The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsStyleName) */ directionsStyleName?: string; /** * The name of the attribute field that contains the drive time values. If not specified, the task will use the attribute field defined by the routing network layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#directionsTimeAttribute) */ directionsTimeAttribute?: string; /** * When `true`, restricted network elements should be considered when finding network locations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements?: boolean; /** * The set of facilities loaded as network locations during analysis. These can be specified as either a [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#facilities) */ facilities?: DataLayerProperties | FeatureSetProperties; /** * The network attribute name used as the impedance attribute in analysis. The default is as defined in the routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set `impedanceAttribute = 'Time'` for quickest route and `impedanceAttribute = 'Length'` for shortest drive, assuming the service has those two esriNAUTCost attributes. View the [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm) ArcGIS desktop help topic for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#impedanceAttribute) */ impedanceAttribute?: string; /** * The set of incidents loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#incidents) */ incidents?: DataLayerProperties | FeatureSetProperties; /** * The output geometry precision. When `0`, no generalization of the output geometry is performed. Positive values represent the `MaximumAllowableOffset` parameter used by generalize. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: string; /** - * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your RouteTask. - * + * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your RouteTask. + * * Possible Value | Description * ---------------|------------ * none | No lines are returned * straight | Only returns straight lines * true-shape | Return the true shape of the lines * true-shape-with-measure | Return the true shape of the lines with their measurements - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outputLines) */ outputLines?: string; /** * The well-known id of the spatial reference or the spatial reference object for the geometries returned with the analysis results. If `outSpatialReference` is not specified, the geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties | string; /** * The set of point barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#pointBarriers) */ pointBarriers?: DataLayerProperties | FeatureSetProperties; /** * The set of polygon barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#polygonBarriers) */ polygonBarriers?: DataLayerProperties | FeatureSetProperties; /** * The set of polyline barriers loaded as network locations during analysis. Can be an instance of [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) or [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#polylineBarriers) */ polylineBarriers?: DataLayerProperties | FeatureSetProperties; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under Network Dataset > Network Attributes. You can also specify a value of none to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. Use `["none"]` to override the service defaults and specify that no restrictions should be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#restrictionAttributes) */ restrictionAttributes?: string[]; /** * Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your module:"esri/tasks/ClosestFacilityTask". **Possible Values:** allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#restrictUTurns) */ restrictUTurns?: string; /** * Indicates whether the service should generate driving directions for each route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnDirections) - * + * * @default false */ returnDirections?: boolean; /** * If `true`, facilities will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnFacilities) - * + * * @default false */ returnFacilities?: boolean; /** * If `true`, incidents will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnIncidents) - * + * * @default false */ returnIncidents?: boolean; /** * If `true`, point barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPointBarriers) - * + * * @default false */ returnPointBarriers?: boolean; /** * If `true`, polygon barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers?: boolean; /** * If `true`, polyline barriers will be returned in the barriers property of the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers?: boolean; /** * When `true`, closest facility routes will be generated and returned in the route property of each [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#returnRoutes) - * + * * @default true */ returnRoutes?: boolean; /** * The arrival or departure date and time. For example, if the travelDirection is set to `to-facility` and `timeOfDayUsage` is set to `end` and `timeOfDay` is set to 8:00 a.m., the returned route(s) will be setup to arrive at the facility at 8:00 a.m. local time. *Requires ArcGIS Server service version 10.1 or greater.* - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#timeOfDay) */ timeOfDay?: DateProperties; /** * Defines the way the `timeOfDay` value is used. The default value is defined in the network layer. *Requires ArcGIS Server service version 10.1 or greater.* **Possible Values:** start | end - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#timeOfDayUsage) */ timeOfDayUsage?: string; /** - * Options for traveling to or from the facility. Default values are defined by the network layer. - * + * Options for traveling to or from the facility. Default values are defined by the network layer. + * * Possible Value | Description * ---------------|------------ * from-facility | Sets travel direction from the facility * to-facility | Sets travel direction to the facility - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#travelDirection) */ travelDirection?: string; /** * If `true`, the hierarchy attribute for the network will be used in analysis. The default is defined in the routing network layer used by the [ClosestFacilityTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#useHierarchy) - * + * * @default false */ useHierarchy?: boolean; @@ -31501,19 +31501,19 @@ declare namespace __esri { export interface ClosestFacilityParametersAttributeParameterValues extends Object { /** * The name of the attribute. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#attributeParameterValues) */ attributeName: string; /** * The parameter name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#attributeParameterValues) */ parameterName: string; /** * The parameter value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilityParameters.html#attributeParameterValues) */ value: string; @@ -31522,49 +31522,49 @@ declare namespace __esri { interface ClosestFacilitySolveResult extends Accessor, JSONSupport { /** * An array of directions. A direction is an instance of [DirectionsFeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html). Route directions are returned if `returnDirections = true` (default is false). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#directions) */ directions: DirectionsFeatureSet; /** * An array of points representing facilities. Only returned when `ClosestFacilityParameters.returnFacilities = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#facilities) */ facilities: Point[]; /** * An array of points representing incidents. Only returned when `ClosestFacilityParameters.returnIncidents = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#incidents) */ incidents: Point[]; /** * Message received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#messages) */ messages: NAMessage[]; /** * The point barriers are an array of points. They are returned only if `ClosestFacilityParameters.returnPointBarriers` was set to `true` (which is not the default). If you send in the point barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#pointBarriers) */ pointBarriers: Point[]; /** * The polygon barriers are an array of polygons. They are returned only if `ClosestFacilityParameters.returnPolygonBarriers` was set to `true` (which is not the default). If you send in the polygon barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#polygonBarriers) */ polygonBarriers: Polygon[]; /** * The polyline barriers are an array of polylines. They are returned only if `ClosestFacilityParameters.returnPolylineBarriers` was set to `true` (which is not the default). If you send in the polyline barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#polylineBarriers) */ polylineBarriers: Polyline[]; /** * The array of routes. Route graphics are returned if `returnRoutes = true` and `outputLines` does not equal `none`. From version 2.0 to 2.5 the type is an array of Polylines. At version 2.6 the type is an array of Graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#routes) */ routes: Graphic[]; @@ -31573,7 +31573,7 @@ declare namespace __esri { interface ClosestFacilitySolveResultConstructor { /** * The result from [ClosestFacilityTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ClosestFacilityTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html) */ @@ -31587,49 +31587,49 @@ declare namespace __esri { interface ClosestFacilitySolveResultProperties { /** * An array of directions. A direction is an instance of [DirectionsFeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html). Route directions are returned if `returnDirections = true` (default is false). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#directions) */ directions?: DirectionsFeatureSetProperties; /** * An array of points representing facilities. Only returned when `ClosestFacilityParameters.returnFacilities = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#facilities) */ facilities?: PointProperties[]; /** * An array of points representing incidents. Only returned when `ClosestFacilityParameters.returnIncidents = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#incidents) */ incidents?: PointProperties[]; /** * Message received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#messages) */ messages?: NAMessageProperties[]; /** * The point barriers are an array of points. They are returned only if `ClosestFacilityParameters.returnPointBarriers` was set to `true` (which is not the default). If you send in the point barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#pointBarriers) */ pointBarriers?: PointProperties[]; /** * The polygon barriers are an array of polygons. They are returned only if `ClosestFacilityParameters.returnPolygonBarriers` was set to `true` (which is not the default). If you send in the polygon barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#polygonBarriers) */ polygonBarriers?: PolygonProperties[]; /** * The polyline barriers are an array of polylines. They are returned only if `ClosestFacilityParameters.returnPolylineBarriers` was set to `true` (which is not the default). If you send in the polyline barriers as a FeatureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#polylineBarriers) */ polylineBarriers?: PolylineProperties[]; /** * The array of routes. Route graphics are returned if `returnRoutes = true` and `outputLines` does not equal `none`. From version 2.0 to 2.5 the type is an array of Polylines. At version 2.6 the type is an array of Graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ClosestFacilitySolveResult.html#routes) */ routes?: GraphicProperties[]; @@ -31638,13 +31638,13 @@ declare namespace __esri { interface DataFile extends Accessor, JSONSupport { /** * The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater services that support uploads, this class can be used to specify an uploaded item as input by specifying the ItemID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html#itemId) */ itemId: string; /** * URL to the location of the data file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html#url) */ url: string; @@ -31663,13 +31663,13 @@ declare namespace __esri { interface DataFileProperties { /** * The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater services that support uploads, this class can be used to specify an uploaded item as input by specifying the ItemID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html#itemId) */ itemId?: string; /** * URL to the location of the data file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html#url) */ url?: string; @@ -31678,19 +31678,19 @@ declare namespace __esri { interface DataLayer extends Accessor { /** * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#spatialRelationship) is applied to this geometry while performing the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#geometry) */ geometry: Geometry; /** * The name of the data layer in the map service that is being referenced. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#name) */ name: string; /** - * The spatial relationship to be applied on the input geometry while performing the query. - * + * The spatial relationship to be applied on the input geometry while performing the query. + * * Possible Value | Description * ---------------|------------ * intersects | Part of a feature from feature class 1 is contained in a feature from feature class 2. @@ -31702,24 +31702,24 @@ declare namespace __esri { * touches | The feature from feature class 1 touches the border of a feature from feature class 2. * within | The feature from feature class 1 is completely enclosed by the feature from feature class 2. * relation | Allows specification of any relationship defined using the [Shape Comparison Language](http://resources.esri.com/help/9.3/arcgisengine/dotnet/concepts_start.htm#40de6491-9b2d-440d-848b-2609efcd46b1.htm). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#spatialRelationship) */ spatialRelationship: string; /** * A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#where) */ where: string; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -31727,7 +31727,7 @@ declare namespace __esri { interface DataLayerConstructor { /** * Input for properties of ClosestFacilityParameters,RouteParameters or ServiceAreaParameters. The DataLayer can be used to define the following for each paramater type: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html) */ @@ -31739,19 +31739,19 @@ declare namespace __esri { interface DataLayerProperties { /** * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#spatialRelationship) is applied to this geometry while performing the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#geometry) */ geometry?: GeometryProperties; /** * The name of the data layer in the map service that is being referenced. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#name) */ name?: string; /** - * The spatial relationship to be applied on the input geometry while performing the query. - * + * The spatial relationship to be applied on the input geometry while performing the query. + * * Possible Value | Description * ---------------|------------ * intersects | Part of a feature from feature class 1 is contained in a feature from feature class 2. @@ -31763,14 +31763,14 @@ declare namespace __esri { * touches | The feature from feature class 1 touches the border of a feature from feature class 2. * within | The feature from feature class 1 is completely enclosed by the feature from feature class 2. * relation | Allows specification of any relationship defined using the [Shape Comparison Language](http://resources.esri.com/help/9.3/arcgisengine/dotnet/concepts_start.htm#40de6491-9b2d-440d-848b-2609efcd46b1.htm). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#spatialRelationship) */ spatialRelationship?: string; /** * A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html#where) */ where?: string; @@ -31779,15 +31779,15 @@ declare namespace __esri { interface supportDate extends Accessor, JSONSupport { /** * Date value returned from server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Date.html#date) */ date: Date; /** * The format of the date used in the date property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Date.html#format) - * + * * @default EEE MMM dd HH:mm:ss zzz yyyy */ format: string; @@ -31806,15 +31806,15 @@ declare namespace __esri { interface supportDateProperties { /** * Date value returned from server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Date.html#date) */ date?: DateProperties; /** * The format of the date used in the date property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Date.html#format) - * + * * @default EEE MMM dd HH:mm:ss zzz yyyy */ format?: string; @@ -31823,35 +31823,35 @@ declare namespace __esri { interface DensifyParameters extends Accessor { /** * If `true`, Geographic Coordinate System spatial references are used or densify geodesic will be performed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#geodesic) */ geodesic: boolean; /** * The array of geometries to be densified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#geometries) */ geometries: Geometry[]; /** * The length unit of `maxSegmentLength`. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#lengthUnit) */ lengthUnit: string; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines no longer than `maxSegmentLength.` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#maxSegmentLength) */ maxSegmentLength: number; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -31867,25 +31867,25 @@ declare namespace __esri { interface DensifyParametersProperties { /** * If `true`, Geographic Coordinate System spatial references are used or densify geodesic will be performed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#geodesic) */ geodesic?: boolean; /** * The array of geometries to be densified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The length unit of `maxSegmentLength`. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#lengthUnit) */ lengthUnit?: string; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines no longer than `maxSegmentLength.` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DensifyParameters.html#maxSegmentLength) */ maxSegmentLength?: number; @@ -31894,49 +31894,49 @@ declare namespace __esri { interface DirectionsFeatureSet extends FeatureSet, Accessor { /** * The extent of the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#extent) */ extent: Extent; /** * A single polyline representing the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#mergedGeometry) */ mergedGeometry: Polyline; /** * The ID of the route returned from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#routeId) */ routeId: string; /** * Name specified in [RouteParameters.stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#stops). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#routeName) */ routeName: string; /** * Lists additional information about the directions depending on the value of [RouteParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsOutputType). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#strings) */ strings: any[]; /** * Actual drive time calculated for the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalDriveTime) */ totalDriveTime: number; /** * The length of the route as specified in the units set in [RouteParameters.directionsLengthUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLengthUnits). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalLength) */ totalLength: number; /** * The total time calculated for the route as specified in the units set in [RouteParameters.directionsTimeAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsTimeAttribute). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalTime) */ totalTime: number; @@ -31945,7 +31945,7 @@ declare namespace __esri { interface DirectionsFeatureSetConstructor { /** * A [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) that has properties specific to routing. The [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#features) property contains the turn by turn directions text and geometry of the route. The attributes for each feature provide information associated with the corresponding route segment. The following attributes are returned: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html) */ @@ -31959,49 +31959,49 @@ declare namespace __esri { interface DirectionsFeatureSetProperties extends FeatureSetProperties { /** * The extent of the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#extent) */ extent?: ExtentProperties; /** * A single polyline representing the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#mergedGeometry) */ mergedGeometry?: PolylineProperties; /** * The ID of the route returned from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#routeId) */ routeId?: string; /** * Name specified in [RouteParameters.stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#stops). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#routeName) */ routeName?: string; /** * Lists additional information about the directions depending on the value of [RouteParameters.directionsOutputType](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsOutputType). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#strings) */ strings?: any[]; /** * Actual drive time calculated for the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalDriveTime) */ totalDriveTime?: number; /** * The length of the route as specified in the units set in [RouteParameters.directionsLengthUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLengthUnits). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalLength) */ totalLength?: number; /** * The total time calculated for the route as specified in the units set in [RouteParameters.directionsTimeAttribute](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsTimeAttribute). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DirectionsFeatureSet.html#totalTime) */ totalTime?: number; @@ -32010,35 +32010,35 @@ declare namespace __esri { interface DistanceParameters extends Accessor { /** * Specifies the units for measuring distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2). If the unit is not specified the units are derived from the spatial reference. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#distanceUnit) */ distanceUnit: string; /** * When `true`, the geodesic distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2) is measured. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geodesic) */ geodesic: boolean; /** * The geometry from which the distance is to be measured. The geometry can be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), or a [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) */ geometry1: Geometry[]; /** * The geometry to which the distance is to be measured. The geometry can be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), or a [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2) */ geometry2: Geometry[]; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -32054,25 +32054,25 @@ declare namespace __esri { interface DistanceParametersProperties { /** * Specifies the units for measuring distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2). If the unit is not specified the units are derived from the spatial reference. For a list of valid units, see [esriSRUnitType Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnitType_Constants/000w00000042000000/) and [esriSRUnit2Type Constants](http://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#distanceUnit) */ distanceUnit?: string; /** * When `true`, the geodesic distance between [geometry1](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) and [geometry2](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2) is measured. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geodesic) */ geodesic?: boolean; /** * The geometry from which the distance is to be measured. The geometry can be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), or a [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry1) */ geometry1?: GeometryProperties[]; /** * The geometry to which the distance is to be measured. The geometry can be a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html), or a [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DistanceParameters.html#geometry2) */ geometry2?: GeometryProperties[]; @@ -32081,37 +32081,37 @@ declare namespace __esri { interface FeatureSet extends Accessor, JSONSupport { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. This is only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#displayFieldName) */ displayFieldName: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. If `maxRecordCount` is configured for a layer, `exceededTransferLimit` will be `true` if a query matches more than the `maxRecordCount` features. It will be `false` otherwise. Supported by ArcGIS Server version 10.1 and later. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#exceededTransferLimit) */ exceededTransferLimit: boolean; /** * The array of graphics returned from a task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#features) */ features: Graphic[]; /** * Information about each field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#fields) */ fields: Field[]; /** * The geometry type of the FeatureSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#geometryType) */ geometryType: string; /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#spatialReference) */ spatialReference: SpatialReference; @@ -32130,37 +32130,37 @@ declare namespace __esri { interface FeatureSetProperties { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. This is only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#displayFieldName) */ displayFieldName?: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. If `maxRecordCount` is configured for a layer, `exceededTransferLimit` will be `true` if a query matches more than the `maxRecordCount` features. It will be `false` otherwise. Supported by ArcGIS Server version 10.1 and later. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#exceededTransferLimit) */ exceededTransferLimit?: boolean; /** * The array of graphics returned from a task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#features) */ features?: GraphicProperties[]; /** * Information about each field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#fields) */ fields?: FieldProperties[]; /** * The geometry type of the FeatureSet. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#geometryType) */ geometryType?: string; /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; @@ -32169,63 +32169,63 @@ declare namespace __esri { interface FindParameters extends Accessor { /** * Determines whether to look for an exact match of the search text or not. If `true`, searches for a value that contains the provided [searchText](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText). This is a case-insensitive search. If `false`, searches for an exact match of the [searchText](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText) string. The exact match is case-sensitive. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#contains) - * + * * @default true */ contains: boolean; /** * Specify the number of decimal places for the geometries returned by the task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#geometryPrecision) */ geometryPrecision: number; /** * The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) layerInfos. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#layerIds) */ layerIds: number[]; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. The offset is in the units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference). If [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference) is not defined, the spatial reference of the map is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * The spatial reference of the output geometries. If this is not specified, the output geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * If `true`, the output will include the geometry associated with each result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#returnGeometry) - * + * * @default false */ returnGeometry: boolean; /** * The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchFields) */ searchFields: string[]; /** * The text that is searched across the layers and the fields as specified in the `layers` and [searchFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchFields) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText) */ searchText: string; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -32241,53 +32241,53 @@ declare namespace __esri { interface FindParametersProperties { /** * Determines whether to look for an exact match of the search text or not. If `true`, searches for a value that contains the provided [searchText](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText). This is a case-insensitive search. If `false`, searches for an exact match of the [searchText](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText) string. The exact match is case-sensitive. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#contains) - * + * * @default true */ contains?: boolean; /** * Specify the number of decimal places for the geometries returned by the task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html) layerInfos. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#layerIds) */ layerIds?: number[]; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. The offset is in the units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference). If [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference) is not defined, the spatial reference of the map is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * The spatial reference of the output geometries. If this is not specified, the output geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * If `true`, the output will include the geometry associated with each result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#returnGeometry) - * + * * @default false */ returnGeometry?: boolean; /** * The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchFields) */ searchFields?: string[]; /** * The text that is searched across the layers and the fields as specified in the `layers` and [searchFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchFields) properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindParameters.html#searchText) */ searchText?: string; @@ -32296,37 +32296,37 @@ declare namespace __esri { interface FindResult extends Accessor, JSONSupport { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#displayFieldName) */ displayFieldName: string; /** * The found feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#feature) */ feature: Graphic; /** * The name of the field that contains the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#foundFieldName) */ foundFieldName: string; /** * Unique ID of the layer that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#layerId) */ layerId: number; /** * The layer name that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#layerName) */ layerName: string; /** * The value of the `foundFieldName` in the feature's attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#value) */ value: void; @@ -32345,37 +32345,37 @@ declare namespace __esri { interface FindResultProperties { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#displayFieldName) */ displayFieldName?: string; /** * The found feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#feature) */ feature?: GraphicProperties; /** * The name of the field that contains the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#foundFieldName) */ foundFieldName?: string; /** * Unique ID of the layer that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#layerId) */ layerId?: number; /** * The layer name that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#layerName) */ layerName?: string; /** * The value of the `foundFieldName` in the feature's attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FindResult.html#value) */ value?: void; @@ -32384,29 +32384,29 @@ declare namespace __esri { interface GeneralizeParameters extends Accessor { /** * The maximum deviation unit. If the unit is not specified, units are derived from the spatial reference. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#deviationUnit) */ deviationUnit: string; /** * The array of input geometries to generalize. All geometries in this array must be of the same geometry type (e.g. `esriGeometryPolyline` or `esriGeometryPolygon`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#geometries) */ geometries: Geometry[]; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#maxDeviation) */ maxDeviation: number; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -32422,19 +32422,19 @@ declare namespace __esri { interface GeneralizeParametersProperties { /** * The maximum deviation unit. If the unit is not specified, units are derived from the spatial reference. Use one of the possible values listed below or any of the [numeric codes for linear units](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#deviationUnit) */ deviationUnit?: string; /** * The array of input geometries to generalize. All geometries in this array must be of the same geometry type (e.g. `esriGeometryPolyline` or `esriGeometryPolygon`). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GeneralizeParameters.html#maxDeviation) */ maxDeviation?: number; @@ -32443,13 +32443,13 @@ declare namespace __esri { interface GPMessage extends Accessor, JSONSupport { /** * The geoprocessing message. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GPMessage.html#description) */ description: string; /** * The geoprocessing message type. **Possible Values:** informative | process-definition | process-start | process-stop | warning | error | empty | abort - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GPMessage.html#type) */ type: string; @@ -32468,13 +32468,13 @@ declare namespace __esri { interface GPMessageProperties { /** * The geoprocessing message. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GPMessage.html#description) */ description?: string; /** * The geoprocessing message type. **Possible Values:** informative | process-definition | process-start | process-stop | warning | error | empty | abort - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-GPMessage.html#type) */ type?: string; @@ -32483,132 +32483,132 @@ declare namespace __esri { interface IdentifyParameters extends Accessor { /** * Resolution of the current map view in dots per inch. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#dpi) - * + * * @default 96 */ dpi: number; /** * The geometry used to select features during the Identify operation. The type of the geometry is specified by [Geometry.type](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type). The most common geometry used with Identify is a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#geometry) */ geometry: Geometry; /** * Specify the number of decimal places for the geometries returned by the task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#geometryPrecision) */ geometryPrecision: number; /** * Height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#height) - * + * * @default 400 */ height: number; /** * The layers on which to perform the identify operation. The layers are specified as a comma-separated list of layer IDs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#layerIds) */ layerIds: number[]; /** - * Specifies which layers to use when using Identify. - * + * Specifies which layers to use when using Identify. + * * Possible values | Description * --------------- | ----------- * top | Only the top-most visible layer is identified. * visible | All visible layers are identified. * all | All layers are identified, even if they are not visible. If your service has many layers, a request using this option will not perform well. A visible layer means you can see it in the map at the current extent. If a layer is turned off or not in range based on its scale dependency settings, it cannot be identified. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#layerOption) - * + * * @default top */ layerOption: string; /** * The Extent or bounding box of the current map view. The `mapExtent` property is assumed to be in the spatial reference of the map unless [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) has been specified. The values for [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent), [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#width), and [dpi](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#dpi) are used to determine the current map scale. Once the scale is known, the map service can exclude layers based on their scale dependency settings. The map service is not performing a spatial intersection based on the provided extent. These properties are also used to calculate the search distance on the map based on the tolerance in screen pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent) */ mapExtent: Extent; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. The offset is in the units of the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference). If a [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) is not defined the spatial reference of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * If `true`, field names will be returned instead of field aliases. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnFieldName) - * + * * @default false */ returnFieldName: boolean; /** * If `true`, the result set includes the geometry associated with each result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnGeometry) - * + * * @default false */ returnGeometry: boolean; /** * When `true`, indicates that M values will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnM) - * + * * @default false */ returnM: boolean; /** * If `true`, the values in the result will not be formatted i.e. numbers will returned as is and dates will be returned as epoch values. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnUnformattedValues) - * + * * @default false */ returnUnformattedValues: boolean; /** * When `true`, indicates that M values will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnZ) - * + * * @default false */ returnZ: boolean; /** * The spatial reference of the input and output geometries as well as of the [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent). If the spatial reference is not specified, the geometry and the extent are assumed to be in the spatial reference of the view, and the output geometries will also be in the spatial reference of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) */ spatialReference: SpatialReference; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#tolerance) */ tolerance: number; /** * Width of the current map view in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#width) - * + * * @default 400 */ width: number; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -32624,122 +32624,122 @@ declare namespace __esri { interface IdentifyParametersProperties { /** * Resolution of the current map view in dots per inch. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#dpi) - * + * * @default 96 */ dpi?: number; /** * The geometry used to select features during the Identify operation. The type of the geometry is specified by [Geometry.type](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#type). The most common geometry used with Identify is a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#geometry) */ geometry?: GeometryProperties; /** * Specify the number of decimal places for the geometries returned by the task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#geometryPrecision) */ geometryPrecision?: number; /** * Height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#height) - * + * * @default 400 */ height?: number; /** * The layers on which to perform the identify operation. The layers are specified as a comma-separated list of layer IDs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#layerIds) */ layerIds?: number[]; /** - * Specifies which layers to use when using Identify. - * + * Specifies which layers to use when using Identify. + * * Possible values | Description * --------------- | ----------- * top | Only the top-most visible layer is identified. * visible | All visible layers are identified. * all | All layers are identified, even if they are not visible. If your service has many layers, a request using this option will not perform well. A visible layer means you can see it in the map at the current extent. If a layer is turned off or not in range based on its scale dependency settings, it cannot be identified. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#layerOption) - * + * * @default top */ layerOption?: string; /** * The Extent or bounding box of the current map view. The `mapExtent` property is assumed to be in the spatial reference of the map unless [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) has been specified. The values for [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent), [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#height), [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#width), and [dpi](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#dpi) are used to determine the current map scale. Once the scale is known, the map service can exclude layers based on their scale dependency settings. The map service is not performing a spatial intersection based on the provided extent. These properties are also used to calculate the search distance on the map based on the tolerance in screen pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent) */ mapExtent?: ExtentProperties; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. The offset is in the units of the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference). If a [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) is not defined the spatial reference of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * If `true`, field names will be returned instead of field aliases. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnFieldName) - * + * * @default false */ returnFieldName?: boolean; /** * If `true`, the result set includes the geometry associated with each result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnGeometry) - * + * * @default false */ returnGeometry?: boolean; /** * When `true`, indicates that M values will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnM) - * + * * @default false */ returnM?: boolean; /** * If `true`, the values in the result will not be formatted i.e. numbers will returned as is and dates will be returned as epoch values. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnUnformattedValues) - * + * * @default false */ returnUnformattedValues?: boolean; /** * When `true`, indicates that M values will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#returnZ) - * + * * @default false */ returnZ?: boolean; /** * The spatial reference of the input and output geometries as well as of the [mapExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#mapExtent). If the spatial reference is not specified, the geometry and the extent are assumed to be in the spatial reference of the view, and the output geometries will also be in the spatial reference of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#tolerance) */ tolerance?: number; /** * Width of the current map view in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyParameters.html#width) - * + * * @default 400 */ width?: number; @@ -32748,25 +32748,25 @@ declare namespace __esri { interface IdentifyResult extends Accessor, JSONSupport { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#displayFieldName) */ displayFieldName: string; /** * An identified feature from the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#feature) */ feature: Graphic; /** * Unique ID of the layer that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#layerId) */ layerId: number; /** * The layer name that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#layerName) */ layerName: string; @@ -32785,25 +32785,25 @@ declare namespace __esri { interface IdentifyResultProperties { /** * The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#displayFieldName) */ displayFieldName?: string; /** * An identified feature from the map service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#feature) */ feature?: GraphicProperties; /** * Unique ID of the layer that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#layerId) */ layerId?: number; /** * The layer name that contains the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-IdentifyResult.html#layerName) */ layerName?: string; @@ -32812,69 +32812,69 @@ declare namespace __esri { interface ImageServiceIdentifyParameters extends Accessor { /** * Input geometry that defines the location to be identified. The location can be a point or a polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#geometry) */ geometry: Point | Polygon; /** * Specifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified, `center` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#mosaicRule) */ mosaicRule: MosaicRule; /** * The pixel or RGB color value representing no information. It can be defined as a number `noData = 0` representing a pixel value or as a string `noData = "58,128,187"` representing an RGB color value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#noData) */ noData: string | number; /** * Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSize) */ pixelSize: Symbol; /** * The pixel level being identified (or the resolution being looked at) on the x-axis. If not specified, it will default to the base resolution of the dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSizeX) */ pixelSizeX: number; /** * The pixel level being identified (or the resolution being looked at) on the y-axis. If not specified, it will default to the base resolution of the dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSizeY) */ pixelSizeY: number; /** * Specifies the rendering rule for how the requested image should be rendered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#renderingRule) */ renderingRule: RasterFunction; /** * If `true`, returns both geometry and attributes of the catalog items. Set to `false` when catalog items are not needed to significantly improve identify operation's performance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#returnCatalogItems) - * + * * @default true */ returnCatalogItems: boolean; /** * When `true`, each feature in the catalog items includes the geometry. Set to `false` to not display the features on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#returnGeometry) - * + * * @default false */ returnGeometry: boolean; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -32890,59 +32890,59 @@ declare namespace __esri { interface ImageServiceIdentifyParametersProperties { /** * Input geometry that defines the location to be identified. The location can be a point or a polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#geometry) */ geometry?: PointProperties | PolygonProperties; /** * Specifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified, `center` is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#mosaicRule) */ mosaicRule?: MosaicRuleProperties; /** * The pixel or RGB color value representing no information. It can be defined as a number `noData = 0` representing a pixel value or as a string `noData = "58,128,187"` representing an RGB color value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#noData) */ noData?: string | number; /** * Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSize) */ pixelSize?: SymbolProperties; /** * The pixel level being identified (or the resolution being looked at) on the x-axis. If not specified, it will default to the base resolution of the dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSizeX) */ pixelSizeX?: number; /** * The pixel level being identified (or the resolution being looked at) on the y-axis. If not specified, it will default to the base resolution of the dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#pixelSizeY) */ pixelSizeY?: number; /** * Specifies the rendering rule for how the requested image should be rendered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#renderingRule) */ renderingRule?: RasterFunctionProperties; /** * If `true`, returns both geometry and attributes of the catalog items. Set to `false` when catalog items are not needed to significantly improve identify operation's performance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#returnCatalogItems) - * + * * @default true */ returnCatalogItems?: boolean; /** * When `true`, each feature in the catalog items includes the geometry. Set to `false` to not display the features on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyParameters.html#returnGeometry) - * + * * @default false */ returnGeometry?: boolean; @@ -32951,43 +32951,43 @@ declare namespace __esri { interface ImageServiceIdentifyResult extends Accessor, JSONSupport { /** * The set of catalog items that overlap the input geometry. Catalog Items are returned only when the image service source is a mosaic dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#catalogItems) */ catalogItems: FeatureSet; /** * The set of visible areas for the identified catalog items. `CatalogItemVisibilities` are returned only when the image service source is a mosaic dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#catalogItemVisibilities) */ catalogItemVisibilities: number[]; /** * The identified location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#location) */ location: Point; /** * The identify property name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#name) */ name: string; /** * The identify property id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#objectId) */ objectId: number; /** * The attributes of the identified object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#properties) */ properties: any; /** * The identify property pixel value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#value) */ value: string; @@ -33006,43 +33006,43 @@ declare namespace __esri { interface ImageServiceIdentifyResultProperties { /** * The set of catalog items that overlap the input geometry. Catalog Items are returned only when the image service source is a mosaic dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#catalogItems) */ catalogItems?: FeatureSetProperties; /** * The set of visible areas for the identified catalog items. `CatalogItemVisibilities` are returned only when the image service source is a mosaic dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#catalogItemVisibilities) */ catalogItemVisibilities?: number[]; /** * The identified location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#location) */ location?: PointProperties; /** * The identify property name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#name) */ name?: string; /** * The identify property id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#objectId) */ objectId?: number; /** * The attributes of the identified object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#properties) */ properties?: any; /** * The identify property pixel value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ImageServiceIdentifyResult.html#value) */ value?: string; @@ -33051,19 +33051,19 @@ declare namespace __esri { interface JobInfo extends Accessor, JSONSupport { /** * The unique job ID assigned by ArcGIS Server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#jobId) */ jobId: string; /** * The job status. **Possible Values:** job-cancelled | job-cancelling | job-deleted | job-deleting | job-timed-out | job-executing | job-failed | job-new | job-submitted | job-succeeded | job-waiting - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#jobStatus) */ jobStatus: string; /** * An array of messages that include the message type and a description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#messages) */ messages: GPMessage[]; @@ -33082,19 +33082,19 @@ declare namespace __esri { interface JobInfoProperties { /** * The unique job ID assigned by ArcGIS Server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#jobId) */ jobId?: string; /** * The job status. **Possible Values:** job-cancelled | job-cancelling | job-deleted | job-deleting | job-timed-out | job-executing | job-failed | job-new | job-submitted | job-succeeded | job-waiting - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#jobStatus) */ jobStatus?: string; /** * An array of messages that include the message type and a description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-JobInfo.html#messages) */ messages?: GPMessageProperties[]; @@ -33103,19 +33103,19 @@ declare namespace __esri { interface LegendLayer extends Accessor { /** * The id of the operational layer to include in the printout's legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#layerId) */ layerId: string; /** * The ids of the sublayers to include in the printout's legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#subLayerIds) */ subLayerIds: string[]; /** * The title of the feature layer. Use this property to modify feature layer name in the legend for the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#title) */ title: string; @@ -33132,19 +33132,19 @@ declare namespace __esri { interface LegendLayerProperties { /** * The id of the operational layer to include in the printout's legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#layerId) */ layerId?: string; /** * The ids of the sublayers to include in the printout's legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#subLayerIds) */ subLayerIds?: string[]; /** * The title of the feature layer. Use this property to modify feature layer name in the legend for the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html#title) */ title?: string; @@ -33152,43 +33152,43 @@ declare namespace __esri { interface LengthsParameters extends Accessor { /** - * Defines the type of calculation for the geometry. The type can be one of the following: - * + * Defines the type of calculation for the geometry. The type can be one of the following: + * * Value | Description * ---------------|--------------- * planar | Planar measurements use 2D Cartesian mathematics to calculate length. Use this type if the length needs to be calculated in the input spatial reference otherwise use `preserve-shape`. * geodesic | Use this type to calculate an area or length using only the vertices of the polygon to define the lines connecting the vertices as geodesic segments independent of the actual shape of the polygon. **Note:** a geodesic segment is the shortest path between two points on an ellipsoid. * preserve-shape | Calculate the area or length of the geometry on the surface of the Earth ellipsoid, for geometries defined in a projected or geographic coordinate system. This method preserves the shape of the geometry in its coordinate system which means the true area or length will be calculated for the geometry that is displayed on the map. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#calculationType) */ calculationType: string; /** * If polylines are in a geographic coordinate system, then geodesic needs to be set to `true` in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. If `lengthUnit` is not specified, the output is returned in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#geodesic) */ geodesic: boolean; /** * The length unit in which perimeters of polygons will be calculated. For a list of valid units, see [linear unit codes](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#lengthUnit) */ lengthUnit: number | string; /** * The array of polylines whose lengths are to be computed. The structure of each polyline in the array is same as the structure of the JSON polyline objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#polylines) */ polylines: Polyline[]; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -33203,33 +33203,33 @@ declare namespace __esri { interface LengthsParametersProperties { /** - * Defines the type of calculation for the geometry. The type can be one of the following: - * + * Defines the type of calculation for the geometry. The type can be one of the following: + * * Value | Description * ---------------|--------------- * planar | Planar measurements use 2D Cartesian mathematics to calculate length. Use this type if the length needs to be calculated in the input spatial reference otherwise use `preserve-shape`. * geodesic | Use this type to calculate an area or length using only the vertices of the polygon to define the lines connecting the vertices as geodesic segments independent of the actual shape of the polygon. **Note:** a geodesic segment is the shortest path between two points on an ellipsoid. * preserve-shape | Calculate the area or length of the geometry on the surface of the Earth ellipsoid, for geometries defined in a projected or geographic coordinate system. This method preserves the shape of the geometry in its coordinate system which means the true area or length will be calculated for the geometry that is displayed on the map. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#calculationType) */ calculationType?: string; /** * If polylines are in a geographic coordinate system, then geodesic needs to be set to `true` in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. If `lengthUnit` is not specified, the output is returned in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#geodesic) */ geodesic?: boolean; /** * The length unit in which perimeters of polygons will be calculated. For a list of valid units, see [linear unit codes](https://developers.arcgis.com/java/api-reference/constant-values.html#com.esri.core.geometry.LinearUnit.Code.CENTIMETER). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#lengthUnit) */ lengthUnit?: number | string; /** * The array of polylines whose lengths are to be computed. The structure of each polyline in the array is same as the structure of the JSON polyline objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LengthsParameters.html#polylines) */ polylines?: PolylineProperties[]; @@ -33238,15 +33238,15 @@ declare namespace __esri { interface LinearUnit extends Accessor, JSONSupport { /** * Specifies the value of the linear distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LinearUnit.html#distance) - * + * * @default 0 */ distance: number; /** * Specifies the unit type of the linear distance. **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LinearUnit.html#units) */ units: string; @@ -33265,15 +33265,15 @@ declare namespace __esri { interface LinearUnitProperties { /** * Specifies the value of the linear distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LinearUnit.html#distance) - * + * * @default 0 */ distance?: number; /** * Specifies the unit type of the linear distance. **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LinearUnit.html#units) */ units?: string; @@ -33282,13 +33282,13 @@ declare namespace __esri { interface NAMessage extends Accessor, JSONSupport { /** * A description of the network analyst message. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-NAMessage.html#description) */ description: string; /** * The network analyst message type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-NAMessage.html#type) */ type: any; @@ -33307,13 +33307,13 @@ declare namespace __esri { interface NAMessageProperties { /** * A description of the network analyst message. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-NAMessage.html#description) */ description?: string; /** * The network analyst message type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-NAMessage.html#type) */ type?: any; @@ -33322,48 +33322,48 @@ declare namespace __esri { interface OffsetParameters extends Accessor { /** * The `bevelRatio` is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. When mitered is specified, the value set for `bevelRatio` is ignored and `10` is used internally. If beveled is specified, `1.1` will be used if no value is set for bevelRatio. The bevelRatio is ignored when `rounded` is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#bevelRatio) */ bevelRatio: number; /** * The array of geometries to be offset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#geometries) */ geometries: Geometry[]; /** * Specifies the planar distance for constructing an offset based on the input geometries. If the `offsetDistance` parameter is positive, the constructed offset will be on the right side of the curve. Left side offsets are constructed with negative values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetDistance) */ offsetDistance: number; /** - * Options that determine how the ends intersect. Set to one of the following options: - * + * Options that determine how the ends intersect. Set to one of the following options: + * * Possible Value | Description * ---------------|------------- * bevelled | Squares off the corner after a given ratio distance. * mitered | Attempts to allow extended offsets to naturally intersect. If the intersection occurs too far from a corner, the corner will be beveled off at a fixed distance. * rounded | Rounds the corner between extended offsets. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetHow) */ offsetHow: string; /** * The offset distance unit. For a list of valid units see [esriSRUnitType constants](http://resources.esri.com/help/9.3/ArcGISDesktop/ArcObjects/esriGeometry/esriSRUnitType.htm) or [esriSRUnit2Type constants](http://resources.esri.com/help/9.3/ArcGISDesktop/ArcObjects/esriGeometry/esriSRUnit2Type.htm). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetUnit) */ offsetUnit: string; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -33379,38 +33379,38 @@ declare namespace __esri { interface OffsetParametersProperties { /** * The `bevelRatio` is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. When mitered is specified, the value set for `bevelRatio` is ignored and `10` is used internally. If beveled is specified, `1.1` will be used if no value is set for bevelRatio. The bevelRatio is ignored when `rounded` is specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#bevelRatio) */ bevelRatio?: number; /** * The array of geometries to be offset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * Specifies the planar distance for constructing an offset based on the input geometries. If the `offsetDistance` parameter is positive, the constructed offset will be on the right side of the curve. Left side offsets are constructed with negative values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetDistance) */ offsetDistance?: number; /** - * Options that determine how the ends intersect. Set to one of the following options: - * + * Options that determine how the ends intersect. Set to one of the following options: + * * Possible Value | Description * ---------------|------------- * bevelled | Squares off the corner after a given ratio distance. * mitered | Attempts to allow extended offsets to naturally intersect. If the intersection occurs too far from a corner, the corner will be beveled off at a fixed distance. * rounded | Rounds the corner between extended offsets. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetHow) */ offsetHow?: string; /** * The offset distance unit. For a list of valid units see [esriSRUnitType constants](http://resources.esri.com/help/9.3/ArcGISDesktop/ArcObjects/esriGeometry/esriSRUnitType.htm) or [esriSRUnit2Type constants](http://resources.esri.com/help/9.3/ArcGISDesktop/ArcObjects/esriGeometry/esriSRUnit2Type.htm). **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-OffsetParameters.html#offsetUnit) */ offsetUnit?: string; @@ -33419,13 +33419,13 @@ declare namespace __esri { interface ParameterValue extends Accessor, JSONSupport { /** * Specifies the parameter's data type. **Possible Values:** string | double | long | boolean | date | linear-unit | data-file | raster-data | record-set | raster-data-layer | feature-record-set-layer | multi-value - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ParameterValue.html#dataType) */ dataType: string; /** - * The value of the parameter. The data structure of this value depends on the `dataType`. - * + * The value of the parameter. The data structure of this value depends on the `dataType`. + * * Data Type | JavaScript Type * ----------|---------------- * string | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) @@ -33440,8 +33440,8 @@ declare namespace __esri { * raster-data-layer | [RasterData](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html) * feature-record-set-layer | [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) * multi-value | [String[]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ParameterValue.html#value) */ value: any; @@ -33460,13 +33460,13 @@ declare namespace __esri { interface ParameterValueProperties { /** * Specifies the parameter's data type. **Possible Values:** string | double | long | boolean | date | linear-unit | data-file | raster-data | record-set | raster-data-layer | feature-record-set-layer | multi-value - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ParameterValue.html#dataType) */ dataType?: string; /** - * The value of the parameter. The data structure of this value depends on the `dataType`. - * + * The value of the parameter. The data structure of this value depends on the `dataType`. + * * Data Type | JavaScript Type * ----------|---------------- * string | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) @@ -33481,8 +33481,8 @@ declare namespace __esri { * raster-data-layer | [RasterData](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html) * feature-record-set-layer | [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) * multi-value | [String[]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ParameterValue.html#value) */ value?: any; @@ -33491,25 +33491,25 @@ declare namespace __esri { interface PrintParameters extends Accessor { /** * Additional parameters for the print service. When an arcpy script is published as a custom print service there may be additional parameters associated with the print service. To determine the extra parameters visit the ArcGIS REST Services Directory page for the print service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#extraParameters) */ extraParameters: any; /** * Specify the output spatial reference for the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Defines the layout template used for the printed map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#template) */ template: PrintTemplate; /** * The view to print. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#view) */ view: MapView; @@ -33526,25 +33526,25 @@ declare namespace __esri { interface PrintParametersProperties { /** * Additional parameters for the print service. When an arcpy script is published as a custom print service there may be additional parameters associated with the print service. To determine the extra parameters visit the ArcGIS REST Services Directory page for the print service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#extraParameters) */ extraParameters?: any; /** * Specify the output spatial reference for the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Defines the layout template used for the printed map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#template) */ template?: PrintTemplateProperties; /** * The view to print. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintParameters.html#view) */ view?: MapViewProperties; @@ -33553,37 +33553,37 @@ declare namespace __esri { interface PrintTemplate extends Accessor { /** * When `false`, the attribution is not displayed on the printout. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layout) value is `map-only`. Reference our policies on [Licensing & Attribution](https://developers.arcgis.com/javascript/latest/guide/licensing/) for specific attribution requirements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#attributionVisible) - * + * * @default true */ attributionVisible: boolean; /** * Define the map width, height and dpi. Required when `layout = 'map-only'`. See the object specification table below for available options to set for exportOptions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#exportOptions) */ exportOptions: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. By default they are removed to reduce the request size. Only applicable to custom print services which use the feature attributes, for example to display a table of features and their attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#forceFeatureAttributes) - * + * * @default false */ forceFeatureAttributes: boolean; /** * The output format for the printed map. **Possible Values:** pdf | png32 | png8 | jpg | gif | eps | svg | svgz - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#format) - * + * * @default png32 */ format: string; /** * The layout used for the print output. When the value is `map-only` or is empty, the output map does not contain any page layout surroundings (for example, title, legend, scale bar and so forth). The print service provides out-of-the-box templates listed in possible values. The server administrator can add additional templates to the print service. Possible values are listed below: - * + * * Value | Description * | --- | --- * map-only | Map does not contain any layout elements. Only map image is printed. @@ -33595,40 +33595,40 @@ declare namespace __esri { * letter-ansi-a-portrait | Letter ANSI A Portrait * tabloid-ansi-b-landscape| Tabloid ANSI B Landscape * tabloid-ansi-b-portrait | Tabloid ANSI B Portrait - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layout) - * + * * @default map-only */ layout: string; /** * Defines the layout elements. It's an object with the following properties: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ layoutOptions: PrintTemplateLayoutOptions; /** * The optional map scale of the printed map. Only applies when `preserveScale = true`. If `outScale` is less than 1, then the printed map will use the scale of the input map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#outScale) - * + * * @default 0 */ outScale: number; /** * Define whether the printed map should preserve map scale or map extent. If `true`, the printed map will use the `outScale` property or default to the scale of the input map. If `false`, the printed map will use the same extent as the input map and thus scale might change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#preserveScale) - * + * * @default true */ preserveScale: boolean; /** * When `true`, labels will be shown on the layout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#showLabels) - * + * * @default true */ showLabels: boolean; @@ -33645,37 +33645,37 @@ declare namespace __esri { interface PrintTemplateProperties { /** * When `false`, the attribution is not displayed on the printout. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layout) value is `map-only`. Reference our policies on [Licensing & Attribution](https://developers.arcgis.com/javascript/latest/guide/licensing/) for specific attribution requirements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#attributionVisible) - * + * * @default true */ attributionVisible?: boolean; /** * Define the map width, height and dpi. Required when `layout = 'map-only'`. See the object specification table below for available options to set for exportOptions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#exportOptions) */ exportOptions?: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. By default they are removed to reduce the request size. Only applicable to custom print services which use the feature attributes, for example to display a table of features and their attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#forceFeatureAttributes) - * + * * @default false */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. **Possible Values:** pdf | png32 | png8 | jpg | gif | eps | svg | svgz - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#format) - * + * * @default png32 */ format?: string; /** * The layout used for the print output. When the value is `map-only` or is empty, the output map does not contain any page layout surroundings (for example, title, legend, scale bar and so forth). The print service provides out-of-the-box templates listed in possible values. The server administrator can add additional templates to the print service. Possible values are listed below: - * + * * Value | Description * | --- | --- * map-only | Map does not contain any layout elements. Only map image is printed. @@ -33687,40 +33687,40 @@ declare namespace __esri { * letter-ansi-a-portrait | Letter ANSI A Portrait * tabloid-ansi-b-landscape| Tabloid ANSI B Landscape * tabloid-ansi-b-portrait | Tabloid ANSI B Portrait - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layout) - * + * * @default map-only */ layout?: string; /** * Defines the layout elements. It's an object with the following properties: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ layoutOptions?: PrintTemplateLayoutOptions; /** * The optional map scale of the printed map. Only applies when `preserveScale = true`. If `outScale` is less than 1, then the printed map will use the scale of the input map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#outScale) - * + * * @default 0 */ outScale?: number; /** * Define whether the printed map should preserve map scale or map extent. If `true`, the printed map will use the `outScale` property or default to the scale of the input map. If `false`, the printed map will use the same extent as the input map and thus scale might change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#preserveScale) - * + * * @default true */ preserveScale?: boolean; /** * When `true`, labels will be shown on the layout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#showLabels) - * + * * @default true */ showLabels?: boolean; @@ -33730,19 +33730,19 @@ declare namespace __esri { export interface PrintTemplateExportOptions extends Object { /** * Map width. Default value is 800. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#exportOptions) */ width?: number; /** * Map height. Default value is 1100. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#exportOptions) */ height?: number; /** * Resolution in dots per inch. If modified when `layout = 'map-only'`, the `width` and `height` will also need to be modified proportional to the `dpi` change. Default value is 96. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#exportOptions) */ dpi?: number; @@ -33752,39 +33752,39 @@ declare namespace __esri { export interface PrintTemplateLayoutOptions extends Object { /** * The text used for the map title if the specified layout contains a title text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ titleText: string; /** * The text used for the author if the specified layout contains an author text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ authorText: string; /** * The text used for the copyright if the specified layout contains an copyright text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ copyrightText: string; /** * The unit used for the scalebar. **Possible Values:** `Miles` | `Kilometers` | `Meters` | `Feet` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) - * + * * @default Miles */ scalebarUnit?: string; /** * An array of [LegendLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-LegendLayer.html) containing the id's of the layers that will be included in the legend. If `legendLayers` is not specified, all operational layers (non-tiled layers) will be present in the legend. To specify that no layers will be included in the legend set `legendLayer = []`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ legendLayers: LegendLayer[]; /** * An array of name-value pairs. Use this property to update the text for custom text elements on the page layout. Values must be strings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html#layoutOptions) */ customTextElements: any[]; @@ -33793,41 +33793,41 @@ declare namespace __esri { interface ProjectParameters extends Accessor { /** * The input geometries to project. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#geometries) */ geometries: Geometry[]; /** * The spatial reference to which you are projecting the geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The spatial reference to which you are projecting the geometries. Use [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSpatialReference) instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSR) */ outSR: SpatialReference; /** * The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries. See [Datum transformations](https://developers.arcgis.com/rest/services-reference/datum-transformations.htm) for a list of valid datum transformations that may be used here. If a transformation is specified, a value must also be specified in the [transformForward](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformForward) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformation) */ transformation: ProjectParametersTransformation; /** * Indicates whether to transform forward or not. The forward or reverse direction of transformation is implied in the name of the transformation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformForward) */ transformForward: boolean; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -33843,31 +33843,31 @@ declare namespace __esri { interface ProjectParametersProperties { /** * The input geometries to project. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#geometries) */ geometries?: GeometryProperties[]; /** * The spatial reference to which you are projecting the geometries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The spatial reference to which you are projecting the geometries. Use [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSpatialReference) instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#outSR) */ outSR?: SpatialReferenceProperties; /** * The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries. See [Datum transformations](https://developers.arcgis.com/rest/services-reference/datum-transformations.htm) for a list of valid datum transformations that may be used here. If a transformation is specified, a value must also be specified in the [transformForward](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformForward) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformation) */ transformation?: ProjectParametersTransformation; /** * Indicates whether to transform forward or not. The forward or reverse direction of transformation is implied in the name of the transformation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformForward) */ transformForward?: boolean; @@ -33877,13 +33877,13 @@ declare namespace __esri { export interface ProjectParametersTransformation extends Object { /** * The well-known ID of the datum transformation to apply to the projection. [List of valid IDs for Datum transformations](https://developers.arcgis.com/rest/services-reference/datum-transformations.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformation) */ wkid?: number; /** * The well-known text that defines a spatial reference. Many browsers have a limit to the length of a GET request of approximately 2048 characters. When using well-known text to specify the spatial reference you can easily exceed this limit. In these cases, you will need to [setup and use a proxy page](https://developers.arcgis.com/javascript/latest/guide/proxies/index.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ProjectParameters.html#transformation) */ wkt?: string; @@ -33892,202 +33892,202 @@ declare namespace __esri { interface Query extends Accessor, JSONSupport { /** * Datum transformation used for projecting geometries in the query results when [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) is different than the layer's spatial reference. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#datumTransformation) */ datumTransformation: number; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) in a spatial query. The [units property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#units) indicates the unit of measurement. In essence, setting this property creates a buffer at the specified size around the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). The query will use that buffer to return features in the layer or layer view that adhere to the to the indicated [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship). If querying a feature service, the [supportsQueryWithDistance](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) capability must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) */ distance: number; /** * Specifies the geodatabase version to display for feature service queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#gdbVersion) */ gdbVersion: string; /** - * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) will indicate how the geometry should be used to query features. + * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) will indicate how the geometry should be used to query features. * > **Known Limitations** [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry types are currently not supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) */ geometry: Geometry; /** * Specifies the number of decimal places for geometries returned by the query operation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometryPrecision) */ geometryPrecision: number; /** * Used only in [statistical queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#statistic). When one or more field names are provided in this property, the output statisics will be grouped based on unique values from those fields. This is only valid when [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) has been defined. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics) */ groupByFieldsForStatistics: string[]; /** * A condition used with [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) and [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics) to limit query results to groups that satisfy the aggregation function(s). The following aggregation functions are supported in this clause: `MIN` | `MAX` | `AVG` | `SUM` | `STDDEV` | `COUNT` | `VAR` Aggregation functions used in `having` must be included in the `outStatistics` as well. See the snippet below for an example of how this works. For service-based layer queries, this parameter applies only if the [supportsHavingClause](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is `true`. This property is supported on all [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#having) */ having: string; /** * The historic moment to query. This parameter applies only if the `supportsQueryWithHistoricMoment` capability of the service being queried is `true`. This setting is provided in the layer resource. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#historicMoment) */ historicMoment: Date; /** - * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. It limits how far any part of the generalized geometry can be from the original geometry. If `outSpatialReference` is not defined, the spatialReference of the data is used. + * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. It limits how far any part of the generalized geometry can be from the original geometry. If `outSpatialReference` is not defined, the spatialReference of the data is used. * > **Known Limitations** This property does not apply to [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#maxAllowableOffset) */ maxAllowableOffset: number; /** - * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. The value of this property may not exceed `5`. For example, if the `maxRecordCount` of your feature service is `2000`, and you set the `maxRecordCountFactor` to `5`, then the maximum number of features that could be returned by the query is `10000`. + * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. The value of this property may not exceed `5`. For example, if the `maxRecordCount` of your feature service is `2000`, and you set the `maxRecordCountFactor` to `5`, then the maximum number of features that could be returned by the query is `10000`. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#maxRecordCountFactor) - * + * * @default 1 */ maxRecordCountFactor: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. Currently, the only supported value is `xyFootprint`. If indicated, the xy footprint of each multipatch geometry will be returned in the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#multipatchOption) */ multipatchOption: string; /** - * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). If not provided, but an instance of Query has a `start` property, then the default value of `num` is 10. If neither `num` nor `start` properties are provided, then the default value of `num` is equal to the `maxRecordCount` of the service, which can be found at the REST endpoint of the FeatureLayer. + * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). If not provided, but an instance of Query has a `start` property, then the default value of `num` is 10. If neither `num` nor `start` properties are provided, then the default value of `num` is equal to the `maxRecordCount` of the service, which can be found at the REST endpoint of the FeatureLayer. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) */ num: number; /** * A comma delimited list of ObjectIDs for the features in the layer being queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds) */ objectIds: number[]; /** - * One or more field names used to order the query results. Specfiy `ASC` (ascending) or `DESC` (descending) after the field name to control the order. The default order is `ASC`. - * > **Known Limitations** + * One or more field names used to order the query results. Specfiy `ASC` (ascending) or `DESC` (descending) after the field name to control the order. The default order is `ASC`. + * > **Known Limitations** * * If querying a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), then `supportsAdvancedQueries` must be `true` on the service. * * For [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), `FeatureLayer.capabilities.queryRelated.supportsOrderBy` must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields) */ orderByFields: string[]; /** - * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). Fields must exist in the service layer. You must list actual field names rather than field aliases. You may, however, use field aliases when you display the results of the query. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the smaller the payload size, and therefore the faster the response of the query. You can also specify SQL expressions as `outFields` to calculate new values server side for the query results. See the example snippets below for an example of this. Each query must have access to the `Shape` and `ObjectId` fields for a layer. However, the list of outFields does not need to include these two fields. - * > **Known Limitations** + * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). Fields must exist in the service layer. You must list actual field names rather than field aliases. You may, however, use field aliases when you display the results of the query. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the smaller the payload size, and therefore the faster the response of the query. You can also specify SQL expressions as `outFields` to calculate new values server side for the query results. See the example snippets below for an example of this. Each query must have access to the `Shape` and `ObjectId` fields for a layer. However, the list of outFields does not need to include these two fields. + * > **Known Limitations** * * If specifying outFields as expressions on a feature service-based [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), the service capabilities `advancedQueryCapabilities.supportsOutFieldSQLExpression` and `useStandardizedQueries` must both be true. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields) */ outFields: string[]; /** * The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** - * The definitions for one or more field-based statistics to be calculated. If `outStatistics` is specified the only other query parameters that should be used are [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields), [text](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text), and [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where). + * The definitions for one or more field-based statistics to be calculated. If `outStatistics` is specified the only other query parameters that should be used are [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields), [text](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text), and [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where). * > **Known Limitations** For service-based queries, `outStatistics` is only supported on layers where `supportsStatistics = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) */ outStatistics: StatisticDefinition[]; /** * Filters features from the layer based on pre-authored parameterized filters. When value is not specified for any parameter in a request, the default value, that is assigned during authoring time, gets used. Requires an ArcGIS Enterprise service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#parameterValues) */ parameterValues: QueryParameterValues[]; /** * Specifies the pixel level to be identified on the X and Y axis. Defaults to the base resolution of the dataset if not specified. Applicable only to Image Service layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#pixelSize) */ pixelSize: Symbol; /** - * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. + * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6.1 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) */ quantizationParameters: QueryQuantizationParameters; /** * Filters features from the layer that are within the specified range values. Requires ArcGIS Enterprise services 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#rangeValues) */ rangeValues: QueryRangeValues[]; /** - * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) to the layer's features. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: 0,1,2), a Boolean value (T or F), or a mask character (for ignoring results: '*'). Set this parameter when the [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) is `relation`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details on how to construct these strings. + * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) to the layer's features. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: 0,1,2), a Boolean value (T or F), or a mask character (for ignoring results: '*'). Set this parameter when the [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) is `relation`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details on how to construct these strings. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#relationParameter) */ relationParameter: string; /** - * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) will be returned with a centroid. This property only applies to queries against polygon [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). + * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) will be returned with a centroid. This property only applies to queries against polygon [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6.1 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnCentroid) - * + * * @default false */ returnCentroid: boolean; /** - * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields). - * > **Known Limitations** + * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields). + * > **Known Limitations** * * For service-based queries, this parameter applies only if the `supportsAdvancedQueries` capability of the layer is `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnDistinctValues) - * + * * @default false */ returnDistinctValues: boolean; /** - * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. If `false`, the tile request will not return any features if the `maxRecordCount` limit is exceeded. + * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. If `false`, the tile request will not return any features if the `maxRecordCount` limit is exceeded. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnExceededLimitFeatures) - * + * * @default true */ returnExceededLimitFeatures: boolean; /** - * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. + * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. * > **Known Limitations** For [FeatureLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html) queries, the precision of the returned geometries will only be as high as the view's scale resolution since geometries are quantized for improved performance on the view. The smaller the scale, the lower the resolution of the geometries. This limitation does not apply to [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), and [CSVLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) - * + * * @default false */ returnGeometry: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) is `true`, then m-values are included in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnM) */ returnM: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) is `true`, then z-values are included in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnZ) */ returnZ: boolean; /** - * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). See the [Types of spatial relationships that can be validated](https://desktop.arcgis.com/en/arcmap/latest/extensions/data-reviewer/types-of-spatial-relationships-that-can-be-validated.htm) document for more details about each spatial relationship. The possible values are listed in the table below: - * + * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). See the [Types of spatial relationships that can be validated](https://desktop.arcgis.com/en/arcmap/latest/extensions/data-reviewer/types-of-spatial-relationships-that-can-be-validated.htm) document for more details about each spatial relationship. The possible values are listed in the table below: + * * Value | Description * ------|------------- * intersects | Returns features from the layer or layer view that intersect the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). @@ -34099,58 +34099,58 @@ declare namespace __esri { * touches | Returns features from the layer or layer view that touch the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). * within | Returns features from the layer or layer view that are completely within the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). * relation | Allows specification of any relationship defined using the [Shape Comparison Language](http://resources.esri.com/help/9.3/arcgisengine/dotnet/concepts_start.htm#40de6491-9b2d-440d-848b-2609efcd46b1.htm). If this value is specified, then the [relationParameter](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#relationParameter) must also be specified. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) - * + * * @default intersects */ spatialRelationship: string; /** - * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-.htm) for more information. **Possible Values:** none | standard | native + * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-.htm) for more information. **Possible Values:** none | standard | native * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#sqlFormat) - * + * * @default none */ sqlFormat: string; /** - * The zero-based index indicating where to begin retrieving features. This property hould be used in conjunction with [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num). Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by object ID by default. + * The zero-based index indicating where to begin retrieving features. This property hould be used in conjunction with [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num). Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by object ID by default. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) */ start: number; /** * Shorthand for a where clause using "like". The field used is the display field defined in the services directory. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text) - * + * * @default null */ text: string; /** - * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) is specified in spatial queries. if `unit` is not specified, the unit is derived from the layer or layer view's [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). + * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) is specified in spatial queries. if `unit` is not specified, the unit is derived from the layer or layer view's [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). * > **Known Limitations** For service-based queries, this parameter only applies if [supportsQueryWithDistance](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) is `true`. * **Possible Values:** feet | miles | nautical-miles | us-nautical-miles | meters | kilometers - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#units) */ units: string; /** * A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed. Be sure to have the correct sequence of single and double quotes when writing the where clause in JavaScript. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where) */ where: string; /** * Creates a deep clone of Query object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#clone) - * - * + * + * */ clone(): Query; } @@ -34158,7 +34158,7 @@ declare namespace __esri { interface QueryConstructor { /** * This class defines parameters for executing queries for features from a layer or layer view. Once a Query object's properties are defined, it can then be passed into an [executable function](?search=queryfeatures), which will return the features in a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) */ @@ -34172,202 +34172,202 @@ declare namespace __esri { interface QueryProperties { /** * Datum transformation used for projecting geometries in the query results when [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) is different than the layer's spatial reference. Requires ArcGIS Server service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#datumTransformation) */ datumTransformation?: number; /** * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) in a spatial query. The [units property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#units) indicates the unit of measurement. In essence, setting this property creates a buffer at the specified size around the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). The query will use that buffer to return features in the layer or layer view that adhere to the to the indicated [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship). If querying a feature service, the [supportsQueryWithDistance](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) capability must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) */ distance?: number; /** * Specifies the geodatabase version to display for feature service queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#gdbVersion) */ gdbVersion?: string; /** - * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) will indicate how the geometry should be used to query features. + * The geometry to apply to the spatial filter. The spatial relationship as specified by [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) will indicate how the geometry should be used to query features. * > **Known Limitations** [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry types are currently not supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) */ geometry?: GeometryProperties; /** * Specifies the number of decimal places for geometries returned by the query operation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometryPrecision) */ geometryPrecision?: number; /** * Used only in [statistical queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#statistic). When one or more field names are provided in this property, the output statisics will be grouped based on unique values from those fields. This is only valid when [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) has been defined. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics) */ groupByFieldsForStatistics?: string[]; /** * A condition used with [outStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) and [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics) to limit query results to groups that satisfy the aggregation function(s). The following aggregation functions are supported in this clause: `MIN` | `MAX` | `AVG` | `SUM` | `STDDEV` | `COUNT` | `VAR` Aggregation functions used in `having` must be included in the `outStatistics` as well. See the snippet below for an example of how this works. For service-based layer queries, this parameter applies only if the [supportsHavingClause](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is `true`. This property is supported on all [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#having) */ having?: string; /** * The historic moment to query. This parameter applies only if the `supportsQueryWithHistoricMoment` capability of the service being queried is `true`. This setting is provided in the layer resource. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#historicMoment) */ historicMoment?: DateProperties; /** - * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. It limits how far any part of the generalized geometry can be from the original geometry. If `outSpatialReference` is not defined, the spatialReference of the data is used. + * The maximum distance in units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) used for generalizing geometries returned by the query operation. It limits how far any part of the generalized geometry can be from the original geometry. If `outSpatialReference` is not defined, the spatialReference of the data is used. * > **Known Limitations** This property does not apply to [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** - * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. The value of this property may not exceed `5`. For example, if the `maxRecordCount` of your feature service is `2000`, and you set the `maxRecordCountFactor` to `5`, then the maximum number of features that could be returned by the query is `10000`. + * When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor. The value of this property may not exceed `5`. For example, if the `maxRecordCount` of your feature service is `2000`, and you set the `maxRecordCountFactor` to `5`, then the maximum number of features that could be returned by the query is `10000`. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#maxRecordCountFactor) - * + * * @default 1 */ maxRecordCountFactor?: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. Currently, the only supported value is `xyFootprint`. If indicated, the xy footprint of each multipatch geometry will be returned in the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#multipatchOption) */ multipatchOption?: string; /** - * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). If not provided, but an instance of Query has a `start` property, then the default value of `num` is 10. If neither `num` nor `start` properties are provided, then the default value of `num` is equal to the `maxRecordCount` of the service, which can be found at the REST endpoint of the FeatureLayer. + * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start). Use this to implement paging (i.e. to retrieve "pages" of results when querying). If not provided, but an instance of Query has a `start` property, then the default value of `num` is 10. If neither `num` nor `start` properties are provided, then the default value of `num` is equal to the `maxRecordCount` of the service, which can be found at the REST endpoint of the FeatureLayer. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) */ num?: number; /** * A comma delimited list of ObjectIDs for the features in the layer being queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds) */ objectIds?: number[]; /** - * One or more field names used to order the query results. Specfiy `ASC` (ascending) or `DESC` (descending) after the field name to control the order. The default order is `ASC`. - * > **Known Limitations** + * One or more field names used to order the query results. Specfiy `ASC` (ascending) or `DESC` (descending) after the field name to control the order. The default order is `ASC`. + * > **Known Limitations** * * If querying a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), then `supportsAdvancedQueries` must be `true` on the service. * * For [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), `FeatureLayer.capabilities.queryRelated.supportsOrderBy` must be `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields) */ orderByFields?: string[]; /** - * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). Fields must exist in the service layer. You must list actual field names rather than field aliases. You may, however, use field aliases when you display the results of the query. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the smaller the payload size, and therefore the faster the response of the query. You can also specify SQL expressions as `outFields` to calculate new values server side for the query results. See the example snippets below for an example of this. Each query must have access to the `Shape` and `ObjectId` fields for a layer. However, the list of outFields does not need to include these two fields. - * > **Known Limitations** + * Attribute fields to include in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). Fields must exist in the service layer. You must list actual field names rather than field aliases. You may, however, use field aliases when you display the results of the query. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the smaller the payload size, and therefore the faster the response of the query. You can also specify SQL expressions as `outFields` to calculate new values server side for the query results. See the example snippets below for an example of this. Each query must have access to the `Shape` and `ObjectId` fields for a layer. However, the list of outFields does not need to include these two fields. + * > **Known Limitations** * * If specifying outFields as expressions on a feature service-based [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), the service capabilities `advancedQueryCapabilities.supportsOutFieldSQLExpression` and `useStandardizedQueries` must both be true. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields) */ outFields?: string[]; /** * The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** - * The definitions for one or more field-based statistics to be calculated. If `outStatistics` is specified the only other query parameters that should be used are [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields), [text](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text), and [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where). + * The definitions for one or more field-based statistics to be calculated. If `outStatistics` is specified the only other query parameters that should be used are [groupByFieldsForStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#groupByFieldsForStatistics), [orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#orderByFields), [text](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text), and [where](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where). * > **Known Limitations** For service-based queries, `outStatistics` is only supported on layers where `supportsStatistics = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outStatistics) */ outStatistics?: StatisticDefinitionProperties[]; /** * Filters features from the layer based on pre-authored parameterized filters. When value is not specified for any parameter in a request, the default value, that is assigned during authoring time, gets used. Requires an ArcGIS Enterprise service 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#parameterValues) */ parameterValues?: QueryParameterValues[]; /** * Specifies the pixel level to be identified on the X and Y axis. Defaults to the base resolution of the dataset if not specified. Applicable only to Image Service layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#pixelSize) */ pixelSize?: SymbolProperties; /** - * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. + * Used to project the geometry onto a virtual grid, likely representing pixels on the screen. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6.1 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) */ quantizationParameters?: QueryQuantizationParameters; /** * Filters features from the layer that are within the specified range values. Requires ArcGIS Enterprise services 10.5 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#rangeValues) */ rangeValues?: QueryRangeValues[]; /** - * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) to the layer's features. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: 0,1,2), a Boolean value (T or F), or a mask character (for ignoring results: '*'). Set this parameter when the [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) is `relation`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details on how to construct these strings. + * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry) to the layer's features. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: 0,1,2), a Boolean value (T or F), or a mask character (for ignoring results: '*'). Set this parameter when the [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) is `relation`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details on how to construct these strings. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#relationParameter) */ relationParameter?: string; /** - * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) will be returned with a centroid. This property only applies to queries against polygon [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). + * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) will be returned with a centroid. This property only applies to queries against polygon [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6.1 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnCentroid) - * + * * @default false */ returnCentroid?: boolean; /** - * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields). - * > **Known Limitations** + * If `true` then the query returns distinct values based on the field(s) specified in [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields). + * > **Known Limitations** * * For service-based queries, this parameter applies only if the `supportsAdvancedQueries` capability of the layer is `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnDistinctValues) - * + * * @default false */ returnDistinctValues?: boolean; /** - * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. If `false`, the tile request will not return any features if the `maxRecordCount` limit is exceeded. + * If `true`, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by `maxRecordCount`. If `false`, the tile request will not return any features if the `maxRecordCount` limit is exceeded. * > **Known Limitations** Only supported with ArcGIS Online hosted services or ArcGIS Enterprise 10.6 services. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnExceededLimitFeatures) - * + * * @default true */ returnExceededLimitFeatures?: boolean; /** - * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. + * If `true`, each feature in the returned [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. * > **Known Limitations** For [FeatureLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html) queries, the precision of the returned geometries will only be as high as the view's scale resolution since geometries are quantized for improved performance on the view. The smaller the scale, the lower the resolution of the geometries. This limitation does not apply to [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), and [CSVLayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) - * + * * @default false */ returnGeometry?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) is `true`, then m-values are included in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnM) */ returnM?: boolean; /** * If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnGeometry) is `true`, then z-values are included in the geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#returnZ) */ returnZ?: boolean; /** - * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). See the [Types of spatial relationships that can be validated](https://desktop.arcgis.com/en/arcmap/latest/extensions/data-reviewer/types-of-spatial-relationships-that-can-be-validated.htm) document for more details about each spatial relationship. The possible values are listed in the table below: - * + * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). See the [Types of spatial relationships that can be validated](https://desktop.arcgis.com/en/arcmap/latest/extensions/data-reviewer/types-of-spatial-relationships-that-can-be-validated.htm) document for more details about each spatial relationship. The possible values are listed in the table below: + * * Value | Description * ------|------------- * intersects | Returns features from the layer or layer view that intersect the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). @@ -34379,48 +34379,48 @@ declare namespace __esri { * touches | Returns features from the layer or layer view that touch the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). * within | Returns features from the layer or layer view that are completely within the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#geometry). * relation | Allows specification of any relationship defined using the [Shape Comparison Language](http://resources.esri.com/help/9.3/arcgisengine/dotnet/concepts_start.htm#40de6491-9b2d-440d-848b-2609efcd46b1.htm). If this value is specified, then the [relationParameter](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#relationParameter) must also be specified. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#spatialRelationship) - * + * * @default intersects */ spatialRelationship?: string; /** - * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-.htm) for more information. **Possible Values:** none | standard | native + * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-.htm) for more information. **Possible Values:** none | standard | native * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#sqlFormat) - * + * * @default none */ sqlFormat?: string; /** - * The zero-based index indicating where to begin retrieving features. This property hould be used in conjunction with [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num). Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by object ID by default. + * The zero-based index indicating where to begin retrieving features. This property hould be used in conjunction with [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num). Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by object ID by default. * > **Known Limitations** This property does not apply to layer view or [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) queries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) */ start?: number; /** * Shorthand for a where clause using "like". The field used is the display field defined in the services directory. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#text) - * + * * @default null */ text?: string; /** - * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) is specified in spatial queries. if `unit` is not specified, the unit is derived from the layer or layer view's [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). + * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#distance) is specified in spatial queries. if `unit` is not specified, the unit is derived from the layer or layer view's [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html). * > **Known Limitations** For service-based queries, this parameter only applies if [supportsQueryWithDistance](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) is `true`. * **Possible Values:** feet | miles | nautical-miles | us-nautical-miles | meters | kilometers - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#units) */ units?: string; /** * A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed. Be sure to have the correct sequence of single and double quotes when writing the where clause in JavaScript. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#where) */ where?: string; @@ -34430,13 +34430,13 @@ declare namespace __esri { export interface QueryParameterValues extends Object { /** * The parameter name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#parameterValues) */ name: string; /** * Single value or array of values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#parameterValues) */ value: string | string[] | number | number[] | Date | Date[]; @@ -34446,27 +34446,27 @@ declare namespace __esri { export interface QueryQuantizationParameters extends Object { /** * An extent defining the quantization grid bounds. Its [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) matches the input geometry spatial reference if one is specified for the query. Otherwise, the extent will be in the layer's spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) */ extent?: Extent; /** * Geometry coordinates are optimized for viewing and displaying of data. **Possible Values:** view - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) */ mode?: string; /** * The integer's coordinates will be returned relative to the origin position defined by this property value. **Possible Values:** upper-left | lower-left - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) - * + * * @default upper-left */ originPosition?: string; /** * The size of one pixel in the units of outSpatialReference. This number is used to convert coordinates to integers by building a grid with a resolution matching the tolerance. Each coordinate is then snapped to one pixel on the grid. Consecutive coordinates snapped to the same pixel are removed for reducing the overall response size. The units of tolerance will match the units of outSpatialReference. If outSpatialReference is not specified, then tolerance is assumed to be in the units of the spatial reference of the layer. If tolerance is not specified, the maxAllowableOffset is used. If tolerance and maxAllowableOffset are not specified, a grid of 10,000 * 10,000 grid is used by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#quantizationParameters) */ tolerance?: number; @@ -34476,13 +34476,13 @@ declare namespace __esri { export interface QueryRangeValues extends Object { /** * The range id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#rangeValues) */ name: string; /** * Single value or value range. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#rangeValues) */ values: number | number[]; @@ -34491,19 +34491,19 @@ declare namespace __esri { interface RasterData extends Accessor, JSONSupport { /** * Specifies the format of the raster data, such as "jpg", "tif", etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#format) */ format: string; /** * The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater, this class can be used to specify an uploaded item as input by specifying the ItemID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#itemId) */ itemId: string; /** * URL to the location of the raster data file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#url) */ url: string; @@ -34522,19 +34522,19 @@ declare namespace __esri { interface RasterDataProperties { /** * Specifies the format of the raster data, such as "jpg", "tif", etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#format) */ format?: string; /** * The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater, this class can be used to specify an uploaded item as input by specifying the ItemID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#itemId) */ itemId?: string; /** * URL to the location of the raster data file. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RasterData.html#url) */ url?: string; @@ -34543,19 +34543,19 @@ declare namespace __esri { interface RelationParameters extends Accessor { /** * The first array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#geometries1) */ geometries1: Geometry[]; /** * The second array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#geometries2) */ geometries2: Geometry[]; /** - * The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values. If the relation is specified as `relation`, the `relationParamater` parameter describes the spatial relationship and must be specified. - * + * The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values. If the relation is specified as `relation`, the `relationParamater` parameter describes the spatial relationship and must be specified. + * * Value | Description * ------|------------ * cross | Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline. Cross is a Clementini operator. If either one of the geometries is empty, the geometries do not cross. @@ -34570,24 +34570,24 @@ declare namespace __esri { * relation | Allows specification of any relationship defined using the Shape Comparison Language. If this value is used, a value for `relationParameter` must be specified. * touch | The union of point touch and line touch. Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. If either one of the two geometries is empty, the geometries are not touched. * within | Same as `in` but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#relation) */ relation: string; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details. An example of a valid string is: `FFFTTT**`. Also see the description of [geometryEngine.relate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#relate) for additional examples of valid strings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#relationParameter) */ relationParameter: string; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -34603,19 +34603,19 @@ declare namespace __esri { interface RelationParametersProperties { /** * The first array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#geometries1) */ geometries1?: GeometryProperties[]; /** * The second array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#geometries2) */ geometries2?: GeometryProperties[]; /** - * The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values. If the relation is specified as `relation`, the `relationParamater` parameter describes the spatial relationship and must be specified. - * + * The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values. If the relation is specified as `relation`, the `relationParamater` parameter describes the spatial relationship and must be specified. + * * Value | Description * ------|------------ * cross | Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline. Cross is a Clementini operator. If either one of the geometries is empty, the geometries do not cross. @@ -34630,14 +34630,14 @@ declare namespace __esri { * relation | Allows specification of any relationship defined using the Shape Comparison Language. If this value is used, a value for `relationParameter` must be specified. * touch | The union of point touch and line touch. Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. If either one of the two geometries is empty, the geometries are not touched. * within | Same as `in` but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#relation) */ relation?: string; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. The [Relational functions for ST_Geometry](https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/relational-functions-for-st-geometry.htm) topic has additional details. An example of a valid string is: `FFFTTT**`. Also see the description of [geometryEngine.relate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#relate) for additional examples of valid strings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationParameters.html#relationParameter) */ relationParameter?: string; @@ -34646,73 +34646,73 @@ declare namespace __esri { interface RelationshipQuery extends Accessor, JSONSupport { /** * The definition expression to be applied to the related table or layer. Only records in the list of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#objectIds) that satisfy the definition expression are queried for related records. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#definitionExpression) */ definitionExpression: string; /** * Specify the geodatabase version to query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#gdbVersion) */ gdbVersion: string; /** * Specify the number of decimal places for the geometries returned by the query operation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#geometryPrecision) */ geometryPrecision: number; /** * The historic moment to query. This parameter applies only if the `supportsHistoricMoment` on [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#historicMoment) */ historicMoment: Date; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of `outSpatialReference`. If `outSpatialReference` is not defined, the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#maxAllowableOffset) */ maxAllowableOffset: number; /** * An array of objectIds for the features in the layer/table being queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#objectIds) */ objectIds: number[]; /** * Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list actual field names rather than the alias names. You are, however, able to use the alias names when you display the results. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the faster the response will be. Each query must have access to the Shape and ObjectId fields for a layer. However, your list of fields does not need to include these two fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#outFields) */ outFields: string[]; /** * The spatial reference for the returned geometry. If `outSpatialReference` is not defined, the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The ID of the relationship to be queried. The ids for the relationships the table or layer participates in are listed in the ArcGIS Services directory. The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Feature Service Layer resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#relationshipId) */ relationshipId: number; /** * If `true`, each feature in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. Set to `false` (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#returnGeometry) - * + * * @default false */ returnGeometry: boolean; /** * Creates a deep clone of RelationshipQuery object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#clone) - * - * + * + * */ clone(): RelationshipQuery; } @@ -34730,63 +34730,63 @@ declare namespace __esri { interface RelationshipQueryProperties { /** * The definition expression to be applied to the related table or layer. Only records in the list of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#objectIds) that satisfy the definition expression are queried for related records. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#definitionExpression) */ definitionExpression?: string; /** * Specify the geodatabase version to query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#gdbVersion) */ gdbVersion?: string; /** * Specify the number of decimal places for the geometries returned by the query operation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#geometryPrecision) */ geometryPrecision?: number; /** * The historic moment to query. This parameter applies only if the `supportsHistoricMoment` on [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is set to `true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#historicMoment) */ historicMoment?: DateProperties; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of `outSpatialReference`. If `outSpatialReference` is not defined, the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#maxAllowableOffset) */ maxAllowableOffset?: number; /** * An array of objectIds for the features in the layer/table being queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#objectIds) */ objectIds?: number[]; /** * Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list actual field names rather than the alias names. You are, however, able to use the alias names when you display the results. When specifying the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the faster the response will be. Each query must have access to the Shape and ObjectId fields for a layer. However, your list of fields does not need to include these two fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#outFields) */ outFields?: string[]; /** * The spatial reference for the returned geometry. If `outSpatialReference` is not defined, the [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The ID of the relationship to be queried. The ids for the relationships the table or layer participates in are listed in the ArcGIS Services directory. The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Feature Service Layer resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#relationshipId) */ relationshipId?: number; /** * If `true`, each feature in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) includes the geometry. Set to `false` (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RelationshipQuery.html#returnGeometry) - * + * * @default false */ returnGeometry?: boolean; @@ -34795,71 +34795,71 @@ declare namespace __esri { interface RouteParameters extends Accessor { /** * The list of network attribute names to be accumulated with the analysis. For example, which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. See also [Understanding the network attribute](http://resources.arcgis.com/en/help/main/10.2/index.html#//00470000000m000000). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#accumulateAttributes) */ accumulateAttributes: string[]; /** * Each element in the array is an object that describes the parameter values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#attributeParameterValues) */ attributeParameterValues: AttributeParamValue; /** * The set of point barriers loaded as network locations during analysis. At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#barriers) */ barriers: DataLayer | FeatureSet; /** * The language used when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). By default, NAServer gets installed with `en_US` only - it is up to the server administrator to add additional languages. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLanguage) */ directionsLanguage: string; /** * The length units to use when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLengthUnits) */ directionsLengthUnits: string; /** * Defines the amount of direction information returned. **Possible Values:** complete | complete-no-events | instructions-only | standard | summary-only - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsOutputType) - * + * * @default standard */ directionsOutputType: string; /** * The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsStyleName) */ directionsStyleName: string; /** * The name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsTimeAttribute) */ directionsTimeAttribute: string; /** * If `true`, avoids network elements restricted by barriers or restrictions specified in [restrictionAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictionAttributes). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements: boolean; /** - * The [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) can help you find the most efficient path for visiting a given list of stops. This is sometimes known as the "traveling salesperson" problem. When the `findBestSequence = true`, the route solver is solving the Traveling Salesperson problem by computing the optimal sequence to visit the stops. As this is a combinatorial problem, we employ heuristics to solve this in a reasonable time. The heuristics do not guarantee the optimal sequence (as there is no good/fast way to prove optimality for large number of stops). It returns a solution that is close to optimal if not the optimal. The heuristic performs favorably when tested with known TSP benchmarks available in the OR research community. For these stops to be visited in the most efficient way, specify the following parameters: + * The [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) can help you find the most efficient path for visiting a given list of stops. This is sometimes known as the "traveling salesperson" problem. When the `findBestSequence = true`, the route solver is solving the Traveling Salesperson problem by computing the optimal sequence to visit the stops. As this is a combinatorial problem, we employ heuristics to solve this in a reasonable time. The heuristics do not guarantee the optimal sequence (as there is no good/fast way to prove optimality for large number of stops). It returns a solution that is close to optimal if not the optimal. The heuristic performs favorably when tested with known TSP benchmarks available in the OR research community. For these stops to be visited in the most efficient way, specify the following parameters: * ```js * routeParams.findBestSequence = true; * routeParams.preserveFirstStop = false; * routeParams.preserveLastStop = false; * routeParams.returnStops = true; * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#findBestSequence) */ findBestSequence: boolean; @@ -34867,171 +34867,171 @@ declare namespace __esri { * In routes where a stop is not located on a network or a stop could not be reached, the results will differ depending on the value of this property: * * When `false`, the solve operation will fail if at least one of the stops specified cannot be located or reached. * * When `true`, as long as there are at least two valid stops that have been connected by a route, a valid result is returned. If multiple routes are processed in a single request, as long as least one route is built, a valid result is returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations: boolean; /** * The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service. For example, set `impedanceAttribute = "Time"` for the quickest route and `impedanceAttribute = "Length"` for shortest drive, assuming the service has those two esriNAUTCost attributes. For more information, see [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#impedanceAttribute) */ impedanceAttribute: string; /** * The precision of the output geometry after generalization. If `0`, no generalization of output geometry is performed. If present and positive, it represents the `MaximumAllowableOffset` parameter and generalization is performed according to `IPolycurve.Generalize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: string; /** * The type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** none | straight | true-shape | true-shape-with-measure - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputLines) - * + * * @default true-shape */ outputLines: string; /** * The well-known ID of the spatial reference for the geometries returned with the analysis results. If not specified, the geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * The set of polygon barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the `features` or `url` property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#polygonBarriers) */ polygonBarriers: DataLayer | FeatureSet; /** * The set of polyline barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the `features` or `url` property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#polylineBarriers) */ polylineBarriers: DataLayer | FeatureSet; /** * If `true`, keeps the first stop fixed in the sequence even when `findBestSequence = true`. Only applicable if `findBestSequence = true`. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#preserveFirstStop) */ preserveFirstStop: boolean; /** * If `true`, keeps the last stop fixed in the sequence even when `findBestSequence = true`. Only applicable if `findBestSequence = true`. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#preserveLastStop) */ preserveLastStop: boolean; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). Possible values are listed in the Service Directory under `Network Dataset -> Network Attributes`. You can also specify a value of `none` to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictionAttributes) */ restrictionAttributes: string[]; /** * Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictUTurns) */ restrictUTurns: string; /** * If `true`, barriers are returned with the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnBarriers) - * + * * @default false */ returnBarriers: boolean; /** * If `true`, barriers are returned in the [directions property of each RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#directions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnDirections) - * + * * @default false */ returnDirections: boolean; /** * If `true`, polygon barriers are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers: boolean; /** * If `true`, polyline barriers are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers: boolean; /** * If `true`, routes are generated and returned in the route property of each [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnRoutes) - * + * * @default true */ returnRoutes: boolean; /** * If `true`, stops are returned in the stops property of each [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnStops) - * + * * @default false */ returnStops: boolean; /** * If `true`, `z` values are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnZ) - * + * * @default true */ returnZ: boolean; /** * The time the route begins. If not specified, the default is the time specified in the route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#startTime) */ startTime: Date; /** * If `true`, the start time will be in UTC format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#startTimeIsUTC) */ startTimeIsUTC: boolean; /** * The set of stops loaded as network locations during analysis. When `stops` takes a FeatureSet, each feature in the FeatureSet must have a defined spatial reference. If the feature contains `x` and `y` attributes, those values are used for the stop, even if the feature includes geometry. At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The `url` property can be specified using DataFile Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#stops) */ stops: DataLayer | FeatureSet; /** * If `true`, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#useHierarchy) */ useHierarchy: boolean; /** * A useful feature of the [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) is the ability to constrain stop visits to certain times of day, or "time windows". If you were required to deliver orders to four homes and each customer was available during a limited time period during the day, the route task could help you find the most efficient path for making all the deliveries. Time windows are treated as a "soft" constraint. This means that although the solver attempts to honor time windows, if necessary, it will violate the time windows of some stops in order to reach them. Remember, the stops will be visited in the order they were added unless you set `RouteParameters.findBestSequence = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#useTimeWindows) */ useTimeWindows: boolean; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -35047,71 +35047,71 @@ declare namespace __esri { interface RouteParametersProperties { /** * The list of network attribute names to be accumulated with the analysis. For example, which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. See also [Understanding the network attribute](http://resources.arcgis.com/en/help/main/10.2/index.html#//00470000000m000000). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#accumulateAttributes) */ accumulateAttributes?: string[]; /** * Each element in the array is an object that describes the parameter values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#attributeParameterValues) */ attributeParameterValues?: AttributeParamValue; /** * The set of point barriers loaded as network locations during analysis. At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#barriers) */ barriers?: DataLayerProperties | FeatureSetProperties; /** * The language used when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). By default, NAServer gets installed with `en_US` only - it is up to the server administrator to add additional languages. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLanguage) */ directionsLanguage?: string; /** * The length units to use when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsLengthUnits) */ directionsLengthUnits?: string; /** * Defines the amount of direction information returned. **Possible Values:** complete | complete-no-events | instructions-only | standard | summary-only - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsOutputType) - * + * * @default standard */ directionsOutputType?: string; /** * The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsStyleName) */ directionsStyleName?: string; /** * The name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#directionsTimeAttribute) */ directionsTimeAttribute?: string; /** * If `true`, avoids network elements restricted by barriers or restrictions specified in [restrictionAttributes](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictionAttributes). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements?: boolean; /** - * The [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) can help you find the most efficient path for visiting a given list of stops. This is sometimes known as the "traveling salesperson" problem. When the `findBestSequence = true`, the route solver is solving the Traveling Salesperson problem by computing the optimal sequence to visit the stops. As this is a combinatorial problem, we employ heuristics to solve this in a reasonable time. The heuristics do not guarantee the optimal sequence (as there is no good/fast way to prove optimality for large number of stops). It returns a solution that is close to optimal if not the optimal. The heuristic performs favorably when tested with known TSP benchmarks available in the OR research community. For these stops to be visited in the most efficient way, specify the following parameters: + * The [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) can help you find the most efficient path for visiting a given list of stops. This is sometimes known as the "traveling salesperson" problem. When the `findBestSequence = true`, the route solver is solving the Traveling Salesperson problem by computing the optimal sequence to visit the stops. As this is a combinatorial problem, we employ heuristics to solve this in a reasonable time. The heuristics do not guarantee the optimal sequence (as there is no good/fast way to prove optimality for large number of stops). It returns a solution that is close to optimal if not the optimal. The heuristic performs favorably when tested with known TSP benchmarks available in the OR research community. For these stops to be visited in the most efficient way, specify the following parameters: * ```js * routeParams.findBestSequence = true; * routeParams.preserveFirstStop = false; * routeParams.preserveLastStop = false; * routeParams.returnStops = true; * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#findBestSequence) */ findBestSequence?: boolean; @@ -35119,161 +35119,161 @@ declare namespace __esri { * In routes where a stop is not located on a network or a stop could not be reached, the results will differ depending on the value of this property: * * When `false`, the solve operation will fail if at least one of the stops specified cannot be located or reached. * * When `true`, as long as there are at least two valid stops that have been connected by a route, a valid result is returned. If multiple routes are processed in a single request, as long as least one route is built, a valid result is returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#ignoreInvalidLocations) */ ignoreInvalidLocations?: boolean; /** * The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service. For example, set `impedanceAttribute = "Time"` for the quickest route and `impedanceAttribute = "Length"` for shortest drive, assuming the service has those two esriNAUTCost attributes. For more information, see [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#impedanceAttribute) */ impedanceAttribute?: string; /** * The precision of the output geometry after generalization. If `0`, no generalization of output geometry is performed. If present and positive, it represents the `MaximumAllowableOffset` parameter and generalization is performed according to `IPolycurve.Generalize`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: string; /** * The type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** none | straight | true-shape | true-shape-with-measure - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outputLines) - * + * * @default true-shape */ outputLines?: string; /** * The well-known ID of the spatial reference for the geometries returned with the analysis results. If not specified, the geometries are returned in the spatial reference of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * The set of polygon barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the `features` or `url` property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#polygonBarriers) */ polygonBarriers?: DataLayerProperties | FeatureSetProperties; /** * The set of polyline barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the `features` or `url` property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#polylineBarriers) */ polylineBarriers?: DataLayerProperties | FeatureSetProperties; /** * If `true`, keeps the first stop fixed in the sequence even when `findBestSequence = true`. Only applicable if `findBestSequence = true`. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#preserveFirstStop) */ preserveFirstStop?: boolean; /** * If `true`, keeps the last stop fixed in the sequence even when `findBestSequence = true`. Only applicable if `findBestSequence = true`. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#preserveLastStop) */ preserveLastStop?: boolean; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). Possible values are listed in the Service Directory under `Network Dataset -> Network Attributes`. You can also specify a value of `none` to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictionAttributes) */ restrictionAttributes?: string[]; /** * Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). **Possible Values:** allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#restrictUTurns) */ restrictUTurns?: string; /** * If `true`, barriers are returned with the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnBarriers) - * + * * @default false */ returnBarriers?: boolean; /** * If `true`, barriers are returned in the [directions property of each RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#directions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnDirections) - * + * * @default false */ returnDirections?: boolean; /** * If `true`, polygon barriers are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers?: boolean; /** * If `true`, polyline barriers are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers?: boolean; /** * If `true`, routes are generated and returned in the route property of each [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnRoutes) - * + * * @default true */ returnRoutes?: boolean; /** * If `true`, stops are returned in the stops property of each [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnStops) - * + * * @default false */ returnStops?: boolean; /** * If `true`, `z` values are returned in the [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#returnZ) - * + * * @default true */ returnZ?: boolean; /** * The time the route begins. If not specified, the default is the time specified in the route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#startTime) */ startTime?: DateProperties; /** * If `true`, the start time will be in UTC format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#startTimeIsUTC) */ startTimeIsUTC?: boolean; /** * The set of stops loaded as network locations during analysis. When `stops` takes a FeatureSet, each feature in the FeatureSet must have a defined spatial reference. If the feature contains `x` and `y` attributes, those values are used for the stop, even if the feature includes geometry. At ArcGIS Server 10.1 an optional `url` property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The `url` property can be specified using DataFile Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#stops) */ stops?: DataLayerProperties | FeatureSetProperties; /** * If `true`, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#useHierarchy) */ useHierarchy?: boolean; /** * A useful feature of the [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) is the ability to constrain stop visits to certain times of day, or "time windows". If you were required to deliver orders to four homes and each customer was available during a limited time period during the day, the route task could help you find the most efficient path for making all the deliveries. Time windows are treated as a "soft" constraint. This means that although the solver attempts to honor time windows, if necessary, it will violate the time windows of some stops in order to reach them. Remember, the stops will be visited in the order they were added unless you set `RouteParameters.findBestSequence = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#useTimeWindows) */ useTimeWindows?: boolean; @@ -35281,25 +35281,25 @@ declare namespace __esri { /** * An object describing the parameter values for the [attributeParameterValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#attributeParameterValues) property of [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#AttributeParamValue) */ export interface AttributeParamValue extends Object { /** * The name of the attribute. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#AttributeParamValue) */ attributeName: string; /** * The name of the parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#AttributeParamValue) */ parameterName: string; /** * The parameter's value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html#AttributeParamValue) */ value: string; @@ -35308,25 +35308,25 @@ declare namespace __esri { interface RouteResult extends Accessor, JSONSupport { /** * Route directions are returned if `RouteParameters.returnDirections = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#directions) */ directions: DirectionsFeatureSet; /** * The Route graphic that is returned if `RouteParameters.returnRoutes = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#route) */ route: Graphic; /** * The name of the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#routeName) */ routeName: string; /** * Array of stops. Returned only if `RouteParameters.returnStops = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#stops) */ stops: Graphic[]; @@ -35345,25 +35345,25 @@ declare namespace __esri { interface RouteResultProperties { /** * Route directions are returned if `RouteParameters.returnDirections = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#directions) */ directions?: DirectionsFeatureSetProperties; /** * The Route graphic that is returned if `RouteParameters.returnRoutes = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#route) */ route?: GraphicProperties; /** * The name of the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#routeName) */ routeName?: string; /** * Array of stops. Returned only if `RouteParameters.returnStops = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html#stops) */ stops?: GraphicProperties[]; @@ -35372,247 +35372,247 @@ declare namespace __esri { interface ServiceAreaParameters extends Accessor { /** * The list of network attribute names to be accumulated with the analysis (i.e. which attributes should be returned as part of the response). The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attributes names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#accumulateAttributes) */ accumulateAttributes: string[]; /** * A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. The parameter holding a vehicle characteristic is compared to a value coming from a descriptor attribute to determine whether or not a network element is traversable. For example, a parameterized restriction attribute can compare the height of your vehicle with a descriptor attribute that holds the clearance under overpasses through tunnels. If the vehicle's height is greater than the clearance, the edge is restricted. Parameterized cost attributes that reference other cost attributes and scale them, can also be used. This is useful when inclement weather like ice, fog or heavy rain, descends on the study area and hinders normal flow of traffic. By having a parameter already outfitted on a cost attribute, travel-time expectations and traversable network paths can be adjusted with respect to changes in traffic speeds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#attributeParameterValues) */ attributeParameterValues: any[]; /** * An array of numbers defining the breaks. The default value is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#defaultBreaks) */ defaultBreaks: number[]; /** * When `true`, restricted network elements should be considered when finding network locations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements: boolean; /** * An array of network source names to NOT use when generating polygons. This property specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#excludeSourcesFromPolygons) */ excludeSourcesFromPolygons: string[]; /** * The set of facilities loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using `DataFile`. Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#facilities) */ facilities: DataLayer | FeatureSet; /** * The network attribute name used as the impedance attribute in analysis. The default is as defined in the routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set `impedanceAttribute = 'Time'` for quickest route and `impedanceAttribute = 'Length'` for shortest drive, assuming the service has those two esriNAUTCost attributes. View the [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm) ArcGIS desktop help topic for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#impedanceAttribute) */ impedanceAttribute: string; /** * If `true`, similar ranges will be merged in the resulting polygons. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges) - * + * * @default false */ mergeSimilarPolygonRanges: boolean; /** * The precision of the output geometry after generalization. If `0`, no generalization of output geometry is performed. If present and positive, it represents the `MaximumAllowableOffset` parameter and generalization is performed according to IPolycurve.Generalize. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputGeometryPrecision) */ outputGeometryPrecision: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits: string; /** - * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). + * * Possible Value | Description * ---------------|------------ * none | No lines are returned * straight | Only returns straight lines * true-shape | Return the true shape of the lines * true-shape-with-measure | Return the true shape of the lines with their measurements - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputLines) */ outputLines: string; /** * The type of output polygons to be generated in the result. The default is as defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). **Possible Values:** none | simplified | detailed - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputPolygons) */ outputPolygons: string; /** * The well-known ID of the spatial reference for the geometries returned with the analysis results. If `outSpatialReference` is not specified, the geometries are returned in the spatial reference of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outSpatialReference) */ outSpatialReference: SpatialReference; /** * Indicates if the lines should overlap from multiple facilities. The default is defined by the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#overlapLines) - * + * * @default false */ overlapLines: boolean; /** * Indicates if the polygons should overlap from multiple facilities. The default is defined by the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#overlapPolygons) - * + * * @default false */ overlapPolygons: boolean; /** * The set of point barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#pointBarriers) */ pointBarriers: DataLayer | FeatureSet; /** * The set of polygon barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#polygonBarriers) */ polygonBarriers: DataLayer | FeatureSet; /** * The set of polyline barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#polylineBarriers) */ polylineBarriers: DataLayer | FeatureSet; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attributes names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#restrictionAttributes) */ restrictionAttributes: string[]; /** - * Specifies how U-turns should be handled. The default is defined in the routing network layer used in your RouteTask. - * + * Specifies how U-turns should be handled. The default is defined in the routing network layer used in your RouteTask. + * * Possible Value | Description * ---------------|------------ * allow-backtrack | Allows U-turns on everywhere * at-dead-ends-only | Only allows U-turns at dead ends * no-backtrack | Restricts U-turns everywhere * at-dead-ends-and-intersections | Only allows U-turns at dead ends and intersections - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#restrictUTurns) */ restrictUTurns: string; /** * If `true`, facilities will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnFacilities) - * + * * @default false */ returnFacilities: boolean; /** * If `true`, point barriers will be returned in the [pointBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#pointBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPointBarriers) - * + * * @default false */ returnPointBarriers: boolean; /** * If `true`, polygon barriers will be returned in the [polygonBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polygonBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers: boolean; /** * If `true`, polyline barriers will be returned in the [polylineBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polylineBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers: boolean; /** * If `true`, lines will be split at breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#splitLinesAtBreaks) - * + * * @default false */ splitLinesAtBreaks: boolean; /** * If `true`, polygons will be split at breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#splitPolygonsAtBreaks) - * + * * @default false */ splitPolygonsAtBreaks: boolean; /** * Local date and time at the facility. If `travelDirection = "to-facility"`, the `timeOfDay` value specifies arrival time at the facility. if `travelDirection = "from-facility"`, `timeOfDay` specifies departure time from the facility. Requires ArcGIS Server service version 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#timeOfDay) */ timeOfDay: Date; /** - * Options for traveling to or from the facility. Default values are defined by the network layer. - * + * Options for traveling to or from the facility. Default values are defined by the network layer. + * * Possible Value | Description * ---------------|------------ * from-facility | Sets travel direction from the facility * to-facility | Sets travel direction to the facility - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#travelDirection) */ travelDirection: string; /** * If `true`, the outermost polygon (at the maximum break value) will be trimmed. The default is defined in the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimOuterPolygon) - * + * * @default false */ trimOuterPolygon: boolean; /** * If polygons are being trimmed, provides the distance to trim. The default value is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistance) */ trimPolygonDistance: number; /** * If polygons are being trimmed, specifies the units of [trimPolygonDistance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistance). The default is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistanceUnits) */ trimPolygonDistanceUnits: string; /** * When `true`, the hierarchy attributes for the network will be used in the analysis. The default value is defined in the network layer. `useHierarchy` cannot be used in conjunction with [outputLines](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputLines). Requires an ArcGIS Server service version 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#useHierarchy) */ useHierarchy: boolean; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -35620,7 +35620,7 @@ declare namespace __esri { interface ServiceAreaParametersConstructor { /** * Input parameters for [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html) */ @@ -35632,237 +35632,237 @@ declare namespace __esri { interface ServiceAreaParametersProperties { /** * The list of network attribute names to be accumulated with the analysis (i.e. which attributes should be returned as part of the response). The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attributes names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#accumulateAttributes) */ accumulateAttributes?: string[]; /** * A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. The parameter holding a vehicle characteristic is compared to a value coming from a descriptor attribute to determine whether or not a network element is traversable. For example, a parameterized restriction attribute can compare the height of your vehicle with a descriptor attribute that holds the clearance under overpasses through tunnels. If the vehicle's height is greater than the clearance, the edge is restricted. Parameterized cost attributes that reference other cost attributes and scale them, can also be used. This is useful when inclement weather like ice, fog or heavy rain, descends on the study area and hinders normal flow of traffic. By having a parameter already outfitted on a cost attribute, travel-time expectations and traversable network paths can be adjusted with respect to changes in traffic speeds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#attributeParameterValues) */ attributeParameterValues?: any[]; /** * An array of numbers defining the breaks. The default value is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#defaultBreaks) */ defaultBreaks?: number[]; /** * When `true`, restricted network elements should be considered when finding network locations. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#doNotLocateOnRestrictedElements) - * + * * @default true */ doNotLocateOnRestrictedElements?: boolean; /** * An array of network source names to NOT use when generating polygons. This property specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#excludeSourcesFromPolygons) */ excludeSourcesFromPolygons?: string[]; /** * The set of facilities loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using `DataFile`. Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#facilities) */ facilities?: DataLayerProperties | FeatureSetProperties; /** * The network attribute name used as the impedance attribute in analysis. The default is as defined in the routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set `impedanceAttribute = 'Time'` for quickest route and `impedanceAttribute = 'Length'` for shortest drive, assuming the service has those two esriNAUTCost attributes. View the [Understanding the network attribute](http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/understanding-network-attributes.htm) ArcGIS desktop help topic for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#impedanceAttribute) */ impedanceAttribute?: string; /** * If `true`, similar ranges will be merged in the resulting polygons. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges) - * + * * @default false */ mergeSimilarPolygonRanges?: boolean; /** * The precision of the output geometry after generalization. If `0`, no generalization of output geometry is performed. If present and positive, it represents the `MaximumAllowableOffset` parameter and generalization is performed according to IPolycurve.Generalize. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputGeometryPrecision) */ outputGeometryPrecision?: number; /** * The units of the output geometry precision. **Possible Values:** centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits) */ outputGeometryPrecisionUnits?: string; /** - * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * The type of output lines to be generated in the result. The default is defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). + * * Possible Value | Description * ---------------|------------ * none | No lines are returned * straight | Only returns straight lines * true-shape | Return the true shape of the lines * true-shape-with-measure | Return the true shape of the lines with their measurements - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputLines) */ outputLines?: string; /** * The type of output polygons to be generated in the result. The default is as defined in the specific routing network layer used in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). **Possible Values:** none | simplified | detailed - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputPolygons) */ outputPolygons?: string; /** * The well-known ID of the spatial reference for the geometries returned with the analysis results. If `outSpatialReference` is not specified, the geometries are returned in the spatial reference of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outSpatialReference) */ outSpatialReference?: SpatialReferenceProperties; /** * Indicates if the lines should overlap from multiple facilities. The default is defined by the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#overlapLines) - * + * * @default false */ overlapLines?: boolean; /** * Indicates if the polygons should overlap from multiple facilities. The default is defined by the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#overlapPolygons) - * + * * @default false */ overlapPolygons?: boolean; /** * The set of point barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#pointBarriers) */ pointBarriers?: DataLayerProperties | FeatureSetProperties; /** * The set of polygon barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#polygonBarriers) */ polygonBarriers?: DataLayerProperties | FeatureSetProperties; /** * The set of polyline barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using [DataFile](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataFile.html). Note that either the features or url property should be specified. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#polylineBarriers) */ polylineBarriers?: DataLayerProperties | FeatureSetProperties; /** * The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attributes names listed in the Service Directory under `Network Dataset > Network Attributes` as `Usage Type: esriNAUTCost`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#restrictionAttributes) */ restrictionAttributes?: string[]; /** - * Specifies how U-turns should be handled. The default is defined in the routing network layer used in your RouteTask. - * + * Specifies how U-turns should be handled. The default is defined in the routing network layer used in your RouteTask. + * * Possible Value | Description * ---------------|------------ * allow-backtrack | Allows U-turns on everywhere * at-dead-ends-only | Only allows U-turns at dead ends * no-backtrack | Restricts U-turns everywhere * at-dead-ends-and-intersections | Only allows U-turns at dead ends and intersections - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#restrictUTurns) */ restrictUTurns?: string; /** * If `true`, facilities will be returned with the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnFacilities) - * + * * @default false */ returnFacilities?: boolean; /** * If `true`, point barriers will be returned in the [pointBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#pointBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPointBarriers) - * + * * @default false */ returnPointBarriers?: boolean; /** * If `true`, polygon barriers will be returned in the [polygonBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polygonBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPolygonBarriers) - * + * * @default false */ returnPolygonBarriers?: boolean; /** * If `true`, polyline barriers will be returned in the [polylineBarriers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polylineBarriers) property of the analysis results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#returnPolylineBarriers) - * + * * @default false */ returnPolylineBarriers?: boolean; /** * If `true`, lines will be split at breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#splitLinesAtBreaks) - * + * * @default false */ splitLinesAtBreaks?: boolean; /** * If `true`, polygons will be split at breaks. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#splitPolygonsAtBreaks) - * + * * @default false */ splitPolygonsAtBreaks?: boolean; /** * Local date and time at the facility. If `travelDirection = "to-facility"`, the `timeOfDay` value specifies arrival time at the facility. if `travelDirection = "from-facility"`, `timeOfDay` specifies departure time from the facility. Requires ArcGIS Server service version 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#timeOfDay) */ timeOfDay?: DateProperties; /** - * Options for traveling to or from the facility. Default values are defined by the network layer. - * + * Options for traveling to or from the facility. Default values are defined by the network layer. + * * Possible Value | Description * ---------------|------------ * from-facility | Sets travel direction from the facility * to-facility | Sets travel direction to the facility - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#travelDirection) */ travelDirection?: string; /** * If `true`, the outermost polygon (at the maximum break value) will be trimmed. The default is defined in the network analysis layer in your [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimOuterPolygon) - * + * * @default false */ trimOuterPolygon?: boolean; /** * If polygons are being trimmed, provides the distance to trim. The default value is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistance) */ trimPolygonDistance?: number; /** * If polygons are being trimmed, specifies the units of [trimPolygonDistance](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistance). The default is defined in the network analysis layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#trimPolygonDistanceUnits) */ trimPolygonDistanceUnits?: string; /** * When `true`, the hierarchy attributes for the network will be used in the analysis. The default value is defined in the network layer. `useHierarchy` cannot be used in conjunction with [outputLines](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#outputLines). Requires an ArcGIS Server service version 10.1 or greater. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaParameters.html#useHierarchy) */ useHierarchy?: boolean; @@ -35871,43 +35871,43 @@ declare namespace __esri { interface ServiceAreaSolveResult extends Accessor, JSONSupport { /** * Array of points only returned if `ServiceAreaParameters.returnFacilities = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#facilities) */ facilities: Point[]; /** * Message received when solve is completed. If a service area cannot be solved, the message returned by the server identifies the incident that could not be solved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#messages) */ messages: NAMessage[]; /** * The point barriers are returned only if `ServiceAreaParameters.returnPointBarriers = true` (which is not the default). If you send in the point barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#pointBarriers) */ pointBarriers: Point[]; /** * The polygon barriers are returned only if `ServiceAreaParameters.returnPolygonBarriers = true` (which is not the default). If you send in the polygon barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polygonBarriers) */ polygonBarriers: Polygon[]; /** * The polyline barriers are returned only if `ServiceAreaParameters.returnPolylineBarriers = true` (which is not the default). If you send in the polyline barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polylineBarriers) */ polylineBarriers: Polyline[]; /** * An array of service area polygon graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#serviceAreaPolygons) */ serviceAreaPolygons: Graphic[]; /** * An array of service area polyline graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#serviceAreaPolylines) */ serviceAreaPolylines: Graphic[]; @@ -35916,7 +35916,7 @@ declare namespace __esri { interface ServiceAreaSolveResultConstructor { /** * The result from [ServiceAreaTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-ServiceAreaTask.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html) */ @@ -35930,43 +35930,43 @@ declare namespace __esri { interface ServiceAreaSolveResultProperties { /** * Array of points only returned if `ServiceAreaParameters.returnFacilities = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#facilities) */ facilities?: PointProperties[]; /** * Message received when solve is completed. If a service area cannot be solved, the message returned by the server identifies the incident that could not be solved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#messages) */ messages?: NAMessageProperties[]; /** * The point barriers are returned only if `ServiceAreaParameters.returnPointBarriers = true` (which is not the default). If you send in the point barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#pointBarriers) */ pointBarriers?: PointProperties[]; /** * The polygon barriers are returned only if `ServiceAreaParameters.returnPolygonBarriers = true` (which is not the default). If you send in the polygon barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polygonBarriers) */ polygonBarriers?: PolygonProperties[]; /** * The polyline barriers are returned only if `ServiceAreaParameters.returnPolylineBarriers = true` (which is not the default). If you send in the polyline barriers as a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html) (instead of using [DataLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-DataLayer.html)), you already have the barriers and might not need to request them back from the server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#polylineBarriers) */ polylineBarriers?: PolylineProperties[]; /** * An array of service area polygon graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#serviceAreaPolygons) */ serviceAreaPolygons?: GraphicProperties[]; /** * An array of service area polyline graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-ServiceAreaSolveResult.html#serviceAreaPolylines) */ serviceAreaPolylines?: GraphicProperties[]; @@ -35975,19 +35975,19 @@ declare namespace __esri { interface StatisticDefinition extends Accessor, JSONSupport { /** * Defines the field for which statistics will be calculated. This can be service field names or SQL expressions. See the snippets below for examples. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#onStatisticField) */ onStatisticField: string; /** * Specifies the output field name for the requested statistic. Output field names can only contain alpha-numeric characters and an underscore. If no output field name is specified, the server assigns a field name to the returned statistic field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#outStatisticFieldName) */ outStatisticFieldName: string; /** * Defines the type of statistic. **Possible Values:** count | sum | min | max | avg | stddev | var - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#statisticType) */ statisticType: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var"; @@ -36006,19 +36006,19 @@ declare namespace __esri { interface StatisticDefinitionProperties { /** * Defines the field for which statistics will be calculated. This can be service field names or SQL expressions. See the snippets below for examples. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#onStatisticField) */ onStatisticField?: string; /** * Specifies the output field name for the requested statistic. Output field names can only contain alpha-numeric characters and an underscore. If no output field name is specified, the server assigns a field name to the returned statistic field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#outStatisticFieldName) */ outStatisticFieldName?: string; /** * Defines the type of statistic. **Possible Values:** count | sum | min | max | avg | stddev | var - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-StatisticDefinition.html#statisticType) */ statisticType?: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var"; @@ -36026,8 +36026,8 @@ declare namespace __esri { interface TrimExtendParameters extends Accessor { /** - * A flag used with the `trimExtend` operation. - * + * A flag used with the `trimExtend` operation. + * * Possible Value | Description * ---------------|------------- * default-curve-extension | The extension considers both ends of the path. The old ends remain and new points are added to the extended ends. The new points have attributes that are extrapolated from existing adjacent segments. @@ -36036,32 +36036,32 @@ declare namespace __esri { * no-end-attributes | When an extension is performed at an end, do not extrapolate the end segments attributes for the new point. Instead the attributes will be empty. * no-extend-at-from | Do not extend the 'from' end of any path. * no-extend-at-to | Do not extend the 'to' end of any path. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#extendHow) - * + * * @default default-curve-extension */ extendHow: string; /** * The array of polylines to trim or extend. The structure of each geometry in the array is the same as the structure of the JSON polyline objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#polylines) */ polylines: Polyline[]; /** * A polyline used as a guide for trimming or extending input polylines. The structure of the polyline is the same as the structure of the JSON polyline object returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#trimExtendTo) */ trimExtendTo: Polyline; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#toJSON) - * - * + * + * */ toJSON(): any; } @@ -36076,8 +36076,8 @@ declare namespace __esri { interface TrimExtendParametersProperties { /** - * A flag used with the `trimExtend` operation. - * + * A flag used with the `trimExtend` operation. + * * Possible Value | Description * ---------------|------------- * default-curve-extension | The extension considers both ends of the path. The old ends remain and new points are added to the extended ends. The new points have attributes that are extrapolated from existing adjacent segments. @@ -36086,22 +36086,22 @@ declare namespace __esri { * no-end-attributes | When an extension is performed at an end, do not extrapolate the end segments attributes for the new point. Instead the attributes will be empty. * no-extend-at-from | Do not extend the 'from' end of any path. * no-extend-at-to | Do not extend the 'to' end of any path. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#extendHow) - * + * * @default default-curve-extension */ extendHow?: string; /** * The array of polylines to trim or extend. The structure of each geometry in the array is the same as the structure of the JSON polyline objects returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#polylines) */ polylines?: PolylineProperties[]; /** * A polyline used as a guide for trimming or extending input polylines. The structure of the polyline is the same as the structure of the JSON polyline object returned by the ArcGIS REST API. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-TrimExtendParameters.html#trimExtendTo) */ trimExtendTo?: PolylineProperties; @@ -36110,13 +36110,13 @@ declare namespace __esri { interface Task extends Accessor { /** * The [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for data requests. These options can also be controlled through the `requestOptions` method parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Task.html#requestOptions) */ requestOptions: any; /** * The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Task.html#url) */ url: string; @@ -36133,13 +36133,13 @@ declare namespace __esri { interface TaskProperties { /** * The [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for data requests. These options can also be controlled through the `requestOptions` method parameter. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Task.html#requestOptions) */ requestOptions?: any; /** * The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Task.html#url) */ url?: string; @@ -36148,119 +36148,119 @@ declare namespace __esri { interface ConfigurationTask extends Task { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#url) */ url: string; /** * Gets an array of all the user groups that are configured in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getAllGroups) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAllGroups(requestOptions?: any): IPromise; /** * Gets an array of all the users that are configured in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getAllUsers) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAllUsers(requestOptions?: any): IPromise; /** * Gets the properties and an array of geodatabase versions for a data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getDataWorkspaceDetails) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.dataWorkspaceId The unique id of the data workspace, whose version will be returned. * @param params.user The user name of the user who is requesting the information. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getDataWorkspaceDetails(params: ConfigurationTaskGetDataWorkspaceDetailsParams, requestOptions?: any): IPromise; /** * Gets a single user group in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getGroup) - * + * * @param groupId The unique id of the group whose information will be retrieved. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getGroup(groupId: number, requestOptions?: any): IPromise; /** * Gets the detailed configuration properties of a job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getJobTypeDetails) - * + * * @param jobTypeId The unique id of a job type. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getJobTypeDetails(jobTypeId: number, requestOptions?: any): IPromise; /** * Gets the configuration of a publicly accessible job query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getPublicJobQueryDetails) - * + * * @param queryId The unique id of public query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getPublicJobQueryDetails(queryId: number, requestOptions?: any): IPromise; /** * Gets the [configuration information](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) specific to a Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getServiceInfo) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getServiceInfo(requestOptions?: any): IPromise; /** * Gets an array of registered [table relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getTableRelationshipsDetails) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getTableRelationshipsDetails(requestOptions?: any): IPromise; /** * Gets information for a single user in the system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getUser) - * + * * @param user The user name of the user whose information will be returned. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getUser(user: string, requestOptions?: any): IPromise; /** * Gets the configuration of a user-owned job query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getUserJobQueryDetails) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.queryId The unique id of user query. * @param params.user The user name of the user who is requesting the information. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getUserJobQueryDetails(params: ConfigurationTaskGetUserJobQueryDetailsParams, requestOptions?: any): IPromise; /** * Gets all the job types a user is allowed to see and create. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getVisibleJobTypes) - * + * * @param user The user name of the user for whom the information will be retrieved. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getVisibleJobTypes(user: string, requestOptions?: any): IPromise; } @@ -36276,7 +36276,7 @@ declare namespace __esri { interface ConfigurationTaskProperties extends TaskProperties { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#url) */ url?: string; @@ -36286,13 +36286,13 @@ declare namespace __esri { export interface ConfigurationTaskGetDataWorkspaceDetailsParams extends Object { /** * The unique id of the data workspace, whose version will be returned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getDataWorkspaceDetails) */ dataWorkspaceId: string; /** * The user name of the user who is requesting the information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getDataWorkspaceDetails) */ user: string; @@ -36302,13 +36302,13 @@ declare namespace __esri { export interface ConfigurationTaskGetUserJobQueryDetailsParams extends Object { /** * The unique id of user query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getUserJobQueryDetails) */ queryId: number; /** * The user name of the user who is requesting the information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#getUserJobQueryDetails) */ user: string; @@ -36316,19 +36316,19 @@ declare namespace __esri { /** * A geospatial database that will be used for editing in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#DataWorkspace) */ export interface DataWorkspace extends Object { /** * The unique id of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#DataWorkspace) */ id: string; /** * The name of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#DataWorkspace) */ name: string; @@ -36336,19 +36336,19 @@ declare namespace __esri { /** * The membership attributes of a group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#GroupMembership) */ export interface GroupMembership extends Object { /** * The unique id for the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#GroupMembership) */ id: number; /** * The name of the group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#GroupMembership) */ name: string; @@ -36356,25 +36356,25 @@ declare namespace __esri { /** * The type of hold that can be applied to suspend the execution of a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#HoldType) */ export interface HoldType extends Object { /** * The description of the type of hold. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#HoldType) */ description: string; /** * The unique id for the hold type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#HoldType) */ id: number; /** * The name of the hold type - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#HoldType) */ name: string; @@ -36382,25 +36382,25 @@ declare namespace __esri { /** * The properties of a job priority. Job priority is a way to assign a level of importance to the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobPriority) */ export interface JobPriority extends Object { /** * The description of the priority. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobPriority) */ description: string; /** * The name of the priority. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobPriority) */ name: string; /** * The unique id of the priority. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobPriority) */ value: number; @@ -36408,19 +36408,19 @@ declare namespace __esri { /** * A query that is available to the user to execute. A query returns jobs based on a specific criteria. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQuery) */ export interface JobQuery extends Object { /** * The unique id for the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQuery) */ id: number; /** * The name of the priority. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQuery) */ name: string; @@ -36428,31 +36428,31 @@ declare namespace __esri { /** * A container of job queries, it can also contain nested containers with child job query containers under it. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) */ export interface JobQueryContainer extends Object { /** * One or more [job query containers](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) which are nested under the parent container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) */ containers: JobQueryContainer[]; /** * The unique id for the container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) */ id: number; /** * The name of the query container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) */ name: string; /** * An array of [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQuery) inside the query container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) */ queries: JobQuery[]; @@ -36460,49 +36460,49 @@ declare namespace __esri { /** * Detailed properties of a job query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ export interface JobQueryDetails extends Object { /** * An array of field aliases included in the select statement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ aliases: string[]; /** * An array of fields included in the select statement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ fields: string[]; /** * The unique id for the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ id: number; /** * The name of the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ name: string; /** * The field used to order the results returned by the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ orderBy: string; /** * An array of tables selected from and used in the where clause. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ tables: string[]; /** * The where clause used as filter for selecting job information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryDetails) */ where: string; @@ -36510,31 +36510,31 @@ declare namespace __esri { /** * Properties of a job status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) */ export interface JobStatus extends Object { /** * An alias name for the status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) */ caption: string; /** * The description of the type of status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) */ description: string; /** * The unique id for the status type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) */ id: number; /** * The name of the status type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) */ name: string; @@ -36542,37 +36542,37 @@ declare namespace __esri { /** * A list of properties that describe a job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ export interface JobType extends Object { /** * A category to group other similar job types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ category: string; /** * The description of the job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ description: string; /** * The unique id for the job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ id: string; /** * The name of the job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ name: string; /** * The state of the job type. **Possible Values:** draft | active | retired - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) */ state: string; @@ -36580,121 +36580,121 @@ declare namespace __esri { /** * Detailed information of a job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ export interface JobTypeDetails extends Object { /** * The name of the geodatabase version that will be assigned the parent version of the job's geodatabase by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultParentVersionName: string; /** * Indicates whether jobs of this type will have their workflows automatically executed, when created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ autoExecuteCreatedJobs: boolean; /** * The category of the job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ category: string; /** * The name of the user or group that the job will be assigned to by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultAssignedTo: string; /** * Indicates whether the job is assigned to a user, group or unassigned by default. **Possible Values:** unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultAssignedType: string; /** * The unique id of the default data workspace of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultDataWorkspaceId: string; /** * The description that gets associated with the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultDescription: string; /** * The default due date of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultDueDate: string; /** * The duration for completing the job assigned by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultJobDuration: number; /** * Indicates whether jobs of this type allows users to modify the current data workspace in the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ canDataWorkspaceChange: boolean; /** * The numeric priority value assigned to the job by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultPriority: string; /** * The default start date of this job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ defaultStartDate: Date; /** * The description of the job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ description: string; /** * The unique id automatically generated for this job type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ id: string; /** * The naming scheme for this job type, which would serve as template for the name of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ jobNamingScheme: string; /** * The naming scheme for this job type, which would serve as template for the name of job's version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ jobVersionNamingScheme: string; /** * The naming scheme for this job type, which would serve as template for the name of job's map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ mxdNamingScheme: string; /** * The job type name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ name: string; /** * The state of the job type. **Possible Values:** draft | active | retired - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobTypeDetails) */ state: string; @@ -36702,25 +36702,25 @@ declare namespace __esri { /** * A privilege in the Workflow Manager system that controls application access. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) */ export interface Privilege extends Object { /** * The description of the privilege. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) */ description: string; /** * The unique id for the privilege. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) */ id: number; /** * The name of the privilege. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) */ name: string; @@ -36728,31 +36728,31 @@ declare namespace __esri { /** * TableRelationship represents a list of extended properties tables and the properties that identify them like name and cardinality. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) */ export interface TableRelationship extends Object { /** * The type of extra property table relationship, one-to-one represents one row for each property and one-to-many represents there will be multiple values for the property. **Possible Values:** one-to-one | one-to-many - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) */ cardinality: string; /** * The foreign key field used to join the jobs table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) */ linkField: string; /** * The alias name of the table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) */ tableAlias: string; /** * The name of the extended properties table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#TableRelationship) */ tableName: string; @@ -36760,85 +36760,85 @@ declare namespace __esri { /** * A list of properties including groups and privileges associated with a Workflow Manager user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ export interface UserDetails extends Object { /** * The last name of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ lastName: string; /** * The address of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ address: string; /** * The fax number of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ faxNumber: string; /** * The first name of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ firstName: string; /** * The full name of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ fullName: string; /** * An array of [group memberships](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#GroupMembership) of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ groups: GroupMembership[]; /** * The email address of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ email: string; /** * The phone number of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ phoneNumber: string; /** * An array of [application privileges](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ privileges: Privilege[]; /** * The room number of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ roomNumber: string; /** * The login username for the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ userName: string; /** * An array of [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer) owned by the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ userQueries: JobQueryContainer[]; /** * The zip code of the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#UserDetails) */ zipCode: string; @@ -36846,25 +36846,25 @@ declare namespace __esri { /** * A list of properties that describe a geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#VersionInfo) */ export interface VersionInfo extends Object { /** * The level of access to the geodatabase version. **Possible Values:** esriVersionAccessPrivate | esriVersionAccessPublic | esriVersionAccessProtected - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#VersionInfo) */ access: string; /** * The name of the geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#VersionInfo) */ name: string; /** * The name of the parent version of the geodatabase. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#VersionInfo) */ parent: string; @@ -36872,73 +36872,73 @@ declare namespace __esri { /** * The base properties of a Workflow Manager service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ export interface WorkflowManagerServiceInfo extends Object { /** * An array of [job priorities](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobPriority) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ jobPriorities: JobPriority[]; /** * An array of activity types in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ activityTypes: ActivityType[]; /** * The current software version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ currentVersion: number; /** * An array of [data workspaces](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#DataWorkspace) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ dataWorkspaces: DataWorkspace[]; /** * An array of [hold types](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#HoldType) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ holdTypes: HoldType[]; /** * The configuration properties of the Workflow Manager system stored in the database table as key/value pairs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ configProperties: WorkflowManagerServiceInfoConfigProperties; /** * An array of [job statuses](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobStatus) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ jobStatuses: JobStatus[]; /** * An array of [job types](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobType) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ jobTypes: JobType[]; /** * An array of notification types in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ notificationTypes: NotificationType[]; /** * An array of [privileges](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#Privilege) in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ privileges: Privilege[]; /** * The array of [public queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#JobQueryContainer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ publicQueries: JobQueryContainer[]; @@ -36948,85 +36948,85 @@ declare namespace __esri { export interface WorkflowManagerServiceInfoConfigProperties extends Object { /** * Indicates whether the location of interest (LOI) for jobs are allowed to overlap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AOIOVERLAP: string; /** * The color of the current job's LOI when selected in the LOI tab. The value is in range of 0 to 167772155. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AOISELECTIONCOLOR: number; /** * Indicates whether the job will be automatically assigned based on step assignment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AUTOASSIGNJOB: boolean; /** * Indicates whether the job will be automatically closed after the last step in the workflow is marked as complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AUTOCLOSEJOB: boolean; /** * Indicates whether the job workflow witll be automatically committed to the database when saved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AUTOCOMMITWORKFLOW: boolean; /** * Indicates whether the status of the jobs will be automatically assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ AUTOSTATUSASSIGN: boolean; /** * Indicates whether the user will be required to confirm that they want to mark the current procedural step as complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ CONFIRMPROCEDURALCHECK: boolean; /** * The default email address to be used in the sender field when sending notifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ DEFAULT_SENDER_EMAIL: string; /** * The default name displayed to be used in the sender field when sending notifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ DEFAULT_SENDER_NAME: string; /** * Indicates whether notifications will be sent as HTML. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ HTML_SUPPORT: string; /** * The starting value of job ids in the system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ JOB_ID_START_VALUE: string; /** * Indicates whether the the number of days for each hold is taken out of the pending days calculation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ PENDING_DAYS_USE_HOLDS: boolean; /** * Indicates whether the user attempting to delete a job version would be prompted to enter a password for the sde owner of the versions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ PROMPTSDEPWD: boolean; /** * Indicates whether it will be required to mark procedural steps as started. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ REQUIREPROCEDURALCHECKSTART: number; @@ -37035,103 +37035,103 @@ declare namespace __esri { * * `Warn` - Warn users when selecting features outside the job AOI. * * `NoSelect` - Prevent users from selecting features outside the job AOI. * * `Off` - Allow edits to features outside the job AOI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ RESTRICT_AOI_OPTION: string; /** * Indicates whether the spatial notifications will be sent on Workflow Manager Post. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SEND_SN_CUSTOM_POST: boolean; /** * Indicates whether to show step ids on workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SHOW_STEP_IDS: boolean; /** * Indicates whether the step completion percentage will be displayed on the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SHOW_STEP_PERCENT_COMPLETE: boolean; /** * The password of the authenticated SMTP user in the secure SMTP server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SMTP_PASSWORD: string; /** * Indicates whether the pending days will be displayed in the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SHOW_PENDING_DAYS: boolean; /** * The SMTP server port to be used for sending notifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SMTP_PORT: string; /** * SMTP Authentication protocol. **Possible Values:** SSL | TLS - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SMTP_PROTOCOL: string; /** * The name of the SMTP Server to be used for sending notifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SMTP_SERVER: string; /** * The user name that is authenticated in the secure SMTP server. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ SMTP_USERNAME: string; /** * Indicates whether to use step status assignment such that the job's status updates to match the step status when the step is reached. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ USE_STEP_STATUS: boolean; /** * Indicates the user store of the Workflow Manager system, whether the users will be stored in a Portal or the Workflow Manager system. **Possible Values:** traditional | portal - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ USER_STORE: string; /** * Indicates whether a user will be authenticated using domain along with the user name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ USEUSERDOMAIN: boolean; /** * The fill color of a selected step in a workflow. The value is in range of 0 to 167772155. When the option is disabled it's value is -1. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ WF_SEL_STEP_FILL_COLOR: number; /** * The outline color of a selected step in a workflow. The value is in range of 0 to 167772155. When the option is disabled it's value is -1. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ WF_SEL_STEP_OUTLINE_COLOR: number; /** * The outline width of a selected step in a workflow. **Possible Values:** 1 | 2 | 3 - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ WF_SEL_STEP_OUTLINE_WIDTH: number; /** * Indicates whether the LOI of the job will be automatically zoomed to in the LOI tab. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ConfigurationTask.html#WorkflowManagerServiceInfo) */ ZOOMTOAOI: boolean; @@ -37140,82 +37140,82 @@ declare namespace __esri { interface JobTask extends Task { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#url) */ url: string; /** * Uploads a file and attaches it to the job as an embedded attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addEmbeddedAttachment) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.form The form element that contains the file input control. The form parameter can be an instance of FormData. Using FormData you can send a "multipart/form-data" request to the server without having to create an HTML form element in markup. Note that the FormData api is not available in all browsers. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ addEmbeddedAttachment(params: JobTaskAddEmbeddedAttachmentParams, requestOptions?: any): IPromise; /** * Adds a linked attachment to a job (url or file). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedAttachment) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.attachmentType The type of attachment to be added. **Possible Values:** linked-file | url * @param params.path The file path to the attachment. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ addLinkedAttachment(params: JobTaskAddLinkedAttachmentParams, requestOptions?: any): IPromise; /** * Adds a linked property record to a job's linked properties table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedRecord) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.tableName The name of the table to which the record will be added. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ addLinkedRecord(params: JobTaskAddLinkedRecordParams, requestOptions?: any): IPromise; /** * Assigns one or more jobs to a user or group. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#assignJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobIds An array of unique job Ids. * @param params.assignedType Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** unassigned | user | group * @param params.assignedTo The name of the user or group to whom the job will be assigned. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ assignJobs(params: JobTaskAssignJobsParams, requestOptions?: any): IPromise; /** * Closes one or more jobs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#closeJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobIds An array of unique job Ids. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ closeJobs(params: JobTaskCloseJobsParams, requestOptions?: any): IPromise; /** * Creates a job dependency. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.heldOnType Indicates whether the current job (to which the dependency is being added) will be held at a step, stage or status. **Possible Values:** step | stage | status @@ -37225,347 +37225,347 @@ declare namespace __esri { * @param params.depOnValue The value of the step or status of the other job on which the current job will be dependent. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ createDependency(params: JobTaskCreateDependencyParams, requestOptions?: any): IPromise; /** * Creates a job hold. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createHold) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.holdTypeId The unique id representing the hold type to be placed on the job. * @param params.comments Reason or more detailed information regarding why the hold is being added. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ createHold(params: JobTaskCreateHoldParams, requestOptions?: any): IPromise; /** * Creates new jobs based on the provided parameters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobs) - * + * * @param params The parameters to be used for job creation, parameters defined in the job type can be overwritten. The jobTypeId and user are required parameters when creating a job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ createJobs(params: JobCreationParameters, requestOptions?: any): IPromise; /** * Creates a version specific to the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobVersion) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.name The name of the version to be created. * @param params.parent The name of the job's assigned geodatabase (data workspace) version, based on which the new version will be created. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ createJobVersion(params: JobTaskCreateJobVersionParams, requestOptions?: any): IPromise; /** * Deletes an attachment from a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteAttachment) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.attachmentId The unique id of the attachment to be deleted. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ deleteAttachment(params: JobTaskDeleteAttachmentParams, requestOptions?: any): IPromise; /** * Deletes a job dependency. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteDependency) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.dependencyId The unique id of the dependency to be deleted. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ deleteDependency(params: JobTaskDeleteDependencyParams, requestOptions?: any): IPromise; /** * Delete one or more jobs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobIds An array of unique job Ids. * @param params.deleteHistory Indicates whether or not to delete the associated job history, the default is to delete job history. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ deleteJobs(params: JobTaskDeleteJobsParams, requestOptions?: any): IPromise; /** * Deletes a record from a job's linked properties table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteLinkedRecord) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.tableName The name of the table from which linked record will be deleted. * @param params.recordId The unique id of the record in the table. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ deleteLinkedRecord(params: JobTaskDeleteLinkedRecordParams, requestOptions?: any): IPromise; /** * Gets the activity log for a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getActivityLog) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getActivityLog(jobId: number, requestOptions?: any): IPromise; /** * Gets the URL to access the file content of an embedded job attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getAttachmentContentUrl) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.attachmentId The Id of the attachment to be retrieved. - * + * */ getAttachmentContentUrl(params: JobTaskGetAttachmentContentUrlParams): string; /** * Gets all the attachments associated with the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getAttachments) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAttachments(jobId: number, requestOptions?: any): IPromise; /** * Gets an array of dependencies configured for a job. A job with a dependency is held at a step, stage or status of the other job, and cannot progress until the other job reaches the step, stage or status defined in the dependency. Once the other job reaches step, stage or status as defined in the dependency criteria the dependency is released and the dependent job can progress. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getDependencies) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getDependencies(jobId: number, requestOptions?: any): IPromise; /** * Gets an array of [extended properties](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) for a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getExtendedProperties) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getExtendedProperties(jobId: number, requestOptions?: any): IPromise; /** * Gets an array of holds on a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getHolds) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getHolds(jobId: number, requestOptions?: any): IPromise; /** * Gets the [job](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) object based on the given id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getJob) - * + * * @param jobId The unique id of the job to be retrieved. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getJob(jobId: number, requestOptions?: any): IPromise; /** * Gets all the job ids in the system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getJobIds) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getJobIds(requestOptions?: any): IPromise; /** * Gets the notes for a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getNotes) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getNotes(jobId: number, requestOptions?: any): IPromise; /** * Gets an array of [values and descriptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#FieldValue) for a geodatabase domain or table list extended property field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listFieldValues) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.tableName The name of the extended property table. * @param params.field The field name of the extended property for which to retrieve values. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ listFieldValues(params: JobTaskListFieldValuesParams, requestOptions?: any): IPromise; /** * Gets an array of [display values](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#FieldValue) for a given fields that comprise a multi-level table list extended property. As each display field is selected, for example using a dropdown UI control, this method can be called to obtain a list of values to display in the subsequent dropdown control. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listMultiLevelFieldValues) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.field The name of the field. * @param params.previousSelectedValues The array of previous values, on which the current value is dependent on. For example, when selecting a city based on the state and county. The value for the state and county would be the previous values. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ listMultiLevelFieldValues(params: JobTaskListMultiLevelFieldValuesParams, requestOptions?: any): IPromise; /** * Logs an action in a job's activity log. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#logAction) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.activityTypeId The unique id representing the [activity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) of the action associated with this log record. * @param params.comments The comment that is added to the history. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ logAction(params: JobTaskLogActionParams, requestOptions?: any): IPromise; /** * Queries the jobs using the queryId of an existing query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.queryId The unique id of a query, used to query jobs in the database. * @param params.user The username of the user who is requesting query. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ queryJobs(params: JobTaskQueryJobsParams, requestOptions?: any): IPromise; /** * Queries the jobs using an ad-hoc query definition and gets the [query result](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryResult). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryJobsAdHoc) - * + * * @param params The [parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) to query jobs. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ queryJobsAdHoc(params: JobQueryParameters, requestOptions?: any): IPromise; /** * Gets an array of string values representing the current display values for each display field in a multi-level table list extended property. The values from this method should be used to pre-select items in dropdown lists when initially displaying the extended properties of a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryMultiLevelSelectedValues) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.field The name of the field. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ queryMultiLevelSelectedValues(params: JobTaskQueryMultiLevelSelectedValuesParams, requestOptions?: any): IPromise; /** * Releases a job hold. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#releaseHold) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.holdId The unique id of the hold. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ releaseHold(params: JobTaskReleaseHoldParams, requestOptions?: any): IPromise; /** * Reopens one or more closed jobs. Supported from 10.3 onwards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#reopenClosedJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobIds An array of unique job Ids. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ reopenClosedJobs(params: JobTaskReopenClosedJobsParams, requestOptions?: any): IPromise; /** * Performs a freeform text search and returns a set of matching job records. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#searchJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.text The text which will be used to perform the search. * @param params.user The username of the user who is requesting search. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ searchJobs(params: JobTaskSearchJobsParams, requestOptions?: any): IPromise; /** * Unassigns one or more jobs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#unassignJobs) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobIds An array of unique job Ids. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ unassignJobs(params: JobTaskUnassignJobsParams, requestOptions?: any): IPromise; /** * Update a job's properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateJob) - * + * * @param params The [parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) to be used for job properties update, the jobId and the user are required when updating jobs. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ updateJob(params: JobUpdateParameters, requestOptions?: any): IPromise; /** * Updates the notes for a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateNotes) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.notes The new notes for the job. Set to an empty (zero-length) string to clear the job notes. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ updateNotes(params: JobTaskUpdateNotesParams, requestOptions?: any): IPromise; /** * Updates the values of an extended or linked properties record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateRecord) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.record The record to be updated. * @param params.user The user name of the user who is requesting the change. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ updateRecord(params: JobTaskUpdateRecordParams, requestOptions?: any): IPromise; } @@ -37573,7 +37573,7 @@ declare namespace __esri { interface JobTaskConstructor { /** * Helps you work with Workflow Manager jobs. A job is a single unit of work that is carried out within an organization. Various methods are available in the class to work with the following: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html) */ @@ -37585,7 +37585,7 @@ declare namespace __esri { interface JobTaskProperties extends TaskProperties { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#url) */ url?: string; @@ -37593,31 +37593,31 @@ declare namespace __esri { /** * ActivityType represents an activity type template that gets logged on a job when a certain event is fired in the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) */ export interface ActivityType extends Object { /** * The description of the activity being recorded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) */ desription: string; /** * The unique id of the activity that is logged. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) */ id: number; /** * The message that will be logged when this type of activity occurs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) */ message: string; /** * The name of the activity that occurred. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) */ name: string; @@ -37625,25 +37625,25 @@ declare namespace __esri { /** * AuxRecord represents the extended/linked properties record information associated with a job so that you can fetch or update the information for a specified record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecord) */ export interface AuxRecord extends Object { /** * The display value of the record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecord) */ displayProperty: any; /** * The unique id of the record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecord) */ id: number; /** * The array of the values in the [records](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecord) */ recordvalues: AuxRecordValue; @@ -37651,31 +37651,31 @@ declare namespace __esri { /** * AuxRecordContainer represents the extended/linked properties table characteristics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) */ export interface AuxRecordContainer extends Object { /** * The array of extended property [records](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecord). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) */ records: AuxRecord; /** * The type of extended property relationship. **Possible Values:** one-to-one | one-to-many - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) */ relationshipType: string; /** * The table alias. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) */ tableAlias: string; /** * The table name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordContainer) */ tableName: string; @@ -37683,25 +37683,25 @@ declare namespace __esri { /** * AuxRecordDescription represents the type of value that is captured in a specific AuxRecord field. There are multiple data types supported in Workflow Manager like - file, folder, text, date, etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordDescription) */ export interface AuxRecordDescription extends Object { /** * The array of property/value pairs of the record. - * + * * [Read more...](properties.html) */ properties: any; /** * The unique id of the record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordDescription) */ recordId: number; /** * The table name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordDescription) */ tableName: string; @@ -37709,97 +37709,97 @@ declare namespace __esri { /** * AuxRecordValue represents the values of extended/linked properties associated with a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ export interface AuxRecordValue extends Object { /** * The filter to restrict the types of records supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ filter: string; /** * The alias for the field in the table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ alias: string; /** * The data contained in the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ data: any; /** * The type of data expected in the field. **Possible Values:** small-integer | integer | single | double | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ dataType: string; /** * The order each field is displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ displayOrder: number; /** * The type of extended property item. **Possible Values:** default | text | date | domain | file | geo-file | folder | list | table-list | multi-level-table-list - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ displayType: string; /** * The domain value configured for the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ domain: string; /** * Indicates whether the extended property value can be updated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ canUpdate: boolean; /** * The length of the property string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ length: number; /** * The name property associated with the record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ name: string; /** * Indicates whether the property is a required or optional field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ required: boolean; /** * The lookup table that contains the list of values which will be selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ tableListClass: string; /** * The field that will be displayed for the extended property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ tableListDisplayField: string; /** * The field that contains the value that gets stored as the extended property value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ tableListStoreField: string; /** * Indicates whether the value will be visible to the user or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#AuxRecordValue) */ userVisible: boolean; @@ -37807,19 +37807,19 @@ declare namespace __esri { /** * FieldValue represents a single entry of a geodatabase domain or table list, applicable to constraining the values of an extended or linked property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#FieldValue) */ export interface FieldValue extends Object { /** * The description of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#FieldValue) */ description: string; /** * The value that is stored for the extended properties record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#FieldValue) */ value: any; @@ -37827,31 +37827,31 @@ declare namespace __esri { /** * JobAttachment represents an attachments associated with a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobAttachment) */ export interface JobAttachment extends Object { /** * The name of the file attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobAttachment) */ filename: string; /** * The file folder path or a URL. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobAttachment) */ folder: string; /** * The unique id of the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobAttachment) */ id: number; /** * The storage type of the attachment. **Possible Values:** linked-file | embedded | url - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobAttachment) */ storageType: string; @@ -37859,109 +37859,109 @@ declare namespace __esri { /** * JobCreationParameters provides information about the properties used for creating a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ export interface JobCreationParameters extends Object { /** * The geometry of the job's location of interest (LOI). Supported geometry types include point, multipoint and polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ loi: Geometry; /** * The name of the user or group to whom the job will be assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ assignedTo: string; /** * Indicates whether the workflow will be automatically committed upon creation of the job. The workflow cannot be edited after being committed to the system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ autoCommitWorkflow: boolean; /** * Indicates whether the job workflow will start execution automatically upon creation of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ autoExecute: boolean; /** * The unique id of the data workspace of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ dataWorkspaceId: string; /** * The description of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ description: string; /** * The date on which the job is expected to be complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ dueDate: Date; /** * The unique id of the job type from which to create the new job from. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ jobTypeId: number; /** * Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ assignedType: string; /** * The name of the new job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ name: string; /** * The number of jobs to be created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ numJobs: string; /** * The name of the user that will own the job. Job ownership allows modification of job properties and not workflow execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ ownedBy: string; /** * The unique id of the job that will be designated as the parent job of the new job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ parentJobId: number; /** * The name of the geodatabase version that will be the parent version of the new job's version. By default it will be the parent version of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ parentVersion: string; /** * The numeric value to denote priority of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ priority: number; /** * The date on which the job is scheduled to begin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ startDate: Date; /** * The username of the user creating the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobCreationParameters) */ user: string; @@ -37969,49 +37969,49 @@ declare namespace __esri { /** * JobDependency represents a dependency associated with a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ export interface JobDependency extends Object { /** * The unique id of the job on which the current job depends. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ depJobId: number; /** * Indicates whether the job is dependent on a step, stage or status of the other job. **Possible Values:** step | stage | status - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ depOnType: string; /** * The value of the step, stage or status of the other job on which the current job is dependent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ depOnValue: string; /** * The value of the step, stage or status at which the current job will be held. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ heldOnValue: number; /** * Indicates whether the job is held at a step, stage or status. **Possible Values:** step | stage | status - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ holdOnType: string; /** * The unique id of the dependency. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ id: number; /** * The unique id of the job on which the dependency exists. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobDependency) */ jobID: string; @@ -38019,157 +38019,157 @@ declare namespace __esri { /** * JobInfo represents a collection of job properties - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ export interface JobTaskJobInfo extends Object { /** * The name of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ name: string; /** * The name of the user or group to whom the job is assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ assignedTo: string; /** * An array of unique job ids designated as child jobs for the current job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ childJobIds: number[]; /** * The user name of the person that created the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ createdBy: string; /** * The date the job was created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ createdDate: Date; /** * The unique id of the data workspace of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ dataWorkspaceId: string; /** * The description of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ description: string; /** * The date on which the job is expected to be complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ dueDate: Date; /** * The actual date the job's workflow was completed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ endDate: Date; /** * The unique id to identify the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ id: number; /** * The unique id of the job type whose instance is the current job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ jobTypeId: number; /** * The geometry of the job's location of interest (LOI). Supported geometry types include point, multipoint and polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ loi: Geometry; /** * Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ assignedType: string; /** * The name of the user that will own the job. Job ownership allows modification of job properties and not workflow execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ ownedBy: string; /** * The unique id of the job that will be designated as the parent job of the new job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ parentJobId: number; /** * The name of the geodatabase version that is the parent version of the job's version. By default it will be the parent version of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ parentVersion: string; /** * The number of days that the job has been active. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ pendingDays: number; /** * The percentage of work completed on the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ percentageComplete: number; /** * The numeric value to denote priority of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ priority: number; /** * The internal stage of the job which corresponds to the status of the job. **Possible Values:** created | ready | working | done | closed - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ stage: string; /** * The date on which the job is scheduled to begin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ startDate: Date; /** * The numeric value to represent the current status of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ status: number; /** * Indicates whether a version exists for the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ versionExists: boolean; /** * The information about job's geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ versionInfo: JobVersionInfo; /** * The name of the job's geodatabase version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobInfo) */ versionName: string; @@ -38177,43 +38177,43 @@ declare namespace __esri { /** * JobQueryParameters is a full query definition of the selected query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ export interface JobQueryParameters extends Object { /** * An alias of fields included in the select statement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ aliases: string; /** * An array of fields included in the select statement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ fields: string; /** * The field that will be used to order the results returned by the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ orderBy: string; /** * The tables that will be used in the where clause for selection. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ tables: string; /** * The where clause used as a filter for selecting job information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ where: string; /** * The username of the user who is requesting query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobQueryParameters) */ user: string; @@ -38223,19 +38223,19 @@ declare namespace __esri { export interface JobTaskAddEmbeddedAttachmentParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addEmbeddedAttachment) */ jobId: number; /** * The form element that contains the file input control. The form parameter can be an instance of FormData. Using FormData you can send a "multipart/form-data" request to the server without having to create an HTML form element in markup. Note that the FormData api is not available in all browsers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addEmbeddedAttachment) */ form: any; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addEmbeddedAttachment) */ user: string; @@ -38245,25 +38245,25 @@ declare namespace __esri { export interface JobTaskAddLinkedAttachmentParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedAttachment) */ jobId: number; /** * The type of attachment to be added. **Possible Values:** linked-file | url - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedAttachment) */ attachmentType: number; /** * The file path to the attachment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedAttachment) */ path: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedAttachment) */ user: string; @@ -38273,19 +38273,19 @@ declare namespace __esri { export interface JobTaskAddLinkedRecordParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedRecord) */ jobId: number; /** * The name of the table to which the record will be added. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedRecord) */ tableName: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#addLinkedRecord) */ user: string; @@ -38295,25 +38295,25 @@ declare namespace __esri { export interface JobTaskAssignJobsParams extends Object { /** * An array of unique job Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#assignJobs) */ jobIds: number[]; /** * Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#assignJobs) */ assignedType: string; /** * The name of the user or group to whom the job will be assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#assignJobs) */ assignedTo: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#assignJobs) */ user: string; @@ -38323,13 +38323,13 @@ declare namespace __esri { export interface JobTaskCloseJobsParams extends Object { /** * An array of unique job Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#closeJobs) */ jobIds: number[]; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#closeJobs) */ user: string; @@ -38339,43 +38339,43 @@ declare namespace __esri { export interface JobTaskCreateDependencyParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ jobId: number; /** * Indicates whether the current job (to which the dependency is being added) will be held at a step, stage or status. **Possible Values:** step | stage | status - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ heldOnType: string; /** * The value of the step, stage or status at which the current job will be held. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ heldOnValue: number; /** * The unique id of the job on which the current job will depend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ depJobId: number; /** * Indicates whether the current job (to which the dependency is being added) will be dependent on a step, stage or status of the other job. **Possible Values:** step | stage | status - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ depOnType: string; /** * The value of the step or status of the other job on which the current job will be dependent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ depOnValue: number; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createDependency) */ user: string; @@ -38385,25 +38385,25 @@ declare namespace __esri { export interface JobTaskCreateHoldParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createHold) */ jobId: number; /** * The unique id representing the hold type to be placed on the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createHold) */ holdTypeId: number; /** * Reason or more detailed information regarding why the hold is being added. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createHold) */ comments: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createHold) */ user: string; @@ -38413,25 +38413,25 @@ declare namespace __esri { export interface JobTaskCreateJobVersionParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobVersion) */ jobId: number; /** * The name of the version to be created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobVersion) */ name: string; /** * The name of the job's assigned geodatabase (data workspace) version, based on which the new version will be created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobVersion) */ parent: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#createJobVersion) */ user: string; @@ -38441,19 +38441,19 @@ declare namespace __esri { export interface JobTaskDeleteAttachmentParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteAttachment) */ jobId: number; /** * The unique id of the attachment to be deleted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteAttachment) */ attachmentId: number; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteAttachment) */ user: string; @@ -38463,19 +38463,19 @@ declare namespace __esri { export interface JobTaskDeleteDependencyParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteDependency) */ jobId: number; /** * The unique id of the dependency to be deleted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteDependency) */ dependencyId: number; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteDependency) */ user: string; @@ -38485,19 +38485,19 @@ declare namespace __esri { export interface JobTaskDeleteJobsParams extends Object { /** * An array of unique job Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteJobs) */ jobIds: number[]; /** * Indicates whether or not to delete the associated job history, the default is to delete job history. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteJobs) */ deleteHistory?: boolean; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteJobs) */ user: string; @@ -38507,25 +38507,25 @@ declare namespace __esri { export interface JobTaskDeleteLinkedRecordParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteLinkedRecord) */ jobId: number; /** * The name of the table from which linked record will be deleted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteLinkedRecord) */ tableName: string; /** * The unique id of the record in the table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteLinkedRecord) */ recordId: number; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#deleteLinkedRecord) */ user: string; @@ -38535,13 +38535,13 @@ declare namespace __esri { export interface JobTaskGetAttachmentContentUrlParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getAttachmentContentUrl) */ jobId: number; /** * The Id of the attachment to be retrieved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#getAttachmentContentUrl) */ attachmentId: number; @@ -38551,25 +38551,25 @@ declare namespace __esri { export interface JobTaskListFieldValuesParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listFieldValues) */ jobId: number; /** * The name of the extended property table. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listFieldValues) */ tableName: string; /** * The field name of the extended property for which to retrieve values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listFieldValues) */ field: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listFieldValues) */ user: string; @@ -38579,19 +38579,19 @@ declare namespace __esri { export interface JobTaskListMultiLevelFieldValuesParams extends Object { /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listMultiLevelFieldValues) */ field: string; /** * The array of previous values, on which the current value is dependent on. For example, when selecting a city based on the state and county. The value for the state and county would be the previous values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listMultiLevelFieldValues) */ previousSelectedValues: string[]; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#listMultiLevelFieldValues) */ user: string; @@ -38601,25 +38601,25 @@ declare namespace __esri { export interface JobTaskLogActionParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#logAction) */ jobId: number; /** * The unique id representing the [activity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#ActivityType) of the action associated with this log record. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#logAction) */ activityTypeId: number; /** * The comment that is added to the history. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#logAction) */ comments: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#logAction) */ user: string; @@ -38629,13 +38629,13 @@ declare namespace __esri { export interface JobTaskQueryJobsParams extends Object { /** * The unique id of a query, used to query jobs in the database. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryJobs) */ queryId: number; /** * The username of the user who is requesting query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryJobs) */ user: string; @@ -38645,13 +38645,13 @@ declare namespace __esri { export interface JobTaskQueryMultiLevelSelectedValuesParams extends Object { /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryMultiLevelSelectedValues) */ field: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#queryMultiLevelSelectedValues) */ user: string; @@ -38661,13 +38661,13 @@ declare namespace __esri { export interface JobTaskReleaseHoldParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#releaseHold) */ jobId: number; /** * The unique id of the hold. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#releaseHold) */ holdId: number; @@ -38677,13 +38677,13 @@ declare namespace __esri { export interface JobTaskReopenClosedJobsParams extends Object { /** * An array of unique job Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#reopenClosedJobs) */ jobIds: number[]; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#reopenClosedJobs) */ user: string; @@ -38693,13 +38693,13 @@ declare namespace __esri { export interface JobTaskSearchJobsParams extends Object { /** * The text which will be used to perform the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#searchJobs) */ text: string; /** * The username of the user who is requesting search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#searchJobs) */ user: string; @@ -38709,13 +38709,13 @@ declare namespace __esri { export interface JobTaskUnassignJobsParams extends Object { /** * An array of unique job Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#unassignJobs) */ jobIds: number[]; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#unassignJobs) */ user: string; @@ -38725,19 +38725,19 @@ declare namespace __esri { export interface JobTaskUpdateNotesParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateNotes) */ jobId: number; /** * The new notes for the job. Set to an empty (zero-length) string to clear the job notes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateNotes) */ notes: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateNotes) */ user: string; @@ -38747,19 +38747,19 @@ declare namespace __esri { export interface JobTaskUpdateRecordParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateRecord) */ jobId: number; /** * The record to be updated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateRecord) */ record: AuxRecordDescription; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#updateRecord) */ user: string; @@ -38767,109 +38767,109 @@ declare namespace __esri { /** * JobUpdateParameters is a collection of properties that can be updated for jobs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ export interface JobUpdateParameters extends Object { /** * The name of the user that will own the job. Job ownership allows modification of job properties and not workflow execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ ownedBy: string; /** * The name of the user or group to whom the job will be assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ assignedTo: string; /** * The unique id of the data workspace of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ dataWorkspaceId: string; /** * The description of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ description: string; /** * The date on which the job is expected to be complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ dueDate: Date; /** * The geometry of the job's location of interest (LOI). Supported geometry types include point, multipoint and polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ loi: Geometry; /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ jobId: number; /** * The name of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ name: string; /** * Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ assignedType: string; /** * The unique id of the job that will be designated as the parent job of the new job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ parentJobId: number; /** * The name of the geodatabase version that will be the parent version of the new job's version. By default it will be the parent version of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ parentVersion: string; /** * The percentage of work completed on the job's current step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ percent: number; /** * The numeric value to denote priority of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ priority: number; /** * The date on which the job is scheduled to begin. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ startDate: Date; /** * The unique id of the job's new status. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ status: number; /** * The name of the geodatabase version to be used for the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ versionName: string; /** * The user name of the user who is requesting the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobUpdateParameters) */ user: string; @@ -38877,37 +38877,37 @@ declare namespace __esri { /** * JobVersionInfo represents a collection of properties for a job's version. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ export interface JobVersionInfo extends Object { /** * The unique id of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ dataWorkspaceId: string; /** * The name of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ name: string; /** * The parent version of the geodatabase. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ parent: string; /** * Indicates whether the version has been created or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ created: boolean; /** * The name of the version owner. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#JobVersionInfo) */ owner: string; @@ -38915,31 +38915,31 @@ declare namespace __esri { /** * QueryFieldInfo represents a collection of field properties that are returned as part of a query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryFieldInfo) */ export interface QueryFieldInfo extends Object { /** * The alias name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryFieldInfo) */ alias: string; /** * The field length. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryFieldInfo) */ length: string; /** * The name of the data workspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryFieldInfo) */ name: string; /** * The type of data expected in the field. **Possible Values:** small-integer | integer | single | double | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryFieldInfo) */ type: string; @@ -38947,19 +38947,19 @@ declare namespace __esri { /** * QueryResult contains the result of a query after it has been executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryResult) */ export interface QueryResult extends Object { /** * An array of fields and field properties in the query. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryResult) */ fields: QueryFieldInfo[]; /** * The rows of results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-JobTask.html#QueryResult) */ rows: string[]; @@ -38968,116 +38968,116 @@ declare namespace __esri { interface NotificationTask extends Task { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#url) */ url: string; /** * Creates a new spatial notification change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#addChangeRule) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.rule The [change rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) to be added. * @param params.user The username requesting the addition of the rule. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ addChangeRule(params: NotificationTaskAddChangeRuleParams, requestOptions?: any): IPromise; /** * Deletes a spatial notification change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#deleteChangeRule) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.ruleId The unique id of the rule to be deleted. * @param params.user The username requesting the deletion of the rule. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ deleteChangeRule(params: NotificationTaskDeleteChangeRuleParams, requestOptions?: any): IPromise; /** * Get an array of all the spatial notification [change rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) configured in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#getAllChangeRules) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAllChangeRules(requestOptions?: any): IPromise; /** * Get a single spatial notification [change rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) by ruleId. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#getChangeRule) - * + * * @param ruleId The unique id of the [change rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule). * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getChangeRule(ruleId: string, requestOptions?: any): IPromise; /** * Get information about a [match](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) for a change and change rule related to a spatial notification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#getChangeRuleMatch) - * + * * @param matchId The unique id of the spatial notification match. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getChangeRuleMatch(matchId: string, requestOptions?: any): IPromise; /** * Get the current time of the database. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#getDatabaseTime) - * + * * @param dataWorkspaceId The unique id of the dataWorkspace. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getDatabaseTime(dataWorkspaceId: string, requestOptions?: any): IPromise; /** * Get an array of [matches](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) that match the change rule criteria in a specific editing session. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#getSessionMatches) - * + * * @param sessionId The unique id of the spatial notification session. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getSessionMatches(sessionId: string, requestOptions?: any): IPromise; /** * Sends the notifications configured for the matches found during a rule evaluation session. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#notifySession) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.sessionid The unique id of the spatial notification session. * @param params.deleteAfter Indicates whether to delete the session matches after sending any notifications. The default is false. * @param params.user The username requesting the sending of notification. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ notifySession(params: NotificationTaskNotifySessionParams, requestOptions?: any): IPromise; /** * Queries the array of spatial notification [change rules](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) based on specified criteria. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#queryChangeRules) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.name A search string to find within change rule names. * @param params.description A search string to find within change rule descriptions. * @param params.searchType The type of search to perform, default is contains. **Possible Values:** contains | exact | starts-with | ends-with * @param params.user The username requesting the search. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ queryChangeRules(params: NotificationTaskQueryChangeRulesParams, requestOptions?: any): IPromise; /** * Executes the configured spatial notification change rules on a data workspace by evaluating the geodatabase archive. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.dataWorkspaceId The unique id of the dataWorkspace. * @param params.from The starting time to query for new changes. @@ -39086,46 +39086,46 @@ declare namespace __esri { * @param params.send Indicates whether to the send notifications at the time matches are found. The default is false. * @param params.user The username requesting the execution of the rule. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ runSpatialNotificationOnHistory(params: NotificationTaskRunSpatialNotificationOnHistoryParams, requestOptions?: any): IPromise; /** * Sends an email of the specified [notification type](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#sendNotification) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.notificationType The name of the [notification type](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) to be sent. * @param params.user The username requesting to send the notification. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ sendNotification(params: NotificationTaskSendNotificationParams, requestOptions?: any): IPromise; /** * Adds an email address to the subscriber list for a specific notification type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#subscribeToNotification) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.notificationTypeId The unique id of the notification type to which the email address will be added. * @param params.email The email address to add to the notification type's subscriber list. May contain tokens. * @param params.user The username requesting the addition of email address to the notification subscriber's list. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ subscribeToNotification(params: NotificationTaskSubscribeToNotificationParams, requestOptions?: any): IPromise; /** * Removes an email address from the subscriber list for a specific notification type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#unsubscribeFromNotification) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.notificationTypeId The unique id of the notification type from which the email address will be removed. * @param params.email The email address to remove from the notification type's subscriber list. May contain tokens. * @param params.user The username requesting the removal of email address to the notification subscriber's list. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ unsubscribeFromNotification(params: NotificationTaskUnsubscribeFromNotificationParams, requestOptions?: any): IPromise; } @@ -39133,7 +39133,7 @@ declare namespace __esri { interface NotificationTaskConstructor { /** * Exposes functions to perform operations with Workflow Manager notifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html) */ @@ -39145,7 +39145,7 @@ declare namespace __esri { interface NotificationTaskProperties extends TaskProperties { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#url) */ url?: string; @@ -39153,43 +39153,43 @@ declare namespace __esri { /** * AOIEvaluator represents the rules that triggers a spatial notification based on area of interest(AOI). This contains the geometric operation and the criteria to be used based on the AOI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ export interface AOIEvaluator extends Object { /** * The area of interest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ aoi: Polygon; /** * Indicates whether to inverse the spatial relationship or not. For example, if the spatial relationship is inversed for operator Within, then features that are not within will be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ inverse: boolean; /** * The name of the AOI evaluator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ name: string; /** * The spatial relationship to be applied for evaluation of the rule. **Possible Values:** intersects | contains | crosses | envelope-intersects | index-intersects | overlaps | touches | within | relation - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ relation: string; /** * The type of the AOI evaluator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ type: string; /** * Indicates whether job AOI should be used as the extent or not for the evaluation of the rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) */ useJobAOI: boolean; @@ -39197,43 +39197,43 @@ declare namespace __esri { /** * ChangeRule represents a single change rule that triggers a spatial notification. When the criteria defined in the rule is met an email notification is sent to recipients. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ export interface ChangeRule extends Object { /** * The description of the change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ description: string; /** * An array of [AOI](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#AOIEvaluator) and [Dataset](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) evaluators. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ evaluators: any[]; /** * The unique id of the change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ id: number; /** * The name of the change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ name: string; /** * The type of notifier, the default is [email notifier](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier). This can be extended to use your own notifiers like SMS, instant messaging. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ notifier: any; /** * Indicates whether to summarize email contents or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) */ summarize: boolean; @@ -39241,49 +39241,49 @@ declare namespace __esri { /** * ChangeRuleMatch represents information about the change and change rule related to a spatial notification match. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ export interface ChangeRuleMatch extends Object { /** * The time the change occurred to the data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ changeTime: Date; /** * The type of change that happened to the data. **Possible Values:** add | modify | delete | all - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ changeType: string; /** * The dataset that changed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ dataset: string; /** * The unique id of the data workspace containing the changed data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ dataWorkspaceId: string; /** * The unique id of the associated to the change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ id: string; /** * The unique id of the job where the change was made. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ jobID: string; /** * The unique id of the change rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRuleMatch) */ ruleID: string; @@ -39291,43 +39291,43 @@ declare namespace __esri { /** * DatasetConfiguration represents the criteria and dataset that the change rule applies to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ export interface DatasetConfiguration extends Object { /** * This indicates whether the notification will be sent always or if values change to defined in whereConditions or if values change from defined in whereConditions. **Possible Values:** always | changed-to | changed-from - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ changeCondition: number; /** * The name of the fields, changes to which trigger the notification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ changeFields: string; /** * The name of the dataset that will trigger the notification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ dataset: string; /** * The unique id of the data workspace containing the changed data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ dataWorkspaceId: string; /** * The name of the dataset configuration rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ name: string; /** * The [where conditions](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#WhereCondition) defining the criteria to trigger the rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) */ whereConditions: WhereCondition[]; @@ -39335,25 +39335,25 @@ declare namespace __esri { /** * DataSetEvaluator represents the rules that triggers a spatial notification based on the changes in a dataset. This contains the specific features and feature class that are participating in a spatial notification rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) */ export interface DataSetEvaluator extends Object { /** * The array of [DatasetConfigurations](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) representing the dataset to which the rule applies. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) */ dataSetConfigurations: DatasetConfiguration[]; /** * The name of the dataset evaluator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) */ name: string; /** * The type of the dataset evaluator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) */ type: string; @@ -39361,55 +39361,55 @@ declare namespace __esri { /** * EmailNotifier represents the properties of a notification type that is configured in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ export interface EmailNotifier extends Object { /** * Indicates whether the job's file attachment will be attached to the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ attachJobAttachments: boolean; /** * The message content sent as part of the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ message: string; /** * The name of the notifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ name: string; /** * The sender's (from) email address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ senderEmail: string; /** * The sender's (from) name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ senderName: string; /** * The subject of the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ subject: string; /** * The array of subscribers who will get the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ subscribers: string[]; /** * The type of notifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#EmailNotifier) */ type: string; @@ -39419,13 +39419,13 @@ declare namespace __esri { export interface NotificationTaskAddChangeRuleParams extends Object { /** * The [change rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#ChangeRule) to be added. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#addChangeRule) */ rule: ChangeRule; /** * The username requesting the addition of the rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#addChangeRule) */ user: string; @@ -39435,13 +39435,13 @@ declare namespace __esri { export interface NotificationTaskDeleteChangeRuleParams extends Object { /** * The unique id of the rule to be deleted. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#deleteChangeRule) */ ruleId: string; /** * The username requesting the deletion of the rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#deleteChangeRule) */ user: string; @@ -39451,19 +39451,19 @@ declare namespace __esri { export interface NotificationTaskNotifySessionParams extends Object { /** * The unique id of the spatial notification session. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#notifySession) */ sessionid: string; /** * Indicates whether to delete the session matches after sending any notifications. The default is false. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#notifySession) */ deleteAfter: boolean; /** * The username requesting the sending of notification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#notifySession) */ user: string; @@ -39473,25 +39473,25 @@ declare namespace __esri { export interface NotificationTaskQueryChangeRulesParams extends Object { /** * A search string to find within change rule names. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#queryChangeRules) */ name: string; /** * A search string to find within change rule descriptions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#queryChangeRules) */ description: string; /** * The type of search to perform, default is contains. **Possible Values:** contains | exact | starts-with | ends-with - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#queryChangeRules) */ searchType: string; /** * The username requesting the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#queryChangeRules) */ user: string; @@ -39501,37 +39501,37 @@ declare namespace __esri { export interface NotificationTaskRunSpatialNotificationOnHistoryParams extends Object { /** * The unique id of the dataWorkspace. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ dataWorkspaceId: string; /** * The starting time to query for new changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ from: Date; /** * The ending time to query for new changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ to: Date; /** * Indicates whether to keep the matches found, stored in the ArcGIS Workflow Manager repository. The default is false. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ logMatches: boolean; /** * Indicates whether to the send notifications at the time matches are found. The default is false. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ send: boolean; /** * The username requesting the execution of the rule. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#runSpatialNotificationOnHistory) */ user: string; @@ -39541,19 +39541,19 @@ declare namespace __esri { export interface NotificationTaskSendNotificationParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#sendNotification) */ jobId: number; /** * The name of the [notification type](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) to be sent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#sendNotification) */ notificationType: string; /** * The username requesting to send the notification. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#sendNotification) */ user: string; @@ -39563,19 +39563,19 @@ declare namespace __esri { export interface NotificationTaskSubscribeToNotificationParams extends Object { /** * The unique id of the notification type to which the email address will be added. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#subscribeToNotification) */ notificationTypeId: number; /** * The email address to add to the notification type's subscriber list. May contain tokens. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#subscribeToNotification) */ email: string; /** * The username requesting the addition of email address to the notification subscriber's list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#subscribeToNotification) */ user: string; @@ -39585,19 +39585,19 @@ declare namespace __esri { export interface NotificationTaskUnsubscribeFromNotificationParams extends Object { /** * The unique id of the notification type from which the email address will be removed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#unsubscribeFromNotification) */ notificationTypeId: number; /** * The email address to remove from the notification type's subscriber list. May contain tokens. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#unsubscribeFromNotification) */ email: string; /** * The username requesting the removal of email address to the notification subscriber's list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#unsubscribeFromNotification) */ user: string; @@ -39605,55 +39605,55 @@ declare namespace __esri { /** * NotificationType represents the properties of a notification type that are sent when certain events happen in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ export interface NotificationType extends Object { /** * Indicates whether the job's file attachment will be attached to the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ attachJobAttachments: boolean; /** * The unique id of the notification type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ id: number; /** * The message content sent as part of the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ message: string; /** * The sender's (from) email address. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ senderEmail: string; /** * The sender's (from) name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ senderName: string; /** * The subject of the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ subject: string; /** * The array of subscribers who will get the email. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ subscribers: string[]; /** * The type of notifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#NotificationType) */ type: string; @@ -39661,25 +39661,25 @@ declare namespace __esri { /** * WhereCondition returns the condition set in [DatasetConfiguration](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DatasetConfiguration) for a [Dataset](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#DataSetEvaluator) evaluator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#WhereCondition) */ export interface WhereCondition extends Object { /** * The value to be compared/evaluated with. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#WhereCondition) */ compareValue: any; /** * The field name that contains the value to be compared. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#WhereCondition) */ field: string; /** * The operator to be used for comparison. **Possible Values:** equal | not-equal | greater-than | greater-or-equal | less-than | less-or-equal | contains - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-NotificationTask.html#WhereCondition) */ operator: string; @@ -39688,63 +39688,63 @@ declare namespace __esri { interface ReportTask extends Task { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#url) */ url: string; /** * Generates a report and returns the output as formatted HTML. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#generateReport) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.reportId The id of the report. * @param params.user The user name requesting the report. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ generateReport(params: ReportTaskGenerateReportParams, requestOptions?: any): IPromise; /** * Gets all the [reports](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) that are configured in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getAllReports) - * + * * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAllReports(requestOptions?: any): IPromise; /** * Returns the URL string for the report content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportContentUrl) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.reportId The id of the report. * @param params.user The username of the user requesting the report content. - * + * */ getReportContentUrl(params: ReportTaskGetReportContentUrlParams): string; /** * Executes a report and returns the raw [report data](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportData) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.reportId The id of the report. * @param params.user The username of the user requesting the report data. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getReportData(params: ReportTaskGetReportDataParams, requestOptions?: any): IPromise; /** * Gets the XSLT stylesheet for the specified report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportStylesheet) - * + * * @param reportId The id of the report. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getReportStylesheet(reportId: number, requestOptions?: any): IPromise; } @@ -39752,7 +39752,7 @@ declare namespace __esri { interface ReportTaskConstructor { /** * Helps you generate reports about the work being managed in your Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html) */ @@ -39764,7 +39764,7 @@ declare namespace __esri { interface ReportTaskProperties extends TaskProperties { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#url) */ url?: string; @@ -39772,37 +39772,37 @@ declare namespace __esri { /** * Report represents a configured report in the Workflow Manager system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ export interface Report extends Object { /** * A description of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ description: string; /** * The category to which the report belongs in the system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ hierarchy: string; /** * A unique id for the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ id: number; /** * The name of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ name: string; /** * The title of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#Report) */ title: string; @@ -39810,31 +39810,31 @@ declare namespace __esri { /** * ReportData is the generated result of a report after it has been executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData) */ export interface ReportData extends Object { /** * The name of columns returned as part of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData) */ columns: string[]; /** * A description of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData) */ description: string; /** * The [aggregation of the report data](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) into subcategories. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData) */ groups: ReportDataGroup[]; /** * The title of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportData) */ title: string; @@ -39842,31 +39842,31 @@ declare namespace __esri { /** * ReportDataGroup aggregates the report results into user defined categories. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) */ export interface ReportDataGroup extends Object { /** * The label of the aggregate category as defined in the report, eg. Total Jobs. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) */ aggregateLabel: string; /** * The value of the aggregate category based on the calculation defined in the report section options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) */ aggregateValue: string; /** * The rows containing the data returned in the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) */ row: string[]; /** * The data value based on which the section is created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#ReportDataGroup) */ value: string; @@ -39876,13 +39876,13 @@ declare namespace __esri { export interface ReportTaskGenerateReportParams extends Object { /** * The id of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#generateReport) */ reportId: number; /** * The user name requesting the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#generateReport) */ user: string; @@ -39892,13 +39892,13 @@ declare namespace __esri { export interface ReportTaskGetReportContentUrlParams extends Object { /** * The id of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportContentUrl) */ reportId: number; /** * The username of the user requesting the report content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportContentUrl) */ user: number; @@ -39908,13 +39908,13 @@ declare namespace __esri { export interface ReportTaskGetReportDataParams extends Object { /** * The id of the report. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportData) */ reportId: number; /** * The username of the user requesting the report data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-ReportTask.html#getReportData) */ user: string; @@ -39923,15 +39923,15 @@ declare namespace __esri { interface TokenTask extends Task { /** * Parses a string with embedded tokens using user and job information. The string is returned with embedded tokens replaced by their actual values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-TokenTask.html#parseTokens) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId A unique id for the job. * @param params.stringToParse The string representing the tokens to be parsed. * @param params.user The username of the user requesting token parsing. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ parseTokens(params: TokenTaskParseTokensParams, requestOptions?: any): IPromise; } @@ -39939,7 +39939,7 @@ declare namespace __esri { interface TokenTaskConstructor { /** * Helps you parse Workflow Manager tokens to the actual value of tokens in the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-TokenTask.html) */ @@ -39956,19 +39956,19 @@ declare namespace __esri { export interface TokenTaskParseTokensParams extends Object { /** * A unique id for the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-TokenTask.html#parseTokens) */ jobId: any; /** * The string representing the tokens to be parsed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-TokenTask.html#parseTokens) */ stringToParse: string; /** * The username of the user requesting token parsing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-TokenTask.html#parseTokens) */ user: string; @@ -39977,156 +39977,156 @@ declare namespace __esri { interface WorkflowTask extends Task { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#url) */ url: string; /** * Get the information which indicates whether this workflow step can be run. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#canRunStep) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. * @param params.user The user name of the user wanting to run the step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ canRunStep(params: WorkflowTaskCanRunStepParams, requestOptions?: any): IPromise; /** * Executes the specified steps in order and gets back [execution information](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) of the steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#executeSteps) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepIds The array of unique step Ids. * @param params.auto Indicates whether to automatically execute as many steps as possible, based on the workflow configuration. The default is false, to execute only the current step. * @param params.user The user name of the user executing the step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ executeSteps(params: WorkflowTaskExecuteStepsParams, requestOptions?: any): IPromise; /** * Gets all workflow [steps](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) of a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getAllSteps) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getAllSteps(jobId: number, requestOptions?: any): IPromise; /** * Gets all current [steps](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) of a job. A workflow will have more than one current step if it is configured to support parallel steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getCurrentSteps) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getCurrentSteps(jobId: number, requestOptions?: any): IPromise; /** * Gets a specific workflow [step](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) of a job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStep) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getStep(params: WorkflowTaskGetStepParams, requestOptions?: any): IPromise; /** * Get the help associated with a workflow step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepDescription) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getStepDescription(params: WorkflowTaskGetStepDescriptionParams, requestOptions?: any): IPromise; /** * Gets a URL to access the file content of a file step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepFileUrl) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. - * + * */ getStepFileUrl(params: WorkflowTaskGetStepFileUrlParams): string; /** * Get a job's [workflow display details](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowDisplayDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getWorkflowDisplayDetails) - * + * * @param jobId The unique id of the job. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ getWorkflowDisplayDetails(jobId: number, requestOptions?: any): IPromise; /** * Gets a URL of an image depicting the current state of a job's workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getWorkflowImageUrl) - * + * * @param jobId The unique id of the job. - * + * */ getWorkflowImageUrl(jobId: number): string; /** * Marks the specified steps of a job workflow as completed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#markStepsAsDone) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepIds The array of unique step Ids. * @param params.user The user name of the user marking the step complete. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ markStepsAsDone(params: WorkflowTaskMarkStepsAsDoneParams, requestOptions?: any): IPromise; /** * Advances the workflow to the next step based on a return code value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#moveToNextStep) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job Id. * @param params.stepId The unique id of the step. * @param params.returnCode A numeric value representing the return code. * @param params.user The user name of the user advancing the workflow to the next step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ moveToNextStep(params: WorkflowTaskMoveToNextStepParams, requestOptions?: any): IPromise; /** * The job workflow is updated with the latest workflow of job type, after the job has been created. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#recreateWorkflow) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.user The user name of the user recreating the workflow. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ recreateWorkflow(params: WorkflowTaskRecreateWorkflowParams, requestOptions?: any): IPromise; /** * Resolves workflow path conflicts resulting from executing or marking as complete a step, which can have two or more next steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. @@ -40134,20 +40134,20 @@ declare namespace __esri { * @param params.optionStepIds An array of unique step IDs of all the possible next steps. * @param params.user The user name of the user resolving the conflict. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ resolveConflict(params: WorkflowTaskResolveConflictParams, requestOptions?: any): IPromise; /** * Sets a step as the current active step of a job workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#setCurrentStep) - * + * * @param params See the object specifications in table below for the structure of the `params` object. * @param params.jobId The unique id of the job. * @param params.stepId The unique id of the step. * @param params.user The user name of the user setting the current step. * @param requestOptions Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html#esriRequest) to be used for the data request (will override requestOptions defined during construction). - * + * */ setCurrentStep(params: WorkflowTaskSetCurrentStepParams, requestOptions?: any): IPromise; } @@ -40155,7 +40155,7 @@ declare namespace __esri { interface WorkflowTaskConstructor { /** * Class to perform operations on Workflow Manager workflows and steps. The workflows are collections of steps that are executed while working on a job. Workflows are designed to organize and simplify tasks to ensure that no step is missed. The steps are the building blocks of your workflows and are connected using paths. Step and path properties determine the flow of the work. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html) */ @@ -40167,7 +40167,7 @@ declare namespace __esri { interface WorkflowTaskProperties extends TaskProperties { /** * URL to the ArcGIS Workflow Manager REST service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#url) */ url?: string; @@ -40175,67 +40175,67 @@ declare namespace __esri { /** * ExecuteInfo provides information on whether a step can be executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ export interface ExecuteInfo extends Object { /** * Information about [conflicts](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) in workflow step progression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ conflicts: WorkflowConflicts; /** * The error code returned by the steps in the workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ errorCode: number; /** * The description for the errors returned by the steps in the workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ errorDescription: string; /** * The result of a step execution. **Possible Values:** executed | dependent-on-step | dependent-on-stage | dependent-on-status | job-on-hold | step-depends-on-step | check | step-assigned-to-other-user | step-assigned-to-other-group | job-assigned-to-others | job-closed | invalid-platform | invalid-step | dependent-on-job | not-current-step - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ executionResult: string; /** * Indicates whether a step has conflicts. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ hasConflicts: boolean; /** * Indicates whether a step has return code. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ hasReturnCode: boolean; /** * The unique id of current job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ jobID: number; /** * The return code for the current workflow step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ returnCode: number; /** * The unique id of the current step in the workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ stepID: number; /** * Indicates whether the step threw an error during execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#ExecuteInfo) */ threwError: boolean; @@ -40243,109 +40243,109 @@ declare namespace __esri { /** * Step represents the properties of a step that is used in a job's workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ export interface Step extends Object { /** * Indicates whether the step has already been executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ hasBeenExecuted: boolean; /** * The user or group to whom the step is assigned. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ assignedTo: string; /** * Indicates whether the step can be run asynchronously. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ async: boolean; /** * Indicates whether the step can be automatically executed when reached. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ autoRun: boolean; /** * Indicates whether the step can be skipped without executing it. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ canSkip: boolean; /** * Indicates whether the step can start parallel execution of other steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ canSpawnConcurrency: boolean; /** * The unique id of step type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ commonId: number; /** * The default percentage completion of the job once step is reached. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ defaultPercentComplete: number; /** * Indicates whether the job is assigned to a user, group or unassigned. **Possible Values:** none | unassigned | user | group - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ assignedType: string; /** * Indicates whether the step has been started. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ hasBeenStarted: boolean; /** * The unique id generated as the step Id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ id: number; /** * The name of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ name: string; /** * Indicates whether the step will be automatically marked as complete when complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ selfCheck: boolean; /** * The unique numeric status value configured as the status of the job once step is reached. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ statusId: number; /** * The percentage completion of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ stepPercentComplete: number; /** * The type of notification that will be sent when the step finishes execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ notificationType: string; /** * The [step template](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) for current step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#Step) */ stepType: StepType; @@ -40353,73 +40353,73 @@ declare namespace __esri { /** * StepType represents properties of step templates that are available in the Workflow Manager system for authoring workflows. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ export interface StepType extends Object { /** * The program/application/code that will be executed on this step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ program: string; /** * The step arguments required at runtime. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ arguments: string; /** * The type of execution for the step. **Possible Values:** executable | function | procedural | launch-url | question | open-file - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ executionType: string; /** * The unique id for the step type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ id: number; /** * The name of the step type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ name: string; /** * The description of the step type. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ description: string; /** * The path/URL of the step description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ stepDescriptionLink: string; /** * The type of step description. **Possible Values:** none | embedded-html | link - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ stepDescriptionType: string; /** * The shape of the step as it will appear in a workflow graphic. **Possible Values:** rounded-rectangle | rectangle | oval | diamond | parallelogram - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ stepIndicatorType: string; /** * The platform on which the step can be executed. **Possible Values:** desktop | server | both - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ supportedPlatform: string; /** * Indicates whether Workflow Manager will be minimized and hidden during step execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#StepType) */ visible: boolean; @@ -40427,55 +40427,55 @@ declare namespace __esri { /** * WorkflowAnnotationDisplayDetails represents properties of a workflow annotation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ export interface WorkflowAnnotationDisplayDetails extends Object { /** * The X coordinate of the annotation object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ centerX: number; /** * The Y coordinate of the annotation object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ centerY: number; /** * The fill color of the annotation object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ fillColor: Color; /** * The height of the annotation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ height: number; /** * The annotation text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ label: string; /** * The color of annotation label text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ labelColor: Color; /** * The outline color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ OutlineColor: Color; /** * The width of the annotation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails) */ width: number; @@ -40483,31 +40483,31 @@ declare namespace __esri { /** * WorkflowConflicts represents properties for workflows that have a conflicting path or multiple possible paths for progression. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) */ export interface WorkflowConflicts extends Object { /** * The unique id of currently active job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) */ jobID: number; /** * The information about the step in the workflow returned as [WorkflowOption](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowOption). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) */ options: WorkflowOption[]; /** * Indicates whether the step will begin a concurrent path in the workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) */ spawnsConcurrency: boolean; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowConflicts) */ stepId: number; @@ -40515,25 +40515,25 @@ declare namespace __esri { /** * WorkflowDisplayDetails represents a collection of properties that constitute a workflow - annotations, steps, and paths. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowDisplayDetails) */ export interface WorkflowDisplayDetails extends Object { /** * The properties of how the [annotations are displayed](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowAnnotationDisplayDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowDisplayDetails) */ annotations: WorkflowAnnotationDisplayDetails[]; /** * The properties of how the [path are displayed](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowDisplayDetails) */ paths: WorkflowPathDisplayDetails[]; /** * The properties of how the [step are displayed](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowDisplayDetails) */ steps: WorkflowStepDisplayDetails[]; @@ -40541,19 +40541,19 @@ declare namespace __esri { /** * WorkflowOption represents properties of a workflow that have return codes and step branches. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowOption) */ export interface WorkflowOption extends Object { /** * The return code generated from a step execution. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowOption) */ returnCode: number; /** * The collection of [descriptions for workflow steps](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepInfo). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowOption) */ steps: WorkflowStepInfo[]; @@ -40561,62 +40561,62 @@ declare namespace __esri { /** * WorkflowPathDisplayDetails represents properties of a workflow's path properties like location, destination steps, position on the workflow canvas. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ export interface WorkflowPathDisplayDetails extends Object { /** * The unique id of the step to which the path will lead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ destStepId: number; /** * The unique id of the step just executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ sourceStepID: number; /** * The label associated with the path. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ label: string; /** * The color of the label on the path. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ labelColor: Color; /** * The X coordinate of the label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ labelX: number; /** * The Y coordinate of the label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ labelY: number; /** * The color of the line representing the path. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ lineColor: Color; /** - * An object with following properties. - * + * An object with following properties. + * * Name | Type | Description * ---------|--------|------------- * isDefault | Boolean | Indicates whether this is the default path(only path) from the source step. * numReturnValues | Number[] | The number of possible return values for the path. * returnValueX | Number[] | The return values associated with the path. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowPathDisplayDetails) */ pathObject: any; @@ -40624,73 +40624,73 @@ declare namespace __esri { /** * WorkflowStepDisplayDetails represents properties of a workflow step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ export interface WorkflowStepDisplayDetails extends Object { /** * The color of step label text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ labelColor: Color; /** * The X coordinate of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ centerX: number; /** * The fill color of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ fillColor: Color; /** * The height of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ height: number; /** * The step text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ label: string; /** * The Y coordinate of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ centerY: number; /** * The outline color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ OutlineColor: Color; /** * The shape of the step. **Possible Values:** rounded-rectangle | rectangle | oval | diamond | parallelogram - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ shape: string; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ stepId: number; /** * The step execution type. **Possible Values:** executable | function | procedural | launch-url | question | open-file - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ stepType: string; /** * The width of the annotation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepDisplayDetails) */ width: number; @@ -40698,19 +40698,19 @@ declare namespace __esri { /** * WorkflowStepInfo represents collection of descriptions for workflow's steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepInfo) */ export interface WorkflowStepInfo extends Object { /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepInfo) */ id: number; /** * The name of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#WorkflowStepInfo) */ name: string; @@ -40720,19 +40720,19 @@ declare namespace __esri { export interface WorkflowTaskCanRunStepParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#canRunStep) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#canRunStep) */ stepId: number; /** * The user name of the user wanting to run the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#canRunStep) */ user: string; @@ -40742,25 +40742,25 @@ declare namespace __esri { export interface WorkflowTaskExecuteStepsParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#executeSteps) */ jobId: number; /** * The array of unique step Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#executeSteps) */ stepIds: number[]; /** * Indicates whether to automatically execute as many steps as possible, based on the workflow configuration. The default is false, to execute only the current step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#executeSteps) */ auto: boolean; /** * The user name of the user executing the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#executeSteps) */ user: string; @@ -40770,13 +40770,13 @@ declare namespace __esri { export interface WorkflowTaskGetStepDescriptionParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepDescription) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepDescription) */ stepId: number; @@ -40786,13 +40786,13 @@ declare namespace __esri { export interface WorkflowTaskGetStepFileUrlParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepFileUrl) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStepFileUrl) */ stepId: number; @@ -40802,13 +40802,13 @@ declare namespace __esri { export interface WorkflowTaskGetStepParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStep) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#getStep) */ stepId: number; @@ -40818,19 +40818,19 @@ declare namespace __esri { export interface WorkflowTaskMarkStepsAsDoneParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#markStepsAsDone) */ jobId: number; /** * The array of unique step Ids. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#markStepsAsDone) */ stepIds: number[]; /** * The user name of the user marking the step complete. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#markStepsAsDone) */ user: string; @@ -40840,25 +40840,25 @@ declare namespace __esri { export interface WorkflowTaskMoveToNextStepParams extends Object { /** * The unique id of the job Id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#moveToNextStep) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#moveToNextStep) */ stepId: number; /** * A numeric value representing the return code. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#moveToNextStep) */ returnCode: number; /** * The user name of the user advancing the workflow to the next step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#moveToNextStep) */ user: string; @@ -40868,13 +40868,13 @@ declare namespace __esri { export interface WorkflowTaskRecreateWorkflowParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#recreateWorkflow) */ jobId: number; /** * The user name of the user recreating the workflow. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#recreateWorkflow) */ user: string; @@ -40884,31 +40884,31 @@ declare namespace __esri { export interface WorkflowTaskResolveConflictParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) */ stepId: number; /** * A numeric value representing the return code from the step where the conflict was encountered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) */ optionReturnCode: number; /** * An array of unique step IDs of all the possible next steps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) */ optionStepIds: number[]; /** * The user name of the user resolving the conflict. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#resolveConflict) */ user: string; @@ -40918,19 +40918,19 @@ declare namespace __esri { export interface WorkflowTaskSetCurrentStepParams extends Object { /** * The unique id of the job. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#setCurrentStep) */ jobId: number; /** * The unique id of the step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#setCurrentStep) */ stepId: number; /** * The user name of the user setting the current step. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-workflow-WorkflowTask.html#setCurrentStep) */ user: string; @@ -40938,40 +40938,40 @@ declare namespace __esri { interface Viewpoint extends Accessor, JSONSupport { /** - * The viewpoint camera (3D only). + * The viewpoint camera (3D only). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#camera) */ camera: Camera; /** * The rotation of due north in relation to the top of the view in degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#rotation) - * + * * @default 0 */ rotation: number; /** * The scale of the viewpoint. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#scale) */ scale: number; /** - * The target geometry framed by the viewpoint. + * The target geometry framed by the viewpoint. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#targetGeometry) */ targetGeometry: Geometry; /** * Create a deep clone of the viewpoint. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone) - * - * + * + * */ clone(): Viewpoint; } @@ -40988,30 +40988,30 @@ declare namespace __esri { interface ViewpointProperties { /** - * The viewpoint camera (3D only). + * The viewpoint camera (3D only). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#camera) */ camera?: CameraProperties; /** * The rotation of due north in relation to the top of the view in degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#rotation) - * + * * @default 0 */ rotation?: number; /** * The scale of the viewpoint. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#scale) */ scale?: number; /** - * The target geometry framed by the viewpoint. + * The target geometry framed by the viewpoint. * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#targetGeometry) */ targetGeometry?: GeometryProperties; @@ -41020,33 +41020,33 @@ declare namespace __esri { interface Draw extends Accessor { /** * A reference to the active [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html). An instance of the draw action is created when [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#create) method is called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#activeAction) */ activeAction: DrawAction; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the draw to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#view) */ view: MapView; /** * Complete the current active drawing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#complete) - * - * + * + * */ complete(): void; /** * Creates an instance of the requested draw action. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#create) - * - * @param drawAction - * Name of the [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html) to create. See the table below for a list of possible values and type of draw action it creates. **Possible Values:** point | multipoint | polyline | polygon | rectangle | circle | ellipse - * + * + * @param drawAction + * Name of the [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html) to create. See the table below for a list of possible values and type of draw action it creates. **Possible Values:** point | multipoint | polyline | polygon | rectangle | circle | ellipse + * * Geometry type | Draw action instance * ------------- | -------------------- * point | [PointDrawAction](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PointDrawAction.html) @@ -41055,23 +41055,23 @@ declare namespace __esri { * polygon | [PolygonDrawAction](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html) * rectangle, circle, ellipse | [SegmentDrawAction](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html) * @param drawOptions Object of the drawing options for the geometry to be created. - * @param drawOptions.mode - * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `segment` draw actions. **Possible Values:** - * + * @param drawOptions.mode + * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `segment` draw actions. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. Applies to and is the default for `polygon` and `polyline` draw actions. * freehand | Vertices are added while the pointer is dragged. Applies to `polygon`, `polyline` and `segment` draw actions. Default for `segment` draw actions. * click | Vertices are added when the pointer is clicked. - * + * */ create(drawAction: string, drawOptions?: DrawCreateDrawOptions): DrawAction; /** * Resets the drawing by clearing the active action. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#reset) - * - * + * + * */ reset(): void; } @@ -41079,7 +41079,7 @@ declare namespace __esri { interface DrawConstructor { /** * The Draw class provides advanced drawing capabilities for developers who need complete control over creating temporary graphics with different geometries. For example, if you want to prevent users from drawing graphics with self-intersecting lines or overlapping polygons, then you can use this class to implement these rules. The draw experience is built upon draw actions, which use the view events to generate a set of coordinates for creating new geometries. Each geometry type has a corresponding draw action class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html) */ @@ -41091,13 +41091,13 @@ declare namespace __esri { interface DrawProperties { /** * A reference to the active [draw action](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html). An instance of the draw action is created when [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#create) method is called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#activeAction) */ activeAction?: DrawActionProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the draw to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#view) */ view?: MapViewProperties; @@ -41106,15 +41106,15 @@ declare namespace __esri { export interface DrawCreateDrawOptions extends Object { /** - * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `segment` draw actions. **Possible Values:** - * + * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `segment` draw actions. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. Applies to and is the default for `polygon` and `polyline` draw actions. * freehand | Vertices are added while the pointer is dragged. Applies to `polygon`, `polyline` and `segment` draw actions. Default for `segment` draw actions. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-Draw.html#create) */ mode?: string; @@ -41123,41 +41123,41 @@ declare namespace __esri { interface DrawAction extends Accessor, Evented { /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#view) */ view: MapView; /** * Indicates if the [redo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#redo) method can be called on the action instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#canRedo) - * - * + * + * */ canRedo(): boolean; /** * Indicates if the [undo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#undo) method can be called on the action instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#canUndo) - * - * + * + * */ canUndo(): boolean; /** * Incrementally redo actions recorded in the stack. Call [canRedo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#canRedo) prior to calling this method to check if this method can be called on the action instance. Calling this method will fire the [vertex-add](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#event:vertex-add) or [vertex-remove](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#event:vertex-remove) events depending on the last action. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#redo) - * - * + * + * */ redo(): void; /** * Incrementally undo actions recorded in the stack. Call [canUndo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#canUndo) prior to calling this method to check if this method can be called on the action instance. Calling this method will fire the [vertex-add](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#event:vertex-add) or [vertex-remove](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#event:vertex-remove) events depending on the last action. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#undo) - * - * + * + * */ undo(): void; } @@ -41165,7 +41165,7 @@ declare namespace __esri { interface DrawActionConstructor { /** * DrawAction is the base class for all draw actions. DrawActions use the view events to generate a set of coordinates to create new geometries. Each serves a different purpose, allowing you to create a different type geometry such as [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), [multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html), [polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html), and [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html) */ @@ -41177,7 +41177,7 @@ declare namespace __esri { interface DrawActionProperties { /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html#view) */ view?: MapViewProperties; @@ -41186,17 +41186,17 @@ declare namespace __esri { interface MultipointDrawAction extends DrawAction { /** * Two-dimensional array of numbers representing the coordinates of each vertex that comprises the drawn geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-MultipointDrawAction.html#vertices) */ readonly vertices: number[][]; /** * Completes drawing the [multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-MultipointDrawAction.html#event:draw-complete) event. Call this method if the drawing logic needs to be completed other than by double-clicking or pressing the "C" key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-MultipointDrawAction.html#complete) - * - * + * + * */ complete(): void; } @@ -41216,17 +41216,17 @@ declare namespace __esri { interface PointDrawAction extends DrawAction { /** * An array of x,y coordinates for the [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PointDrawAction.html#coordinates) */ readonly coordinates: number[]; /** * Completes drawing the [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PointDrawAction.html#event:draw-complete) event. Call this method if the drawing logic needs to be completed other than by double-clicking or pressing the "C" key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PointDrawAction.html#complete) - * - * + * + * */ complete(): void; } @@ -41245,33 +41245,33 @@ declare namespace __esri { interface PolygonDrawAction extends DrawAction { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html#mode) - * + * * @default hybrid */ mode: string; /** * Two-dimensional array of numbers representing the coordinates of each vertex comprising the geometry being drawn. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html#vertices) */ readonly vertices: number[][]; /** * Completes drawing the polygon geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html#event:draw-complete) event. Call this method if the drawing logic needs to be completed other than by double-clicking or pressing the "C" key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html#complete) - * - * + * + * */ complete(): void; } @@ -41286,17 +41286,17 @@ declare namespace __esri { interface PolygonDrawActionProperties extends DrawActionProperties { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolygonDrawAction.html#mode) - * + * * @default hybrid */ mode?: string; @@ -41304,33 +41304,33 @@ declare namespace __esri { interface PolylineDrawAction extends DrawAction { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolylineDrawAction.html#mode) - * + * * @default hybrid */ mode: string; /** * Two-dimensional array of numbers representing the coordinates of each vertex that comprising the drawn geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolylineDrawAction.html#vertices) */ readonly vertices: number[][]; /** * Completes drawing the polyline geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolylineDrawAction.html#event:draw-complete) event. Call this method if the drawing logic needs to be completed other than by double-clicking or pressing the "C" key. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolylineDrawAction.html#complete) - * - * + * + * */ complete(): void; } @@ -41345,17 +41345,17 @@ declare namespace __esri { interface PolylineDrawActionProperties extends DrawActionProperties { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-PolylineDrawAction.html#mode) - * + * * @default hybrid */ mode?: string; @@ -41363,32 +41363,32 @@ declare namespace __esri { interface SegmentDrawAction extends DrawAction { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. SegmentDrawActions are created from 2 vertices. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html#mode) - * + * * @default freehand */ mode: string; /** * Two-dimensional array of numbers representing the coordinates of each vertex comprising the geometry being drawn. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html#vertices) */ readonly vertices: number[][]; /** * Completes drawing the polygon geometry and fires the [draw-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html#event:draw-complete) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html#complete) - * - * + * + * */ complete(): void; } @@ -41403,16 +41403,16 @@ declare namespace __esri { interface SegmentDrawActionProperties extends DrawActionProperties { /** - * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** - * + * The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle. **Possible Values:** + * * Value | Description | * ----- | ----------- | * freehand | Vertices are added while the pointer is dragged. * click | Vertices are added when the pointer is clicked. SegmentDrawActions are created from 2 vertices. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-SegmentDrawAction.html#mode) - * + * * @default freehand */ mode?: string; @@ -41421,67 +41421,67 @@ declare namespace __esri { export class BaseLayerView2D { /** * References the layer this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) represents. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#layer) */ layer: Layer; /** * The array of [Tile](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) objects computed to cover the MapView's visible area. This array is updated when the view is animating or the user is interacting with it. Then if tiles have been added or removed, [tilesChanged()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tilesChanged) is called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tiles) */ tiles: Tile[]; /** * References the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) this [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) belongs to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#view) */ view: MapView; /** * Method called when after the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is created and right before it's asked to draw the layer's content. Typically this method is implemented to start watching property changes on the layer for example. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#attach) - * - * + * + * */ attach(): void; /** * Method called after the layer is removed and the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is about to be removed. Typically, this method is implemented to free resources like watchers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#detach) - * - * + * + * */ detach(): void; /** * The method to implement that is responsible of drawing the content of the layer. This method is called every time the MapView's state changes, or if [requestRender()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#requestRender) has been called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) - * + * * @param renderParameters * @param renderParameters.context The [canvas 2D context](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D) in which to draw content. * @param renderParameters.stationary The stationary state of the `MapView`. * @param renderParameters.state The object that describes view state. - * + * */ render(renderParameters: BaseLayerView2DRenderRenderParameters): void; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) can call this method to ask the MapView to schedule a new rendering frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#requestRender) - * - * + * + * */ protected requestRender(): void; /** * Method to implement, which notifies of tiles being added or removed for the current view state. This function can be implemented to start and stop fetching new data, or allocate and dispose resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#tilesChanged) - * + * * @param added The tile objects added for the current view viewport. * @param removed The tile objects removed from the view viewport. - * + * */ tilesChanged(added: Tile[], removed: Tile[]): void; } @@ -41490,19 +41490,19 @@ declare namespace __esri { export interface BaseLayerView2DRenderRenderParameters extends Object { /** * The [canvas 2D context](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D) in which to draw content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ context: CanvasRenderingContext2D; /** * The stationary state of the `MapView`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ stationary: boolean; /** * The object that describes view state. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#render) */ state: ViewState; @@ -41510,61 +41510,61 @@ declare namespace __esri { /** * Represents a tile reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ export interface Tile extends Object { /** * The tile string identifier in the format `level/row/col/world` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ id: string; /** * The level identifier of the [LOD](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html) to which the tile belongs - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ level: number; /** * The row identifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ row: number; /** * The column identifier. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ col: number; /** * When the projection allows world wrapping (e.g. Web Mercator), identifies the instance of the world this tile's `level`/`row`/`col`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ world: number; /** * The number of map units per pixel in the tile. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ resolution: number; /** * The map scale at the tile's level. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ scale: number; /** * The coordinates of the top-left corner of the tile as an array of two numbers. The coordinates are in un-normalized map units. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ coords: number[]; /** * The bounds of the tile as an array of four numbers that be readily converted to an [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-layers-BaseLayerView2D.html#Tile) */ bounds: number[]; @@ -41573,89 +41573,89 @@ declare namespace __esri { interface ViewState { /** * Represents the view's center point as an array of two numbers `[x, y]`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#center) */ readonly center: number[]; /** * The extent represents the visible portion of a map within the view as an instance of Extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#extent) */ readonly extent: Extent; /** * Represents the size of one pixel in map units. The value of `resolution` is the result of the division of the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#extent) width by the [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#size). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#resolution) */ readonly resolution: number; /** * The clockwise rotation of due north in relation to the top of the view in degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#rotation) */ readonly rotation: number; /** * Represents the map scale at the center of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#scale) */ readonly scale: number; /** * Represents the width and height of the view in pixels, e.g. `[width, height]`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#size) */ readonly size: number[]; /** * Creates a deep clone of ViewState object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#clone) - * - * + * + * */ clone(): ViewState; /** * Copies the properties from a given view state. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#copy) - * + * * @param state The view state to copy the properties from. - * + * */ copy(state: ViewState): ViewState; /** * Converts the x and y screen coordinates to map coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toMap) - * + * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. - * + * */ toMap(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreen) - * + * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. - * + * */ toScreen(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. This method is similar to [toScreen](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreen), without applying the view state rotation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-ViewState.html#toScreenNoRotation) - * + * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. - * + * */ toScreenNoRotation(out: number[], x: number, y: number): number[]; } @@ -41671,30 +41671,30 @@ declare namespace __esri { /** * map/scene on screen. The ArcGIS API for JavaScript offers a low-level interface to access the SceneView's WebGL context, and thus enables creating custom visualizations that interact with the scene the same way as built-in layers. Developers can either write WebGL code directly, or integrate with third-party WebGL libraries. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html) */ interface externalRenderers { /** * Adds an external renderer to the view. The external renderer is defined by an object that contains certain methods and properties, as defined by [ExternalRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#add) - * + * * @param view The view to which to attach the external renderer. * @param renderer The external renderer. - * + * */ add(view: SceneView, renderer: ExternalRenderer): void; /** * Transforms positions from the internal rendering coordinate system to the output spatial reference. The allowable output spatial reference is limited and depends on the [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode): * * In `global` mode, it can either be Web Mercator or WGS84. * * In `local` mode, it has to match [view.spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#spatialReference), and the call to this function simply copies the coordinates from `srcCoordinates` to `destCoordinates`. - * - * + * + * * If these conditions are not met, nothing is written to `destCoordinates` and the function returns `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#fromRenderCoordinates) - * + * * @param view The view related to the input coordinates. * @param srcCoordinates A linear array of one or more vectors that are interpreted as XYZ coordinates. For example, two position vectors would be represented as `[x1, y1, z1, x2, y2, z2]`. This must contain at least `srcStart + 3 * count` elements. * @param srcStart An index in `srcCoordinates` from which the coordinates will start being read. @@ -41702,17 +41702,17 @@ declare namespace __esri { * @param destStart An index in `destCoordinates` in which the coordinates will start to be written. * @param destSpatialReference The spatial reference of the output coordinates. When `null`, `view.spatialReference` is used instead. * @param count The number of vertices to be transformed. - * + * */ fromRenderCoordinates(view: SceneView, srcCoordinates: number[] | Float32Array, srcStart: number, destCoordinates: number[] | Float32Array, destStart: number, destSpatialReference: SpatialReference, count: number): number[] | Float32Array; /** * Removes an external renderer from the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#remove) - * + * * @param view The view from which to remove the external renderer. * @param renderer The external renderer. - * + * */ remove(view: SceneView, renderer: ExternalRenderer): void; /** @@ -41720,43 +41720,43 @@ declare namespace __esri { * * X: Easting * * Y: Northing * * Z: Elevation - * - * + * + * * ![externalRenderers-renderCoordinateTransformAt](https://developers.arcgis.com/javascript/assets/img/apiref/views/3d/externalRenderers-renderCoordinateTransformAt.png) When [view.viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) is `global`, a linear transformation does not take the curvature of the globe or other non-linear projection aspects into account. Thus, the resulting coordinates will only appear correct within a small region around the origin of the local Cartesian system. The allowable spatial reference of `origin` depends on the [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode): * * In `global` mode, it can either be Web Mercator or WGS84. * * In `local` mode, it has to match [view.spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#spatialReference). - * - * + * + * * If these conditions are not met, nothing will be written to `dest` and the function will return `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#renderCoordinateTransformAt) - * + * * @param view The view for which the transformation will be used. * @param origin The global coordinates of the origin in the local Cartesian coordinate system. * @param srcSpatialReference The spatial reference of the origin coordinates. If undefined, `view.spatialReference` is used instead. * @param dest A reference to an array where the 16 matrix elements will be stored. The resulting matrix follows OpenGL conventions where the translation components occupy the 13th, 14th and 15th elements. If undefined, a newly created matrix returned. - * + * */ renderCoordinateTransformAt(view: SceneView, origin: number[] | Float32Array, srcSpatialReference?: SpatialReference, dest?: number[] | Float32Array): number[] | Float32Array; /** * Requests the view to be redrawn. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#requestRender) - * + * * @param view The view to which the external renderer is attached. - * + * */ requestRender(view: SceneView): void; /** * Transforms positions from the given spatial reference to the internal rendering coordinate system. The allowable input spatial reference is limited and depends on the [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode): * * In `global` mode, it can either be Web Mercator or WGS84. * * In `local` mode, it has to match [view.spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#spatialReference); the call to this function simply copies the coordinates from `srcCoordinates` to `destCoordinates`. - * - * + * + * * If these conditions are not met, nothing is written to `destCoordinates` and the function returns `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#toRenderCoordinates) - * + * * @param view The view in which the coordinates will be used. * @param srcCoordinates A linear array of one or more vectors which are interpreted as XYZ coordinates. For example, two position vectors would be represented as `[x1, y1, z1, x2, y2, z2]`. This must contain at least `srcStart + 3 * count` elements. * @param srcStart An index in `srcCoordinates` from which the coordinates start to be read. @@ -41764,7 +41764,7 @@ declare namespace __esri { * @param destCoordinates A reference to an array where the results will be written. * @param destStart An index in `destCoordinates` to which the coordinates will start to be written. * @param count The number of vertices to be transformed. - * + * */ toRenderCoordinates(view: SceneView, srcCoordinates: number[] | Float32Array, srcStart: number, srcSpatialReference: SpatialReference, destCoordinates: number[] | Float32Array, destStart: number, count: number): number[] | Float32Array; } @@ -41773,19 +41773,19 @@ declare namespace __esri { /** * Tuple of an RGB color value and an intensity value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ColorAndIntensity) */ export interface ColorAndIntensity extends Object { /** * RGB color with values between 0 and 1. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ColorAndIntensity) */ color: ArrayLike; /** * Scalar intensity value by which the color should be scaled for compositing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ColorAndIntensity) */ intensity: number; @@ -41793,25 +41793,25 @@ declare namespace __esri { /** * Defines an external renderer using callbacks and properties. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ export interface ExternalRenderer extends Object { /** * Typically called once after adding the external renderer to a view, or whenever the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) becomes [ready](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ready). It may be called again if the ready state cycles, for example when a different [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) is assigned to the view. Receives a single parameter of type [RenderContext](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ setup?: RenderContextCallback; /** * Called in every frame to execute the state update and draw calls. Receives a single parameter of type [RenderContext](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ render?: RenderContextCallback; /** * Called when the external renderer is removed from a view, or when the [ready](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#ready) state of the view turns false. Receives a single parameter of type [RenderContext](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) */ dispose?: RenderContextCallback; @@ -41819,67 +41819,67 @@ declare namespace __esri { /** * The camera object passed to renderer callbacks in [RenderContext](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext). This is not the same as [Camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html). All properties are read-only and defined in terms of the internal rendering coordinate system (see the [section on coordinate systems](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#coordinate-systems) at the top of this page). Vectors (`Vec3`) are presented as arrays with 3 elements (x, y, z). Matrices (`Mat4`) are presented as linear arrays with 16 elements following the OpenGL conventions where the translation components occupy the 13th, 14th, and 15th elements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ export interface RenderCamera extends Object { /** * A 4x4 matrix that transforms coordinates from world space to camera space. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ viewMatrix: ArrayLike; /** * The inverse transpose of `viewMatrix`, used to transform normals from world space to camera space. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ viewInverseTransposeMatrix: ArrayLike; /** * A 4x4 matrix that defines the perspective projection transformation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ projectionMatrix: ArrayLike; /** * The position of the camera in the internal Cartesian rendering coordinate system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ eye: ArrayLike; /** * The camera target ("look at") position in the internal Cartesian rendering coordinate system. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ center: ArrayLike; /** * The camera up vector. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ up: ArrayLike; /** * The distance to the near plane. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ near: number; /** * The distance to the far plane. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ far: number; /** * The horizontal field of view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ fovX: number; /** * The vertical field of view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderCamera) */ fovY: number; @@ -41887,43 +41887,43 @@ declare namespace __esri { /** * The object passed as a parameter to every call to `setup` and `render` the external renderer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ export interface RenderContext extends Object { /** * The WebGL rendering context. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ gl: WebGLRenderingContext; /** * The camera used to render the current frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ camera: RenderCamera; /** * The lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to render the current frame. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) */ sunLight: SunLight; /** * A convenience function provided to completely reset the WebGL state after using it. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) - * - * + * + * */ resetWebGLState(): void; /** * Binds the color and depth buffers an external renderer is supposed to render into. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#RenderContext) - * - * + * + * */ bindRenderTarget(): void; } @@ -41932,25 +41932,25 @@ declare namespace __esri { /** * Describes the lighting used by [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), derived from its sun lighting model. It consists of a directional Lambertian (`diffuse`) and a constant (`ambient`) term, which should be treated in the sense of the [Phong Reflection Model](https://en.wikipedia.org/wiki/Phong_reflection_model). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#SunLight) */ export interface SunLight extends Object { /** * The incident light direction in render coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#SunLight) */ direction: ArrayLike; /** * The diffuse light color and intensity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#SunLight) */ diffuse: ColorAndIntensity; /** * The ambient light color and intensity. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#SunLight) */ ambient: ColorAndIntensity; @@ -41958,16 +41958,16 @@ declare namespace __esri { interface BreakpointsOwner { /** - * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. The sizes specified here determine the values of the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties depending on the view's size. Setting up breakpoints can aid in responsive app design. It does this by watching width and height breakpoints. This is helpful as it removes the need for multiple [`@media` calls](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries). Instead of listening for the view's size and/or resizes property, you can set up a watch handler for either the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties of the view. + * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. The sizes specified here determine the values of the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties depending on the view's size. Setting up breakpoints can aid in responsive app design. It does this by watching width and height breakpoints. This is helpful as it removes the need for multiple [`@media` calls](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries). Instead of listening for the view's size and/or resizes property, you can set up a watch handler for either the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties of the view. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ breakpoints: BreakpointsOwnerBreakpoints; /** - * A convenience property indicating the general size of the view's height. This value is determined based on where the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. + * A convenience property indicating the general size of the view's height. This value is determined based on where the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * Possible Value | Description | Default thresholds (pixels) * ---------------|-------------|---------------------------- * xsmall | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is smaller than the value set in the `xsmall` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | < 545 @@ -41975,28 +41975,28 @@ declare namespace __esri { * medium | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is between the values set in the `small` and `medium` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 769 - 992 * large | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is between the values set in the `medium` and `large` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 993 - 1200 * xlarge | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is larger than the value set in the `large` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | > 1200 - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) */ heightBreakpoint: string; /** - * A convenience property indicating the view's orientation. See the table below for a list of possible values. + * A convenience property indicating the view's orientation. See the table below for a list of possible values. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * Possible Value | Description * ---------------|------------ * landscape | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is greater than its [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height). * portrait | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is equal to or smaller than its [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height). - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#orientation) */ readonly orientation: string; /** - * A convenience property indicating the general size of the view's width. This value is determined based on where the view's [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. + * A convenience property indicating the general size of the view's width. This value is determined based on where the view's [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * Possible Value | Description | Default thresholds (pixels) * ---------------|-------------|------------------- * xsmall | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is smaller than the value set in the `xsmall` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | < 545 @@ -42004,8 +42004,8 @@ declare namespace __esri { * medium | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is between the values set in the `small` and `medium` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 769 - 992 * large | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is between the values set in the `medium` and `large` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 993 - 1200 * xlarge | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is larger than the value set in the `large` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | > 1200 - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) */ widthBreakpoint: string; @@ -42021,16 +42021,16 @@ declare namespace __esri { interface BreakpointsOwnerProperties { /** - * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. The sizes specified here determine the values of the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties depending on the view's size. Setting up breakpoints can aid in responsive app design. It does this by watching width and height breakpoints. This is helpful as it removes the need for multiple [`@media` calls](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries). Instead of listening for the view's size and/or resizes property, you can set up a watch handler for either the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties of the view. + * A convenience property used for defining the breakpoints on the [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) and [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view. The sizes specified here determine the values of the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties depending on the view's size. Setting up breakpoints can aid in responsive app design. It does this by watching width and height breakpoints. This is helpful as it removes the need for multiple [`@media` calls](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries). Instead of listening for the view's size and/or resizes property, you can set up a watch handler for either the [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) properties of the view. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ breakpoints?: BreakpointsOwnerBreakpoints; /** - * A convenience property indicating the general size of the view's height. This value is determined based on where the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. + * A convenience property indicating the general size of the view's height. This value is determined based on where the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * Possible Value | Description | Default thresholds (pixels) * ---------------|-------------|---------------------------- * xsmall | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is smaller than the value set in the `xsmall` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | < 545 @@ -42038,15 +42038,15 @@ declare namespace __esri { * medium | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is between the values set in the `small` and `medium` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 769 - 992 * large | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is between the values set in the `medium` and `large` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 993 - 1200 * xlarge | The [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) of the view is larger than the value set in the `large` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | > 1200 - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) */ heightBreakpoint?: string; /** - * A convenience property indicating the general size of the view's width. This value is determined based on where the view's [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. + * A convenience property indicating the general size of the view's width. This value is determined based on where the view's [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) falls in the ranges defined in the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property. See the table below for a list of possible values. Use the [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) property to override the default thresholds. * > Please refer to the [styling guide](https://developers.arcgis.com/javascript/latest/guide/styling/index.html#view-size-css-classes) for additional information on working with this. - * + * * Possible Value | Description | Default thresholds (pixels) * ---------------|-------------|------------------- * xsmall | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is smaller than the value set in the `xsmall` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | < 545 @@ -42054,8 +42054,8 @@ declare namespace __esri { * medium | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is between the values set in the `small` and `medium` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 769 - 992 * large | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is between the values set in the `medium` and `large` [breakpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | 993 - 1200 * xlarge | The [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) of the view is larger than the value set in the `large` [breakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints). | > 1200 - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) */ widthBreakpoint?: string; @@ -42065,39 +42065,39 @@ declare namespace __esri { export interface BreakpointsOwnerBreakpoints extends Object { /** * Sets the `xsmall` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) is smaller than this value, then the value of [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will be `xsmall`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) - * + * * @default 544 */ xsmall?: number; /** * Sets the `small` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) is between this value and the value of the `xsmall` property, then the value of [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will be `small`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) - * + * * @default 768 */ small?: number; /** * Sets the `medium` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) is between this value and the value of the `small` property, then the value of [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will be `medium`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) - * + * * @default 992 */ medium?: number; /** * Sets the `large` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) is between this value and the value of the `medium` property, then the value of [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will be `large`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) - * + * * @default 1200 */ large?: number; /** * Sets the `xlarge` breakpoint in pixels used by [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) and [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint). If the view's [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#width) is greater than the value of the `large` property, then the value of [widthBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#widthBreakpoint) or [heightBreakpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#heightBreakpoint) will be `xlarge`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BreakpointsOwner.html#breakpoints) */ xlarge?: number; @@ -42106,63 +42106,63 @@ declare namespace __esri { interface DOMContainer { /** * The `id` or node representing the DOM element containing the view. This is typically set in the view's constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#container) */ container: HTMLDivElement; /** * Indicates if the browser focus is on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#focused) */ readonly focused: boolean; /** * The height of the view in pixels read from the view container element. The view container needs to have a height greater than 0 to be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#height) - * + * * @default 0 */ readonly height: number; /** * A Popup object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#map). The view has a default instance of [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) with predefined styles and a template for defining content. The content in this default instance may be modified directly in the [popup's content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) or in a layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). You may create a new [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) instance and set it to this property to customize the style, positioning, and content of the popup in favor of using the default popup instance on the view. In addition, if wanting to prevent any popups from opening, use the syntax below: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#popup) */ popup: Popup; /** * Indicates if the view is being resized. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#resizing) - * + * * @default false */ readonly resizing: boolean; /** * An array containing the width and height of the view in pixels, e.g. `[width, height]`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#size) */ readonly size: number[]; /** * Indicates if the view is visible on the page. Is `true` if the view has no [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#container), a [height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#height) or [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#width) equal to 0, or the CSS `visibility` is `hidden`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#suspended) - * + * * @default true */ readonly suspended: boolean; /** * Exposes the default widgets available in the view and allows you to toggle them on and off. See [DefaultUI](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html) for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#ui) */ ui: DefaultUI; /** * The width of the view in pixels read from the view container element. The view container needs to have a width greater than 0 to be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#width) - * + * * @default 0 */ readonly width: number; @@ -42179,19 +42179,19 @@ declare namespace __esri { interface DOMContainerProperties { /** * The `id` or node representing the DOM element containing the view. This is typically set in the view's constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#container) */ container?: HTMLDivElement | string; /** * A Popup object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#map). The view has a default instance of [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) with predefined styles and a template for defining content. The content in this default instance may be modified directly in the [popup's content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) or in a layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). You may create a new [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) instance and set it to this property to customize the style, positioning, and content of the popup in favor of using the default popup instance on the view. In addition, if wanting to prevent any popups from opening, use the syntax below: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#popup) */ popup?: PopupProperties; /** * Exposes the default widgets available in the view and allows you to toggle them on and off. See [DefaultUI](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html) for more details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#ui) */ ui?: DefaultUIProperties; @@ -42200,21 +42200,21 @@ declare namespace __esri { interface GroundView extends Accessor { /** * An elevation sampler that may be used to sample and query elevation values from the ground surface that is currently being displayed. The elevation sampler is not supported for [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and may be `null` while the ground surface display is being initialized. The resolution of the sampled values depends on the ground elevation display resolution (high resolution close to the camera, low resolution far away from the camera). Because of the dynamic nature of the display resolution, the [demResolution](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html#demResolution) property of the returned sampler will always return `{ min: -1, max: -1 }. If higher or more consistent sample resolution is required, then consider creating a sampler at the desired resolution using ElevationLayer.createSampler or Ground.createSampler. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#elevationSampler) */ readonly elevationSampler: ElevationSampler; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) in the ground. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#layerViews) */ readonly layerViews: Collection; /** * Value is `true` when any of the ground layer views are updating. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-GroundView.html#updating) - * + * * @default false */ readonly updating: boolean; @@ -42235,7 +42235,7 @@ declare namespace __esri { interface GamepadInputDevice extends Accessor { /** * The native Gamepad object exposed by the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadInputDevice.html#native) */ readonly native: Gamepad; @@ -42244,7 +42244,7 @@ declare namespace __esri { interface GamepadInputDeviceConstructor { /** * Properties and configuration of a gamepad. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadInputDevice.html) */ @@ -42260,22 +42260,22 @@ declare namespace __esri { interface GamepadSettings extends Accessor { /** * A readonly collection of all gamepads detected. Can be watched for gamepads to be connected or disconnected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#devices) */ readonly devices: Collection; /** - * Determines what focus is required for gamepad events to be dispatched. Possible values: document | view | none - * + * Determines what focus is required for gamepad events to be dispatched. Possible values: document | view | none + * * Possible Value | Description * ---------------|------------ * document | Gamepad events are emitted when any part of the current webpage has focus. This allows for gamepad events being emitted even while a UI element is focused. * view | Gamepad events are emitted when the view [container element](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#container) has browser focus. This is useful when multiple views might be present on a single webpage. * none | Gamepad events are emitted independently of focus. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#enabledFocusMode) - * + * * @default document */ enabledFocusMode: "document" | "view" | "none"; @@ -42291,17 +42291,17 @@ declare namespace __esri { interface GamepadSettingsProperties { /** - * Determines what focus is required for gamepad events to be dispatched. Possible values: document | view | none - * + * Determines what focus is required for gamepad events to be dispatched. Possible values: document | view | none + * * Possible Value | Description * ---------------|------------ * document | Gamepad events are emitted when any part of the current webpage has focus. This allows for gamepad events being emitted even while a UI element is focused. * view | Gamepad events are emitted when the view [container element](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#container) has browser focus. This is useful when multiple views might be present on a single webpage. * none | Gamepad events are emitted independently of focus. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-gamepad-GamepadSettings.html#enabledFocusMode) - * + * * @default document */ enabledFocusMode?: "document" | "view" | "none"; @@ -42310,7 +42310,7 @@ declare namespace __esri { interface Input extends Accessor { /** * Gamepad input specific configuration settings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-Input.html#gamepad) */ readonly gamepad: GamepadSettings; @@ -42331,16 +42331,16 @@ declare namespace __esri { interface CSVLayerView extends LayerView { /** * Highlights the given feature(s). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html#highlight) - * + * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. - * + * */ highlight(target?: Graphic | Graphic[] | number | number[]): any; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): @@ -42348,16 +42348,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html#queryExtent) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryExtent(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all features available for drawing is returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all features available for drawing is returned. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): @@ -42365,16 +42365,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html#queryFeatureCount) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatureCount(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all features available for drawing are returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all features available for drawing are returned. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): @@ -42382,16 +42382,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html#queryFeatures) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatures(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. * * Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html): @@ -42399,11 +42399,11 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-CSVLayerView.html#queryObjectIds) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryObjectIds(params?: Query | QueryProperties): IPromise; } @@ -42423,23 +42423,23 @@ declare namespace __esri { interface FeatureLayerView extends LayerView { /** * The layer being viewed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#layer) */ readonly layer: FeatureLayer; /** * Highlights the given feature(s). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) - * + * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. - * + * */ highlight(target?: Graphic | Graphic[] | number | number[]): any; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. Valid only for [hosted feature services](http://doc.arcgis.com/en/arcgis-online/share-maps/hosted-web-layers.htm) on [arcgis.com](http://arcgis.com) and for ArcGIS Server 10.3.1 and later. If query parameters are not provided, the extent and count of all features available for drawing are returned. To query for the extent of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryExtent) method. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. Valid only for [hosted feature services](http://doc.arcgis.com/en/arcgis-online/share-maps/hosted-web-layers.htm) on [arcgis.com](http://arcgis.com) and for ArcGIS Server 10.3.1 and later. If query parameters are not provided, the extent and count of all features available for drawing are returned. To query for the extent of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryExtent) method. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries are executed against quantized geometries in the layer view. The resolution of layer view geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layer view query will likewise be at the same scale resolution of the view. * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. @@ -42448,16 +42448,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryExtent) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryExtent(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all features available for drawing is returned. To query for the count of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatureCount) method. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all features available for drawing is returned. To query for the count of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatureCount) method. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries are executed against quantized geometries in the layer view. The resolution of layer view geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layer view query will likewise be at the same scale resolution of the view. * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. @@ -42466,16 +42466,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryFeatureCount) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatureCount(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all features available for drawing are returned. To execute a query against all the features in a Feature Service rather than only those in the client, you must use the [FeatureLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) method. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all features available for drawing are returned. To execute a query against all the features in a Feature Service rather than only those in the client, you must use the [FeatureLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures) method. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries are executed against quantized geometries in the layer view. The resolution of layer view geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layer view query will likewise be at the same scale resolution of the view. * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. @@ -42484,16 +42484,16 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryFeatures) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryFeatures(params?: Query | QueryProperties): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned. To query for ObjectIDs of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryObjectIds()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryObjectIds) method. - * > **Known Limitations** + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features available for drawing in the layer view and returns array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned. To query for ObjectIDs of features directly from a Feature Service rather than those visible in the view, you must use the [FeatureLayer.queryObjectIds()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryObjectIds) method. + * > **Known Limitations** * * Queries with `outStatistics` and any other parameter involving statistics are currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). * * Spatial queries are executed against quantized geometries in the layer view. The resolution of layer view geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layer view query will likewise be at the same scale resolution of the view. * * Spatial queries have the same limitations as those listed in the [projection engine](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-projection.html) documentation. @@ -42502,11 +42502,11 @@ declare namespace __esri { * * Gusterberg (Ferro) (8042) – Austria/Czech Republic * * ISN2016 (8086) - Iceland * * SVY21 (4757) - Singapore - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryObjectIds) - * + * * @param params Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. - * + * */ queryObjectIds(params?: Query | QueryProperties): IPromise; } @@ -42514,7 +42514,7 @@ declare namespace __esri { interface FeatureLayerViewConstructor { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html) */ @@ -42529,21 +42529,21 @@ declare namespace __esri { interface GraphicsLayerView extends LayerView { /** - * Highlights the given feature(s). + * Highlights the given feature(s). * > **Known Limitations** Currently the highlight method is only supported in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GraphicsLayerView.html#highlight) - * + * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. - * + * */ highlight(target?: Graphic | Graphic[] | number | number[]): any; /** * Returns all graphics available for drawing in the layer view as an array of [Graphic[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GraphicsLayerView.html#queryGraphics) - * - * + * + * */ queryGraphics(): IPromise; } @@ -42551,7 +42551,7 @@ declare namespace __esri { interface GraphicsLayerViewConstructor { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-GraphicsLayerView.html) */ @@ -42567,7 +42567,7 @@ declare namespace __esri { interface ImageryLayerView extends LayerView { /** * An object that provides the user access to [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer. See the object specifications table below for details about each property. This object is used as input in the [pixelFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function for filtering and processing each pixel in the block. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ pixelData: ImageryLayerViewPixelData; @@ -42576,7 +42576,7 @@ declare namespace __esri { interface ImageryLayerViewConstructor { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of an [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html) */ @@ -42588,7 +42588,7 @@ declare namespace __esri { interface ImageryLayerViewProperties extends LayerViewProperties { /** * An object that provides the user access to [pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer. See the object specifications table below for details about each property. This object is used as input in the [pixelFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function for filtering and processing each pixel in the block. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ pixelData?: ImageryLayerViewPixelData; @@ -42598,13 +42598,13 @@ declare namespace __esri { export interface ImageryLayerViewPixelData extends Object { /** * The extent of the `pixelBlock`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ extent?: Extent; /** * An object representing the pixels in the view. This provides the user access to each pixel on the client via the `pixels` property of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ImageryLayerView.html#pixelData) */ pixelBlock: PixelBlock; @@ -42613,25 +42613,25 @@ declare namespace __esri { interface KMLLayerView extends LayerView { /** * A collection of all the [MapImages](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) from visible sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisibleMapImages) */ readonly allVisibleMapImages: Collection; /** * A collection of all the points from visible sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePoints) */ readonly allVisiblePoints: Collection; /** * A collection of all the polygons from visible sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePolygons) */ readonly allVisiblePolygons: Collection; /** * A collection of all the polylines from visible sublayers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#allVisiblePolylines) */ readonly allVisiblePolylines: Collection; @@ -42651,31 +42651,31 @@ declare namespace __esri { /** * **MapImage** represents an image overlay draped onto the terrain. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ export interface KMLLayerViewMapImage extends Object { /** * Map image id. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ id: number; /** * URL to the map image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ href: string; /** * The [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of the map image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ Extent: Extent; /** * Rotation of the map image about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-KMLLayerView.html#MapImage) */ rotation: number; @@ -42684,29 +42684,29 @@ declare namespace __esri { interface LayerView extends Accessor, corePromise { /** * The layer being viewed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#layer) */ readonly layer: Layer; /** * Value is `true` if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended) */ readonly suspended: boolean; /** * Value is `true` when the layer is updating; for example, if it is in the process of fetching data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#updating) - * + * * @default false */ readonly updating: boolean; /** * When `true`, the layer is visible in the view. Set this property to `false` to hide the layer from the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#visible) - * + * * @default true */ visible: boolean; @@ -42723,9 +42723,9 @@ declare namespace __esri { interface LayerViewProperties { /** * When `true`, the layer is visible in the view. Set this property to `false` to hide the layer from the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#visible) - * + * * @default true */ visible?: boolean; @@ -42734,51 +42734,51 @@ declare namespace __esri { interface SceneLayerView extends LayerView { /** * Highlights the given feature(s). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#highlight) - * + * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. - * + * */ highlight(target?: Graphic | Graphic[] | number | number[]): any; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns the 3D [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. * > To query for the extent of features directly from a Scene Service rather than those loaded for the current view, you must use the [SceneLayer.queryExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryExtent) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryExtent) - * + * * @param params Specifies the attributes of the query. Only the[objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds), [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) and [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned. - * + * */ queryExtent(params?: Query): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. * > To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the [SceneLayer.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatureCount) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatureCount) - * + * * @param params Specifies the attributes of the query. Only the[objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds), [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) and [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned. - * + * */ queryFeatureCount(params?: Query): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. Querying more than 10.000 features returns an error, unless num is specified in the Query. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-FeatureSet.html). If query parameters are not provided, all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. Querying more than 10.000 features returns an error, unless num is specified in the Query. * > To execute a query against all the features in a Scene Service rather than only those loaded for the current view, you must use the [SceneLayer.queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatures) - * + * * @param params Specifies the attributes of the query. Only the [outFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#outFields), [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds), [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) and [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned. - * + * */ queryFeatures(params?: Query): IPromise; /** - * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. + * Executes a [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all loaded features are returned. This method is not yet supported when the associated scene layer has a [geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) of `point`. Read more about queries in the Query section of the [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) class description. * > To query for ObjectIDs of features directly from a Scene Service rather than those loaded for the current view, you must use the [SceneLayer.queryObjectIds()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryObjectIds) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryObjectIds) - * + * * @param params Specifies the attributes of the query. Only the[objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#objectIds), [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#num) and [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html#start) properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned. - * + * */ queryObjectIds(params?: Query): IPromise; } @@ -42786,7 +42786,7 @@ declare namespace __esri { interface SceneLayerViewConstructor { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html) */ @@ -42802,54 +42802,54 @@ declare namespace __esri { interface StreamLayerView extends LayerView, Evented { /** * The error that explains an unsuccessful attempt to connect to the stream service or an unexpected disconnection from the stream service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connectionError) */ readonly connectionError: Error; /** * The status of the Web Socket connection with the stream service. This property can be watched to see if the connection is lost unexpectedly. **Possible Values:** connected | disconnected - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connectionStatus) */ readonly connectionStatus: string; /** * Contains the attribute and spatial filters used to filter messages sent to the given layer view by a stream service. To change the filter for only a single layer view, use the [updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#updateFilter) method. The layer view's filter is always updated when the [updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) method of the associated stream layer instance is called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) */ readonly filter: StreamLayerViewFilter; /** * Contains the collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) visible in the layer view for the live stream. Graphics may be removed from the layer view by calling the [removeAll()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#removeAll) method from [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#graphics) */ graphics: Collection; /** * Opens a web socket connection with the stream service to start receiving messages. This is called internally when the StreamLayer is added to a view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connect) - * - * + * + * */ connect(): IPromise; /** * Closes the web socket connection with the stream service. This is called internally when the StreamLayer is removed from a view. To verify when the connection is closed, watch the [connectionStatus](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#connectionStatus) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#disconnect) - * - * + * + * */ disconnect(): void; /** * Updates the [filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) on the StreamLayerView. The filter is updated only on the layer view from which it is called. To update the filter on all layer views generated from a common layer, use the [StreamLayer.updateFilter()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#updateFilter) method. If the input `filter` object is `undefined` or `null`, the spatial and attribute filters are removed. Filter changes only apply to incoming features. Features already displayed in the view will be removed automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#updateFilter) - * + * * @param filter Updates the spatial and attribute [filters](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter). If `null`, all filters are cleared. * @param filter.geometry A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view. If `null`, the spatial filter is cleared. * @param filter.where A SQL where clause used to filter features by attributes. If `null`, the attribute filter is cleared. - * + * */ updateFilter(filter: StreamLayerViewUpdateFilterFilter): IPromise; @@ -42860,7 +42860,7 @@ declare namespace __esri { interface StreamLayerViewConstructor { /** * Represents the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of a [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html) after it has been added to a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html) */ @@ -42872,7 +42872,7 @@ declare namespace __esri { interface StreamLayerViewProperties extends LayerViewProperties { /** * Contains the collection of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) visible in the layer view for the live stream. Graphics may be removed from the layer view by calling the [removeAll()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html#removeAll) method from [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#graphics) */ graphics?: CollectionProperties; @@ -42885,13 +42885,13 @@ declare namespace __esri { export interface StreamLayerViewFilter extends Object { /** * A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) */ geometry?: Extent; /** * A SQL where clause used to filter features by attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#filter) */ where?: string; @@ -42901,13 +42901,13 @@ declare namespace __esri { export interface StreamLayerViewUpdateFilterFilter extends Object { /** * A spatial filter for filtering features. Only features that intersect the given geometry are displayed in the view. If `null`, the spatial filter is cleared. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#updateFilter) */ geometry?: Extent; /** * A SQL where clause used to filter features by attributes. If `null`, the attribute filter is cleared. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-StreamLayerView.html#updateFilter) */ where?: string; @@ -42916,71 +42916,71 @@ declare namespace __esri { interface MapView extends View, BreakpointsOwner { /** * Represents the view's center point; when setting the center, you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing a longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) properties are also set in the constructor. The returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object is always in the spatial reference of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#map) and may be modified internally. To persist the returned object, create a clone using [Point.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) */ center: Point; /** * Specifies constraints to [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale), [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom), and [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) that may be applied to the MapView. See object specification below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ constraints: MapViewConstraints; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). The returned [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object is an internal reference which may be modified internally. To persist the returned object, create a copy using [Extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) - * + * * @default null */ extent: Extent; /** * Options for configuring the highlight. Use the highlight method on the appropriate [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) to highlight a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) */ highlightOptions: MapViewHighlightOptions; /** * Defines which anchor stays still while resizing the browser window. The default, `center`, ensures the view's center point remains constantly visible as the window size changes. The other options allow the respective portion of the view to remain visible when the window's size is changed. **Possible values:** center | left | right | top | bottom | top-left | top-right | bottom-left | bottom-right - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resizeAlign) - * + * * @default center */ resizeAlign: string; /** * The clockwise rotation of due north in relation to the top of the view in degrees. The view may be rotated by directly setting the rotation or by using the following mouse event: `Right-click + Drag`. Map rotation may be disabled by setting the `rotationEnabled` property in [constraints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) to `false`. See the code snippet below for an example of this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) - * + * * @default 0 */ rotation: number; /** * Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) */ scale: number; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. Setting the viewpoint immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). The returned [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) object is an internal reference which may be modified internally. To persist the returned object, create a copy using [Viewpoint.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the level of detail (LOD) at the center of the view. Setting the zoom immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Setting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) is a convenient way to set the initial extent of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) */ zoom: number; /** * Sets the focus on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#focus) - * - * + * + * */ focus(): void; /** @@ -42990,12 +42990,12 @@ declare namespace __esri { * * [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) (or array of [Graphic[]](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html)) * * [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) * * Object with a combination of `target`, `center` and `scale` properties (with `target` being any of the types listed above). The `center` property is provided as a convenience to animate the [MapView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) and is equivalent to specifying the `target` with the center [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * - * + * + * * This function returns a promise which resolves as soon as the new view has been set to the target. If the transition is animated, then the ongoing animation can be obtained using [MapView.animation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#animation). If a tiled map service is used as the basemap and `snapToZoom` property is set to `true` in [constraints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints), the `goTo` method will zoom to the level of detail (LOD) of the basemap that is nearest to the defined `target`. If `snapToZoom` property is set to `false`, the `goTo` method will zoom to the exact `target`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) - * + * * @param target The target location/viewpoint to animate to. When using an object for `target`, use the properties in the table below. * @param target.target The target of the animation. * @param target.center The [MapView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) to go to. @@ -43005,58 +43005,58 @@ declare namespace __esri { * @param options.animate Indicates if the transition to the new view should be animated. If set to false, `duration` and `easing` properties are ignored. * @param options.duration The duration of the animation in milliseconds. * @param options.easing The easing function used for the animation. See [easing functions](https://easings.net/) for graphical representations of these functions. **Possible Values:** linear | ease | ease-in | ease-out | ease-in-out - * + * */ goTo(target: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | MapViewGoToTarget, options?: MapViewGoToOptions): IPromise; /** * Indicates whether there is an event listener on the instance that matches the provided event name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hasEventListener) - * - * + * + * */ hasEventListener(): void; /** * Returns the topmost feature from each layer that intersects the specified screen coordinates. The following layer types will return a result if a hit is made on an intersecting feature: [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html), [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html), and [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html). At 4.6 and later, a hit test will always return a result from [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html). However, the result will only indicate the ID and the name of the layer within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978) that intersects the screen point. Detailed attribute and spatial information about the actual feature represented in the layer is not returned. HitTest results returned from VectorTileLayers are primarily used for [Vector tile style editor applications](https://maps.esri.com/jg/VectorBasemapStyleEditor/index.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) - * + * * @param screenPoint The screen coordinates of the click on the view. * @param screenPoint.x The horizontal screen coordinate of the click on the view. * @param screenPoint.y The vertical screen coordinate of the click on the view. - * + * */ hitTest(screenPoint: MapViewHitTestScreenPoint): IPromise; /** * Registers an event handler on the instance. Call this method to hook an event with a listener. See the [Events summary table](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#events-summary) for a list of listened events. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#on) - * + * * @param type The name of the event or events to listen for. * @param modifiersOrHandler Additional modifier keys to filter events. Please see [Key Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) for possible values. All the standard key values are supported. Alternatively, if no modifiers are required, the function will call when the event fires. The following events don't support modifier keys: `blur`, `focus`, `layerview-create`, `layerview-destroy`, `resize`. * @param handler The function to call when the event is fired, if modifiers were specified. - * + * */ on(type: string | string[], modifiersOrHandler: string[] | EventHandler, handler?: EventHandler): IHandle; /** * Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toMap) - * + * * @param screenPoint The screen coordinates to convert. * @param screenPoint.x The horizontal screen coordinate to convert. * @param screenPoint.y The vertical screen coordinate to convert. - * + * */ toMap(screenPoint: MapViewToMapScreenPoint): Point; /** * Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a [screen point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toScreen) - * + * * @param point A point geometry. * @param screenPoint ScreenPoint object that will reference the result. - * + * */ toScreen(point: Point, screenPoint?: ScreenPoint): ScreenPoint; @@ -43137,7 +43137,7 @@ declare namespace __esri { interface MapViewConstructor { /** * A MapView displays a 2D view of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance. An instance of MapView must be created to render a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) (along with its operational and base layers) in 2D. To render a map and its layers in 3D, see the documentation for [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). For a general overview of views, see [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) */ @@ -43149,61 +43149,61 @@ declare namespace __esri { interface MapViewProperties extends ViewProperties, BreakpointsOwnerProperties { /** * Represents the view's center point; when setting the center, you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing a longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) properties are also set in the constructor. The returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object is always in the spatial reference of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#map) and may be modified internally. To persist the returned object, create a clone using [Point.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) */ center?: PointProperties | number[]; /** * Specifies constraints to [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale), [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom), and [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) that may be applied to the MapView. See object specification below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ constraints?: MapViewConstraints; /** * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). The returned [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) object is an internal reference which may be modified internally. To persist the returned object, create a copy using [Extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent) - * + * * @default null */ extent?: ExtentProperties; /** * Options for configuring the highlight. Use the highlight method on the appropriate [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) to highlight a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) */ highlightOptions?: MapViewHighlightOptionsProperties; /** * Defines which anchor stays still while resizing the browser window. The default, `center`, ensures the view's center point remains constantly visible as the window size changes. The other options allow the respective portion of the view to remain visible when the window's size is changed. **Possible values:** center | left | right | top | bottom | top-left | top-right | bottom-left | bottom-right - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resizeAlign) - * + * * @default center */ resizeAlign?: string; /** * The clockwise rotation of due north in relation to the top of the view in degrees. The view may be rotated by directly setting the rotation or by using the following mouse event: `Right-click + Drag`. Map rotation may be disabled by setting the `rotationEnabled` property in [constraints](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) to `false`. See the code snippet below for an example of this. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) - * + * * @default 0 */ rotation?: number; /** * Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) */ scale?: number; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. Setting the viewpoint immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). The returned [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) object is an internal reference which may be modified internally. To persist the returned object, create a copy using [Viewpoint.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#viewpoint) */ viewpoint?: ViewpointProperties; /** * Represents the level of detail (LOD) at the center of the view. Setting the zoom immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Setting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) is a convenient way to set the initial extent of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) */ zoom?: number; @@ -43294,13 +43294,13 @@ declare namespace __esri { /** * Object specification for the result of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ export interface HitTestResult extends Object { /** * An array of result objects returned from the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest). Results are returned when the location of the input screen coordinates intersect a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the view. See the table below for the specification of each object in this array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ results: HitTestResultResults[]; @@ -43392,77 +43392,77 @@ declare namespace __esri { export interface MapViewConstraints extends Object { /** * An array of [LODs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LOD.html). If not specified, this value is read from the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). This property may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ lods?: LOD[]; /** * The minimum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ minScale?: number; /** * The maximum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. Setting this value to `0` allows the user to overzoom layer tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ maxScale?: number; /** * The minimum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ minZoom?: number; /** * The maximum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. Setting this value to `0` allows the user to overzoom layer tiles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ maxZoom?: number; /** * When `true`, the view snaps to the next LOD when zooming in or out. When `false`, the zoom is continuous. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) - * + * * @default true */ snapToZoom?: boolean; /** * Indicates whether the user can rotate the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) - * + * * @default true */ rotationEnabled?: boolean; /** * A read-only property that specifies the levels of detail (LODs) read from the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveLODs?: LOD[]; /** * A read-only property that specifies the minimum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMinZoom?: number; /** * A read-only property that specifies the maximum [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) level the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMaxZoom?: number; /** * A read-only property that specifies the minimum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMinScale?: number; /** * A read-only property that specifies the maximum [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) the user is allowed to zoom to within the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) */ effectiveMaxScale?: number; @@ -43472,25 +43472,25 @@ declare namespace __esri { export interface MapViewGoToOptions extends Object { /** * Indicates if the transition to the new view should be animated. If set to false, `duration` and `easing` properties are ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) - * + * * @default true */ animate?: boolean; /** * The duration of the animation in milliseconds. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) - * + * * @default 200 */ duration?: number; /** * The easing function used for the animation. See [easing functions](https://easings.net/) for graphical representations of these functions. **Possible Values:** linear | ease | ease-in | ease-out | ease-in-out - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) - * + * * @default ease */ easing?: string | Function; @@ -43500,25 +43500,25 @@ declare namespace __esri { export interface MapViewGoToTarget extends Object { /** * The target of the animation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) */ target?: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint; /** * The [MapView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) */ center?: number[]; /** * The [MapView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) */ scale?: number; /** * The [MapView.zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#zoom) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) */ zoom?: number; @@ -43528,25 +43528,25 @@ declare namespace __esri { export interface MapViewHighlightOptionsProperties extends Object { /** * The color of the highlight. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default #00ffff */ color?: Color | number[] | string; /** * The opacity of the highlight halo. This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default 1 */ haloOpacity?: number; /** * The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default 0.25 */ fillOpacity?: number; @@ -43555,25 +43555,25 @@ declare namespace __esri { export interface MapViewHighlightOptions extends AnonymousAccessor { /** * The color of the highlight. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default #00ffff */ color?: Color; /** * The opacity of the highlight halo. This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default 1 */ haloOpacity?: number; /** * The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) - * + * * @default 0.25 */ fillOpacity?: number; @@ -43583,13 +43583,13 @@ declare namespace __esri { export interface MapViewHitTestScreenPoint extends Object { /** * The horizontal screen coordinate of the click on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) */ x: number; /** * The vertical screen coordinate of the click on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) */ y: number; @@ -43599,13 +43599,13 @@ declare namespace __esri { export interface MapViewToMapScreenPoint extends Object { /** * The horizontal screen coordinate to convert. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toMap) */ x: number; /** * The vertical screen coordinate to convert. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#toMap) */ y: number; @@ -43766,13 +43766,13 @@ declare namespace __esri { export interface HitTestResultResults extends Object { /** * A graphic representing a feature in the view that intersects the input screen coordinates. If the graphic comes from a layer with an applied [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html), then the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) property will be empty. Other properties may be empty based on the context in which the graphic is fetched. If the result comes from a [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) then a static graphic is returned with two `attributes`: `layerId` and `layerName`. These correspond to the name and id of the style-layer in the [vector tile style](https://developers.arcgis.com/rest/services-reference/vector-tile-style.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ graphic: Graphic; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult) */ mapPoint: Point; @@ -43781,33 +43781,33 @@ declare namespace __esri { interface gamepadGamepadSettings extends Accessor { /** * Use this property to explicitly select the gamepad device for map and scene navigation. If unspecified then all connected gamepads will be able to navigate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#device) - * + * * @default null */ device: GamepadInputDevice; /** * Whether gamepad navigation is enabled on the View. If this is enabled, but no `device` is specified, the first supported one will be selected automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#enabled) - * + * * @default true */ enabled: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. If set to `pan`, movement will be at a constant altitude (panning the view forward and backward) whereas `zoom` will move the view in the viewing direction. Pan is best suited for exploring a scene as if on foot or in a car. Zoom mode provides great control to navigate the scene similar to a flight simulator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#mode) - * + * * @default pan */ mode: "pan" | "zoom"; /** * Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). The default behavior is to tilt the view down when pressing the stick that controls tilt forwards. **Possible Values:** forward-down | forward-up - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#tiltDirection) - * + * * @default forward-down */ tiltDirection: "forward-down" | "forward-up"; @@ -43824,33 +43824,33 @@ declare namespace __esri { interface gamepadGamepadSettingsProperties { /** * Use this property to explicitly select the gamepad device for map and scene navigation. If unspecified then all connected gamepads will be able to navigate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#device) - * + * * @default null */ device?: GamepadInputDeviceProperties; /** * Whether gamepad navigation is enabled on the View. If this is enabled, but no `device` is specified, the first supported one will be selected automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#enabled) - * + * * @default true */ enabled?: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. If set to `pan`, movement will be at a constant altitude (panning the view forward and backward) whereas `zoom` will move the view in the viewing direction. Pan is best suited for exploring a scene as if on foot or in a car. Zoom mode provides great control to navigate the scene similar to a flight simulator. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#mode) - * + * * @default pan */ mode?: "pan" | "zoom"; /** * Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). The default behavior is to tilt the view down when pressing the stick that controls tilt forwards. **Possible Values:** forward-down | forward-up - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-gamepad-GamepadSettings.html#tiltDirection) - * + * * @default forward-down */ tiltDirection?: "forward-down" | "forward-up"; @@ -43859,7 +43859,7 @@ declare namespace __esri { interface Navigation extends Accessor { /** * Gamepad navigation specific configuration settings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-navigation-Navigation.html#gamepad) */ readonly gamepad: gamepadGamepadSettings; @@ -43880,52 +43880,52 @@ declare namespace __esri { interface SceneView extends View, BreakpointsOwner { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. This property can only be set once at construction time. When alpha compositing is enabled, web scenes are less performant. It's important to set this property to `true` only when you need to apply transparency on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#alphaCompositingEnabled) - * + * * @default false */ alphaCompositingEnabled: boolean; /** - * The observation point from which the visible portion (or perspective) of the SceneView is determined. Contains properties including the elevation, tilt, and heading (in degrees) of the current view. Setting the camera immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. The camera property contains an internal reference which may be modified in the future. To persist or modify the camera, create a clone using [camera.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#clone). + * The observation point from which the visible portion (or perspective) of the SceneView is determined. Contains properties including the elevation, tilt, and heading (in degrees) of the current view. Setting the camera immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. The camera property contains an internal reference which may be modified in the future. To persist or modify the camera, create a clone using [camera.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) */ camera: Camera; /** - * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. The center property contains an internal reference which may be modified in the future. To persist or modify the center, create a clone using [center.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). + * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. The center property contains an internal reference which may be modified in the future. To persist or modify the center, create a clone using [center.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) */ center: Point; /** * Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. If defined, only data (including the basemap) within the area will be displayed. The `clippingArea` property only applies to [local](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) scenes. ![scene-clipping-area](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-clipping-area.png%20%22Local%20scene%20with%20clippingArea%22) The clippingArea property contains an internal reference which may be modified in the future. To persist or modify the clippingArea, create a clone using [clippingArea.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) */ clippingArea: Extent; /** * Specifies constraints for [Camera tilt](esri-Camera.html#tilt) and altitude that may be applied to the SceneView. See the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ constraints: SceneViewConstraints; /** - * Specifies various properties of the environment's visualization in the view. The SceneView will redraw automatically when any property of environment changes. + * Specifies various properties of the environment's visualization in the view. The SceneView will redraw automatically when any property of environment changes. * ```js * const view = new SceneView({ * map: map, * container: "viewDiv" * }); - * + * * // Set the sun position to reflect the current time * view.environment.lighting.date = Date.now(); - * + * * // Disable automatic lighting updates by camera tracking * view.environment.lighting.cameraTrackingEnabled = true; - * + * * // Set a background color * const view = new SceneView({ * container: "view", @@ -43940,82 +43940,82 @@ declare namespace __esri { * } * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ environment: SceneViewEnvironment; /** - * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Rather than using extent to change the visible portion of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a SceneView, you should use [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) since it easily allows you to define the heading, elevation and tilt of the observation point from which the view's perspective is created. When set in the constructor, this property overrides the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) or [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) are also set in the constructor. The extent property contains an internal reference which may be modified in the future. To persist or modify the extent, create a clone using [extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). + * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Rather than using extent to change the visible portion of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a SceneView, you should use [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) since it easily allows you to define the heading, elevation and tilt of the observation point from which the view's perspective is created. When set in the constructor, this property overrides the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) or [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) are also set in the constructor. The extent property contains an internal reference which may be modified in the future. To persist or modify the extent, create a clone using [extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) - * + * * @default null */ extent: Extent; /** * Options for configuring the highlight. Use the highlight method on the appropriate [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) to highlight a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) */ highlightOptions: SceneViewHighlightOptions; /** - * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. The `low` quality profile significantly increases performance on slower browsers and devices by reducing the memory limit and the visual quality in the following aspects: + * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. The `low` quality profile significantly increases performance on slower browsers and devices by reducing the memory limit and the visual quality in the following aspects: * * Map resolution * * Scene layer detail level * * Anti-aliasing (edge smoothing) - * - * - * The high and medium quality profiles only differ in the maximum amount of memory which the view is allowed to use. A higher memory limit improves quality in complex web scenes with many layers, but can have a negative impact on drawing performance and stability. The default value is based on the detected browser: + * + * + * The high and medium quality profiles only differ in the maximum amount of memory which the view is allowed to use. A higher memory limit improves quality in complex web scenes with many layers, but can have a negative impact on drawing performance and stability. The default value is based on the detected browser: * * `low` for Internet Explorer 11 and certain mobile devices * * `medium` for any other browser - * - * + * + * * Overriding the default value is best done in the constructor (see example below). If the value is modified after construction, only a subset of the quality aspects are affected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile) */ qualityProfile: string; /** * Represents an approximation of the map scale at the center of the view. Setting the scale immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) property. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) */ scale: number; /** - * The viewing mode (`local` or `global`). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or [clipped](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) area. Users may also navigate the camera of a local scene below the surface of a basemap. - * + * The viewing mode (`local` or `global`). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or [clipped](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) area. Users may also navigate the camera of a local scene below the surface of a basemap. + * * Value | Example | Description * ------|-------|------------ * global | ![scene-global](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-global.png) | Global scenes allow the entire globe to render in the view, showing the curvature of the earth. * local | ![scene-local](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-local.png) | Local scenes render the earth on a flat surface. They can be constrained to only show a "local" area by setting the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clipplingArea) property. Local scenes also allow for displaying and exploring data that would otherwise be hidden by the surface of the earth. - * + * * Depending on the viewing mode different [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) - * + * * @default global */ viewingMode: string; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. In SceneViews, [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) should be used in favor of viewpoint for watching or changing the point of view. Setting the viewpoint immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) is also set in the constructor. The viewpoint property contains an internal reference which may be modified in the future. To persist or modify the viewpoint, create a clone using [viewpoint.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) */ viewpoint: Viewpoint; /** * Represents the level of detail (LOD) at the center of the view. Setting the zoom immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). Setting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) is a convenient way to set the initial extent of the view. If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), or [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) properties are also set in the constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) */ zoom: number; /** * Sets the focus on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#focus) - * - * + * + * */ focus(): void; /** @@ -44026,12 +44026,12 @@ declare namespace __esri { * * [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) * * [Camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) * * Object with a combination of `target`, `center`, `scale`, `position`, `heading` and `tilt` properties (with `target` being any of the types listed above). The `center` property is provided as a convenience to animate the [SceneView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) and is the equivalent of specifying the `target` with the center [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). The target must be provided in the spatial reference of the view. - * - * + * + * * This function returns a promise which resolves as soon as the new view has been set to the target. If the transition is animated, then the ongoing animation can be obtained using [SceneView.animation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#animation). If the given target is far away from the current camera position, then heading and tilt will be automatically set to their neutral values (facing north, looking top down). Tilt and heading can always be explicitly set to override this behavior. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) - * + * * @param target The target location/viewpoint to go to. When using an object for `target`, use the properties in the table below. * @param target.target The target of the animation. * @param target.center The [SceneView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) to go to. @@ -44046,73 +44046,73 @@ declare namespace __esri { * @param options.duration Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration. * @param options.maxDuration The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. * @param options.easing The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: `linear`, `in-cubic`, `out-cubic`, `in-out-cubic`, `in-expo`, `out-expo`, `in-out-expo`, `in-out-coast-quadratic`. See [easing functions](https://easings.net/) for graphical representations of these functions. By default, animations that are less than 1000 ms use the `out-expo` easing function; longer animations use the `in-out-coast-quadratic` easing function. - * + * */ goTo(target: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | Camera | SceneViewGoToTarget, options?: SceneViewGoToOptions): IPromise; /** * Indicates whether there is an event listener on the instance that matches the provided event name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hasEventListener) - * - * + * + * */ hasEventListener(): void; /** * Returns the topmost feature from each layer that intersects the specified screen coordinates. The following layer types will return a result if a hit is made on an intersecting feature: [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html), [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html), and [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html). Draped graphics (i.e. graphics in layers where the [elevation mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#elevationInfo) is `on-the-ground`) are currently **not** returned from this method, even when they intersect the input screen point. When the ground surface is hit, but no graphic is found, then the result of hitTest will be a single object with its mapPoint set to the point on the surface that was hit, but its graphic will be set to `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) - * + * * @param screenPoint The screen coordinates of the click on the view. * @param screenPoint.x The horizontal screen coordinate of the click on the view. * @param screenPoint.y The vertical screen coordinate of the click on the view. - * + * */ hitTest(screenPoint: SceneViewHitTestScreenPoint): IPromise; /** * Registers an event handler on the instance. Call this method to hook an event with a listener. See the [Events summary table](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#events-summary) for a list of listened events. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#on) - * + * * @param type The name of the event or events to listen for. * @param modifiersOrHandler Additional modifier keys to filter events. Please see [Key Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) for possible values. All the standard key values are supported. Alternatively, if no modifiers are required, the function will call when the event fires. The following events don't support modifier keys: `blur`, `focus`, `layerview-create`, `layerview-destroy`, `resize`. * @param handler The function to call when the event is fired, if modifiers were specified. - * + * */ on(type: string | string[], modifiersOrHandler: string[] | EventHandler, handler?: EventHandler): IHandle; /** * Create a screenshot of the current view. Screenshots include only elements that are rendered on the canvas (all geographical elements), but excludes overlayed DOM elements (UI, popups, measurement labels, etc.). By default, a screenshot of the whole view is created. Different options allow for creating different types of screenshots, including taking screenshots at different aspect ratios, different resolutions and creating thumbnails. Screenshots are always taken inside the padded area of the view (see [padding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#padding)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) - * + * * @param options Screenshot options. * @param options.format The format of the resulting encoded data url. **Possible values**: jpg | png. * @param options.quality The quality (0 to 100) of the encoded image when encoding as `jpg`. * @param options.width The width of the screenshot (defaults to the area width). The height will be derived automatically if left unspecified, according to the aspect ratio of the of the screenshot area. * @param options.height The height of the screenshot (defaults to the area height). The width will be derived automatically if left unspecified, according to the aspect ratio of the screenshot area. * @param options.area Specifies whether to take a screenshot of a specific area of the view. The area coordinates are relative to the origin of the padded view (see [padding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#padding)) and will be clipped to the view size. Defaults to the whole view (padding excluded). - * + * */ takeScreenshot(options?: SceneViewTakeScreenshotOptions): IPromise; /** * Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) - * + * * @param screenPoint The screen coordinates to convert. * @param screenPoint.x The horizontal screen coordinate to convert. * @param screenPoint.y The vertical screen coordinate to convert. * @param mapPoint The point object that will reference the result. - * + * */ toMap(screenPoint: SceneViewToMapScreenPoint, mapPoint?: Point): Point; /** * Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a [screen point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-ScreenPoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toScreen) - * + * * @param point A point geometry. * @param screenPoint ScreenPoint object that will reference the result. - * + * */ toScreen(point: Point, screenPoint?: ScreenPoint): ScreenPoint; @@ -44193,7 +44193,7 @@ declare namespace __esri { interface SceneViewConstructor { /** * A SceneView displays a 3D view of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) instance using WebGL. To render a map and its layers in 2D, see the documentation for [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). For a general overview of views, see [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) */ @@ -44205,52 +44205,52 @@ declare namespace __esri { interface SceneViewProperties extends ViewProperties, BreakpointsOwnerProperties { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. This property can only be set once at construction time. When alpha compositing is enabled, web scenes are less performant. It's important to set this property to `true` only when you need to apply transparency on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#alphaCompositingEnabled) - * + * * @default false */ alphaCompositingEnabled?: boolean; /** - * The observation point from which the visible portion (or perspective) of the SceneView is determined. Contains properties including the elevation, tilt, and heading (in degrees) of the current view. Setting the camera immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. The camera property contains an internal reference which may be modified in the future. To persist or modify the camera, create a clone using [camera.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#clone). + * The observation point from which the visible portion (or perspective) of the SceneView is determined. Contains properties including the elevation, tilt, and heading (in degrees) of the current view. Setting the camera immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. The camera property contains an internal reference which may be modified in the future. To persist or modify the camera, create a clone using [camera.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) */ camera?: CameraProperties; /** - * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. The center property contains an internal reference which may be modified in the future. To persist or modify the center, create a clone using [center.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). + * Represents the view's center point; when setting the center you may pass a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or an array of numbers representing at longitude/latitude pair (`[-100.4593, 36.9014]`). Setting the center immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. The center property contains an internal reference which may be modified in the future. To persist or modify the center, create a clone using [center.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) */ center?: PointProperties | number[]; /** * Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. If defined, only data (including the basemap) within the area will be displayed. The `clippingArea` property only applies to [local](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) scenes. ![scene-clipping-area](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-clipping-area.png%20%22Local%20scene%20with%20clippingArea%22) The clippingArea property contains an internal reference which may be modified in the future. To persist or modify the clippingArea, create a clone using [clippingArea.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) */ clippingArea?: ExtentProperties; /** * Specifies constraints for [Camera tilt](esri-Camera.html#tilt) and altitude that may be applied to the SceneView. See the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ constraints?: SceneViewConstraintsProperties; /** - * Specifies various properties of the environment's visualization in the view. The SceneView will redraw automatically when any property of environment changes. + * Specifies various properties of the environment's visualization in the view. The SceneView will redraw automatically when any property of environment changes. * ```js * const view = new SceneView({ * map: map, * container: "viewDiv" * }); - * + * * // Set the sun position to reflect the current time * view.environment.lighting.date = Date.now(); - * + * * // Disable automatic lighting updates by camera tracking * view.environment.lighting.cameraTrackingEnabled = true; - * + * * // Set a background color * const view = new SceneView({ * container: "view", @@ -44265,72 +44265,72 @@ declare namespace __esri { * } * }); * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ environment?: SceneViewEnvironmentProperties; /** - * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Rather than using extent to change the visible portion of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a SceneView, you should use [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) since it easily allows you to define the heading, elevation and tilt of the observation point from which the view's perspective is created. When set in the constructor, this property overrides the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) or [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) are also set in the constructor. The extent property contains an internal reference which may be modified in the future. To persist or modify the extent, create a clone using [extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). + * The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html). Setting the extent immediately changes the view without animation. To animate the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). Rather than using extent to change the visible portion of the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) in a SceneView, you should use [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) since it easily allows you to define the heading, elevation and tilt of the observation point from which the view's perspective is created. When set in the constructor, this property overrides the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) or [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) are also set in the constructor. The extent property contains an internal reference which may be modified in the future. To persist or modify the extent, create a clone using [extent.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#clone). * > **Z-values** defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) - * + * * @default null */ extent?: ExtentProperties; /** * Options for configuring the highlight. Use the highlight method on the appropriate [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) to highlight a feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) */ highlightOptions?: SceneViewHighlightOptionsProperties; /** - * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. The `low` quality profile significantly increases performance on slower browsers and devices by reducing the memory limit and the visual quality in the following aspects: + * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. The `low` quality profile significantly increases performance on slower browsers and devices by reducing the memory limit and the visual quality in the following aspects: * * Map resolution * * Scene layer detail level * * Anti-aliasing (edge smoothing) - * - * - * The high and medium quality profiles only differ in the maximum amount of memory which the view is allowed to use. A higher memory limit improves quality in complex web scenes with many layers, but can have a negative impact on drawing performance and stability. The default value is based on the detected browser: + * + * + * The high and medium quality profiles only differ in the maximum amount of memory which the view is allowed to use. A higher memory limit improves quality in complex web scenes with many layers, but can have a negative impact on drawing performance and stability. The default value is based on the detected browser: * * `low` for Internet Explorer 11 and certain mobile devices * * `medium` for any other browser - * - * + * + * * Overriding the default value is best done in the constructor (see example below). If the value is modified after construction, only a subset of the quality aspects are affected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile) */ qualityProfile?: string; /** * Represents an approximation of the map scale at the center of the view. Setting the scale immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) property. This property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), or [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent) properties are also set in the constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) */ scale?: number; /** - * The viewing mode (`local` or `global`). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or [clipped](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) area. Users may also navigate the camera of a local scene below the surface of a basemap. - * + * The viewing mode (`local` or `global`). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or [clipped](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea) area. Users may also navigate the camera of a local scene below the surface of a basemap. + * * Value | Example | Description * ------|-------|------------ * global | ![scene-global](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-global.png) | Global scenes allow the entire globe to render in the view, showing the curvature of the earth. * local | ![scene-local](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-local.png) | Local scenes render the earth on a flat surface. They can be constrained to only show a "local" area by setting the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clipplingArea) property. Local scenes also allow for displaying and exploring data that would otherwise be hidden by the surface of the earth. - * + * * Depending on the viewing mode different [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) - * + * * @default global */ viewingMode?: string; /** * Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or point of observation on the view. In SceneViews, [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) should be used in favor of viewpoint for watching or changing the point of view. Setting the viewpoint immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). When set in the constructor, this property overrides the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center), [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale), and [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) properties. This property will be ignored if [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera) is also set in the constructor. The viewpoint property contains an internal reference which may be modified in the future. To persist or modify the viewpoint, create a clone using [viewpoint.clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html#clone). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint) */ viewpoint?: ViewpointProperties; /** * Represents the level of detail (LOD) at the center of the view. Setting the zoom immediately changes the current view. For animating the view, see [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo). Setting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) is a convenient way to set the initial extent of the view. If set in the constructor, this property will be ignored if the [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint), [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#camera), [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent), or [scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) properties are also set in the constructor. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) */ zoom?: number; @@ -44423,13 +44423,13 @@ declare namespace __esri { /** * Object specification for the result of the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ export interface SceneViewHitTestResult extends Object { /** * An array of result objects returned from the [hitTest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest). Results are returned when the location of the input screen coordinates intersect a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) in the view. See the table below for the specification of each object in this array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ results: SceneViewHitTestResultResults[]; @@ -44663,26 +44663,26 @@ declare namespace __esri { export interface SceneViewConstraintsProperties extends Object { /** - * Specifies a constraint on the minimum and maximum allowed camera altitude. - * + * Specifies a constraint on the minimum and maximum allowed camera altitude. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ altitude?: SceneViewConstraintsAltitudeProperties; /** * Specifies the near and far webgl clip distances. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ clipDistance?: SceneViewConstraintsClipDistanceProperties; /** * When enabled, prevents the user from navigating below the surface in a local SceneView. This property is deprecated, please use [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) instead. **Deprecated since version 4.8** - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ collision?: SceneViewConstraintsCollision; /** * Specifies a constraint on the amount of allowed tilting of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ tilt?: SceneViewConstraintsTiltProperties; @@ -44690,26 +44690,26 @@ declare namespace __esri { export interface SceneViewConstraints extends AnonymousAccessor { /** - * Specifies a constraint on the minimum and maximum allowed camera altitude. - * + * Specifies a constraint on the minimum and maximum allowed camera altitude. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ altitude?: SceneViewConstraintsAltitude; /** * Specifies the near and far webgl clip distances. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ clipDistance?: SceneViewConstraintsClipDistance; /** * When enabled, prevents the user from navigating below the surface in a local SceneView. This property is deprecated, please use [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#navigationConstraint) instead. **Deprecated since version 4.8** - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ collision?: SceneViewConstraintsCollision; /** * Specifies a constraint on the amount of allowed tilting of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ tilt?: SceneViewConstraintsTilt; @@ -44719,17 +44719,17 @@ declare namespace __esri { export interface SceneViewConstraintsAltitudeProperties extends Object { /** * The minimum allowed camera altitude (in meters). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default -∞ */ min?: number; /** * The maximum allowed camera altitude (in meters). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default EARTH_RADIUS * 4 */ max?: number; @@ -44738,17 +44738,17 @@ declare namespace __esri { export interface SceneViewConstraintsAltitude extends AnonymousAccessor { /** * The minimum allowed camera altitude (in meters). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default -∞ */ min?: number; /** * The maximum allowed camera altitude (in meters). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default EARTH_RADIUS * 4 */ max?: number; @@ -44758,21 +44758,21 @@ declare namespace __esri { export interface SceneViewConstraintsClipDistanceProperties extends Object { /** * The near clip distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ near?: number; /** * The far clip distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ far?: number; /** * Specifies the mode of the constraint which is either `auto` or `manual`. In `auto` mode, the near and far clip distance values are automatically determined. In `manual` mode, the near and far clip distance values are user defined, constant values. Note that the mode automatically changes to `manual` whenever the `near` or `far` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default auto */ mode?: string; @@ -44781,21 +44781,21 @@ declare namespace __esri { export interface SceneViewConstraintsClipDistance extends AnonymousAccessor { /** * The near clip distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ near?: number; /** * The far clip distance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ far?: number; /** * Specifies the mode of the constraint which is either `auto` or `manual`. In `auto` mode, the near and far clip distance values are automatically determined. In `manual` mode, the near and far clip distance values are user defined, constant values. Note that the mode automatically changes to `manual` whenever the `near` or `far` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default auto */ mode?: string; @@ -44805,9 +44805,9 @@ declare namespace __esri { export interface SceneViewConstraintsCollision extends Object { /** * Set to `false` to permit the user to navigate below the surface in a local SceneView. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default true */ enabled?: boolean; @@ -44817,15 +44817,15 @@ declare namespace __esri { export interface SceneViewConstraintsTiltProperties extends Object { /** * Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5 degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; /** * Specifies the mode of the constraint. There are two possible values: `auto` or `manual`. In `auto` mode, the maximum tilt value is automatically determined based on the altitude of the view camera. In `manual` mode, the maximum tilt value is a user defined, constant value. **Note:** The mode automatically changes to `manual` whenever the `max` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default auto */ mode?: string; @@ -44834,15 +44834,15 @@ declare namespace __esri { export interface SceneViewConstraintsTilt extends AnonymousAccessor { /** * Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5 degrees. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) */ max?: number; /** * Specifies the mode of the constraint. There are two possible values: `auto` or `manual`. In `auto` mode, the maximum tilt value is automatically determined based on the altitude of the view camera. In `manual` mode, the maximum tilt value is a user defined, constant value. **Note:** The mode automatically changes to `manual` whenever the `max` property is set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#constraints) - * + * * @default auto */ mode?: string; @@ -44852,33 +44852,33 @@ declare namespace __esri { export interface SceneViewEnvironmentProperties extends Object { /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. By default this is simply a single, fully opaque, black color. Currently [ColorBackground](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html) is the only type of background supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ background?: BackgroundProperties; /** * Lighting conditions of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ lighting?: SceneViewEnvironmentLightingProperties; /** * Indicates whether atmosphere visualization is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphereEnabled?: boolean; /** * Atmosphere conditions of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphere?: SceneViewEnvironmentAtmosphereProperties; /** * Indicates whether stars visualization is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default true */ starsEnabled?: boolean; @@ -44887,33 +44887,33 @@ declare namespace __esri { export interface SceneViewEnvironment extends AnonymousAccessor { /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. By default this is simply a single, fully opaque, black color. Currently [ColorBackground](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html) is the only type of background supported. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ background?: Background; /** * Lighting conditions of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ lighting?: SceneViewEnvironmentLighting; /** * Indicates whether atmosphere visualization is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphereEnabled?: boolean; /** * Atmosphere conditions of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) */ atmosphere?: SceneViewEnvironmentAtmosphere; /** * Indicates whether stars visualization is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default true */ starsEnabled?: boolean; @@ -44922,16 +44922,16 @@ declare namespace __esri { export interface SceneViewEnvironmentAtmosphereProperties extends Object { /** - * Indicates the quality of the atmosphere visualization. The quality of the atmosphere may have a significant impact on performance. This setting does not have any effect in [local scenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode). - * + * Indicates the quality of the atmosphere visualization. The quality of the atmosphere may have a significant impact on performance. This setting does not have any effect in [local scenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode). + * * Known Value | Example * ------------|--------- * low | ![scene-atmosphere](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-atmosphere.png) * high | ![scene-atmosphere](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-atmosphere-realistic.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default low */ quality?: string; @@ -44939,16 +44939,16 @@ declare namespace __esri { export interface SceneViewEnvironmentAtmosphere extends AnonymousAccessor { /** - * Indicates the quality of the atmosphere visualization. The quality of the atmosphere may have a significant impact on performance. This setting does not have any effect in [local scenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode). - * + * Indicates the quality of the atmosphere visualization. The quality of the atmosphere may have a significant impact on performance. This setting does not have any effect in [local scenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode). + * * Known Value | Example * ------------|--------- * low | ![scene-atmosphere](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-atmosphere.png) * high | ![scene-atmosphere](https://developers.arcgis.com/javascript/assets/img/apiref/views/scene-atmosphere-realistic.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default low */ quality?: string; @@ -44958,33 +44958,33 @@ declare namespace __esri { export interface SceneViewEnvironmentLightingProperties extends Object { /** * The current date and time of the simulated sun. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default new Date("March 15, 2015 12:00:00") */ date?: DateProperties; /** * Indicates whether to show shadows cast by the sun. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default false */ directShadowsEnabled?: boolean; /** * Indicates whether to show ambient occlusion shading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default false */ ambientOcclusionEnabled?: boolean; /** * Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default true */ cameraTrackingEnabled?: boolean; @@ -44993,33 +44993,33 @@ declare namespace __esri { export interface SceneViewEnvironmentLighting extends AnonymousAccessor { /** * The current date and time of the simulated sun. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default new Date("March 15, 2015 12:00:00") */ date?: Date; /** * Indicates whether to show shadows cast by the sun. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default false */ directShadowsEnabled?: boolean; /** * Indicates whether to show ambient occlusion shading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default false */ ambientOcclusionEnabled?: boolean; /** * Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of day while the camera changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) - * + * * @default true */ cameraTrackingEnabled?: boolean; @@ -45029,37 +45029,37 @@ declare namespace __esri { export interface SceneViewGoToOptions extends Object { /** * Indicates if the transition to the new view should be animated. If set to false, `speedFactor`, `duration`, `maxDuration`, and `easing` properties are ignored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) - * + * * @default true */ animate?: boolean; /** * Increases or decreases the animation speed by the specified factor. A speedFactor of 2 will make the animation twice as fast, while a speedFactor of 0.5 will make the animation half as fast. Setting the speed factor will automatically adapt the default maxDuration accordingly. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) - * + * * @default 1 */ speedFactor?: number; /** * Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ duration?: number; /** * The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) - * + * * @default 8000 */ maxDuration?: number; /** * The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: `linear`, `in-cubic`, `out-cubic`, `in-out-cubic`, `in-expo`, `out-expo`, `in-out-expo`, `in-out-coast-quadratic`. See [easing functions](https://easings.net/) for graphical representations of these functions. By default, animations that are less than 1000 ms use the `out-expo` easing function; longer animations use the `in-out-coast-quadratic` easing function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ easing?: string | EasingFunction; @@ -45069,43 +45069,43 @@ declare namespace __esri { export interface SceneViewGoToTarget extends Object { /** * The target of the animation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ target?: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | Camera; /** * The [SceneView.center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ center?: number[] | Point; /** * The [SceneView.scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ scale?: number; /** * The final [zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom) value to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ zoom?: number; /** * The [Camera.heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ heading?: number; /** * The [Camera.tilt](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ tilt?: number; /** * The [Camera.position](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position) to go to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) */ position?: Point; @@ -45115,25 +45115,25 @@ declare namespace __esri { export interface SceneViewHighlightOptionsProperties extends Object { /** * The color of the highlight. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default #00ffff */ color?: Color | number[] | string; /** * The opacity of the highlight halo. This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default 1 */ haloOpacity?: number; /** * The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default 0.25 */ fillOpacity?: number; @@ -45142,25 +45142,25 @@ declare namespace __esri { export interface SceneViewHighlightOptions extends AnonymousAccessor { /** * The color of the highlight. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default #00ffff */ color?: Color; /** * The opacity of the highlight halo. This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default 1 */ haloOpacity?: number; /** * The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in `color`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) - * + * * @default 0.25 */ fillOpacity?: number; @@ -45170,13 +45170,13 @@ declare namespace __esri { export interface SceneViewHitTestScreenPoint extends Object { /** * The horizontal screen coordinate of the click on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) */ x: number; /** * The vertical screen coordinate of the click on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) */ y: number; @@ -45186,35 +45186,35 @@ declare namespace __esri { export interface SceneViewTakeScreenshotOptions extends Object { /** * The format of the resulting encoded data url. **Possible values**: jpg | png. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) - * + * * @default jpg */ format?: string; /** * The quality (0 to 100) of the encoded image when encoding as `jpg`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) - * + * * @default 98 */ quality?: number; /** * The width of the screenshot (defaults to the area width). The height will be derived automatically if left unspecified, according to the aspect ratio of the of the screenshot area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ width?: number; /** * The height of the screenshot (defaults to the area height). The width will be derived automatically if left unspecified, according to the aspect ratio of the screenshot area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ height?: number; /** * Specifies whether to take a screenshot of a specific area of the view. The area coordinates are relative to the origin of the padded view (see [padding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#padding)) and will be clipped to the view size. Defaults to the whole view (padding excluded). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ area?: SceneViewTakeScreenshotOptionsArea; @@ -45224,25 +45224,25 @@ declare namespace __esri { export interface SceneViewTakeScreenshotOptionsArea extends Object { /** * The x coordinate of the area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ x?: number; /** * The y coordinate of the area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ y?: number; /** * The width of the area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ width?: number; /** * The height of the area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) */ height?: number; @@ -45252,13 +45252,13 @@ declare namespace __esri { export interface SceneViewToMapScreenPoint extends Object { /** * The horizontal screen coordinate to convert. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) */ x: number; /** * The vertical screen coordinate to convert. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#toMap) */ y: number; @@ -45266,19 +45266,19 @@ declare namespace __esri { /** * Object returned when [takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot) promise resolves: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ export interface Screenshot extends Object { /** * A data url representing the screenshot. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ dataUrl: string; /** * The raw RGBA image data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#Screenshot) */ data: ImageData; @@ -45296,13 +45296,13 @@ declare namespace __esri { export interface SceneViewHitTestResultResults extends Object { /** * A graphic present in the view that intersects the input screen coordinates. If the graphic comes from a layer with an applied [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html), then the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#symbol) property will be empty. Other properties will be empty based on the context in which the graphic is fetched. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ graphic: Graphic; /** * The point geometry in the spatial reference of the view corresponding with the input screen coordinates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult) */ mapPoint: Point; @@ -45310,9 +45310,9 @@ declare namespace __esri { interface DefaultUI extends UI { /** - * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. The default widgets differ between MapView and SceneView. The following are the default components in each view: **MapView:** `["attribution", "zoom"]` **SceneView:** `["attribution", "navigation-toggle", "compass", "zoom"]` + * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. The default widgets differ between MapView and SceneView. The following are the default components in each view: **MapView:** `["attribution", "zoom"]` **SceneView:** `["attribution", "navigation-toggle", "compass", "zoom"]` * > Esri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content. For detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation. For information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) */ components: string[]; @@ -45321,7 +45321,7 @@ declare namespace __esri { interface DefaultUIConstructor { /** * The DefaultUI class exposes the default [widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) [components](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) available in either a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This class also provides a simple API for [adding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#add), [moving](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#move) and [removing](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#remove) [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) and other HTML components from the view's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html) */ @@ -45332,9 +45332,9 @@ declare namespace __esri { interface DefaultUIProperties extends UIProperties { /** - * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. The default widgets differ between MapView and SceneView. The following are the default components in each view: **MapView:** `["attribution", "zoom"]` **SceneView:** `["attribution", "navigation-toggle", "compass", "zoom"]` + * An array of strings representing the default widgets visible when a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) is created. The default widgets differ between MapView and SceneView. The following are the default components in each view: **MapView:** `["attribution", "zoom"]` **SceneView:** `["attribution", "navigation-toggle", "compass", "zoom"]` * > Esri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content. For detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation. For information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html#components) */ components?: string[]; @@ -45343,42 +45343,42 @@ declare namespace __esri { interface UI extends Accessor { /** * The HTML Element that contains the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) */ container: HTMLElement; /** * The height of the UI container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#height) */ readonly height: number; /** * Defines the padding for the UI from the top, left, right, and bottom sides of the container or [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). If the value is a number, it will be used to pad all sides of the container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#padding) - * + * * @default { left: 15, top: 15, right: 15, bottom: 15 } */ padding: any | number; /** * The view associated with the UI components. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#view) */ view: MapView | SceneView; /** * The width of the UI container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#width) */ readonly width: number; /** * Adds one or more HTML component(s) or [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) to the UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) - * + * * @param component The component(s) to add to the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. Alternatively, you can pass an array of objects with the following specification. * @param component.component The component to add to the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID. * @param component.position The position in the view at which to add the component. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual @@ -45386,37 +45386,37 @@ declare namespace __esri { * @param position The position in the view at which to add the component. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual * @param position.position The position in the view at which to add the component(s). If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual * @param position.index The placement index of the component(s). This index shows where to place the component relative to other components. For example a value of `0` would place it topmost when position is top-*, leftmost for bottom-left and right most for bottom-right. - * + * */ add(component: Widget | HTMLElement | string | any[] | UIAddComponent, position?: string | UIAddPosition): void; /** * Removes all components from a given position. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#empty) - * + * * @param position The position from which to remove all components. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual - * + * */ empty(position?: string): void; /** * Moves one or more UI component(s) to the specified position. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) - * + * * @param component The component(s) to move. This value can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. Alternatively, you can pass an array of objects with the following specification. * @param component.component The component to move. This can be a widget instance, HTML element, a string value representing a DOM node ID. * @param component.position The destination position. The component will be placed in the UI [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) when not provided. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual * @param position The destination position. The component will be placed in the UI [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) when not provided. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual - * + * */ move(component: Widget | HTMLElement | string | any[] | UIMoveComponent, position?: string): void; /** * Removes one or more HTML component(s) or [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) from the UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#remove) - * + * * @param component The component(s) to remove from the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. - * + * */ remove(component: Widget | HTMLElement | string | any[]): void; } @@ -45424,7 +45424,7 @@ declare namespace __esri { interface UIConstructor { /** * This class provides a simple interface for [adding](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add), [moving](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) and [removing](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#remove) components from a view's user interface (UI). In most cases, you will work with the view's [DefaultUI](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-DefaultUI.html) which places default [widgets](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html), such as [Zoom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html) and [Attribution](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html) in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html) */ @@ -45436,21 +45436,21 @@ declare namespace __esri { interface UIProperties { /** * The HTML Element that contains the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) */ container?: HTMLElement; /** * Defines the padding for the UI from the top, left, right, and bottom sides of the container or [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). If the value is a number, it will be used to pad all sides of the container. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#padding) - * + * * @default { left: 15, top: 15, right: 15, bottom: 15 } */ padding?: any | number; /** * The view associated with the UI components. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -45460,19 +45460,19 @@ declare namespace __esri { export interface UIAddComponent extends Object { /** * The component to add to the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ component: Widget | HTMLElement | string; /** * The position in the view at which to add the component. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ position?: string; /** * The placement index of the component. This index shows where to place the component relative to other components. For example a value of `0` would place it topmost when position is top-*, leftmost for bottom-left and right most for bottom-right. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ index?: number; @@ -45482,13 +45482,13 @@ declare namespace __esri { export interface UIAddPosition extends Object { /** * The position in the view at which to add the component(s). If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ position?: string; /** * The placement index of the component(s). This index shows where to place the component relative to other components. For example a value of `0` would place it topmost when position is top-*, leftmost for bottom-left and right most for bottom-right. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#add) */ index: number; @@ -45498,13 +45498,13 @@ declare namespace __esri { export interface UIMoveComponent extends Object { /** * The component to move. This can be a widget instance, HTML element, a string value representing a DOM node ID. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ component: Widget | HTMLElement | string; /** * The destination position. The component will be placed in the UI [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#container) when not provided. If not specified, `manual` is used by default. **Possible Values:** top-left | top-right | bottom-left | bottom-right | manual - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ui-UI.html#move) */ position?: string; @@ -45513,134 +45513,134 @@ declare namespace __esri { interface View extends Accessor, corePromise, DOMContainer { /** * Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) related to the basemap, operational layers, and group layers in this view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#allLayerViews) */ allLayerViews: Collection; /** * Represents an ongoing view animation initialized by [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). You may [watch](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#watch) this property to be notified when the view's extent changes . - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#animation) */ animation: ViewAnimation; /** * Allows for adding [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) directly to the default graphics in the View. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) */ graphics: Collection; /** * The view for the ground of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#groundView) */ readonly groundView: GroundView; /** * Options to configure input handling of the View. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#input) */ readonly input: Input; /** * Indication whether the view is being interacted with (for example when panning). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#interacting) - * + * * @default false */ readonly interacting: boolean; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#layerViews) */ layerViews: Collection; /** * An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view. A view may only display one map at a time. On the other hand, one [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) may be viewed by multiple [MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and/or [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) simultaneously. This property is typically set in the constructor of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [class description](#) for examples demonstrating the relationship between the map and the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) */ map: Map; /** * Options to configure the navigation behavior of the View. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#navigation) */ readonly navigation: Navigation; /** * Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center), and [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc. work off a subsection of the full view. This is particularly useful when layering UI elements or semi-transparent content on top of portions of the view. See the [view padding sample](https://developers.arcgis.com/javascript/latest/sample-code/view-padding/index.html) for an example of how this works. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) - * + * * @default {left: 0, top: 0, right: 0, bottom: 0} */ padding: ViewPadding; /** - * When `true`, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met. + * When `true`, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met. * * The view has a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map). If [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) is a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) or a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html), then the map or scene must be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loaded). * * The view has a [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#container) with a size greater than `0`. * * The view has a [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference). - * - * + * + * * When a view becomes ready it will resolve itself and invoke the callback defined in [when()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#when) where code can execute on a working view. Subsequent changes to a view's readiness would typically be handled by watching `view.ready` and providing logic for cases where the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) or [container](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#container) change. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ready) - * + * * @default false */ readonly ready: boolean; /** * Represents the current value of one pixel in the unit of the view's [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference). The value of resolution is calculated by dividing the view's [extent width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width) by [its width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#width). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#resolution) */ readonly resolution: number; /** - * The spatial reference of the view. This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. The spatial reference can either be set explicitly or automatically derived from the following: + * The spatial reference of the view. This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. The spatial reference can either be set explicitly or automatically derived from the following: * * In the case of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), if the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map) is a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) instance, the [WebScene.initialViewProperties.spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) is used. * * In all other cases, the spatial reference is derived from the first layer that loads in this order: * * [map.basemap.baseLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) * * [map.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) * * [map.ground.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) - * - * + * + * * When using an [Esri basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap), the default spatial reference is Web Mercator Auxiliary Sphere. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) - * + * * @default null */ spatialReference: SpatialReference; /** * Indication whether the view is animating, being interacted with or resizing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#stationary) - * + * * @default true */ readonly stationary: boolean; /** * The type of the view is either `2d` (indicating a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)) or `3d` (indicating a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#type) */ readonly type: string; /** * Indicates whether the view is being updated by additional data requests to the network, or by processing received data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#updating) - * + * * @default false */ readonly updating: boolean; /** * Gets the [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created on the view for the given layer. The returned promise resolves when the layer view for the given layer has been created, or rejects with an error (for example if the layer is not part of the view, or if the layer type is not supported in this view). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView) - * + * * @param layer The layer for which to obtain its LayerView. - * + * */ whenLayerView(layer: Layer): IPromise; } @@ -45648,7 +45648,7 @@ declare namespace __esri { interface ViewConstructor { /** * A view provides the means of viewing and interacting with the components of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html). The [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) is merely a container, storing the geographic information contained in base layers and operational layers. The View renders the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) and its various [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers), making them visible to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) */ @@ -45660,55 +45660,55 @@ declare namespace __esri { interface ViewProperties extends DOMContainerProperties { /** * Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) related to the basemap, operational layers, and group layers in this view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#allLayerViews) */ allLayerViews?: CollectionProperties; /** * Represents an ongoing view animation initialized by [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo). You may [watch](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#watch) this property to be notified when the view's extent changes . - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#animation) */ animation?: ViewAnimationProperties; /** * Allows for adding [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) directly to the default graphics in the View. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) */ graphics?: CollectionProperties; /** * A collection containing a hierarchical list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#layerViews) */ layerViews?: CollectionProperties; /** * An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view. A view may only display one map at a time. On the other hand, one [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) may be viewed by multiple [MapViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and/or [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) simultaneously. This property is typically set in the constructor of the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). See the [class description](#) for examples demonstrating the relationship between the map and the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) */ map?: MapProperties; /** * Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center), and [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc. work off a subsection of the full view. This is particularly useful when layering UI elements or semi-transparent content on top of portions of the view. See the [view padding sample](https://developers.arcgis.com/javascript/latest/sample-code/view-padding/index.html) for an example of how this works. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) - * + * * @default {left: 0, top: 0, right: 0, bottom: 0} */ padding?: ViewPadding; /** - * The spatial reference of the view. This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. The spatial reference can either be set explicitly or automatically derived from the following: + * The spatial reference of the view. This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. The spatial reference can either be set explicitly or automatically derived from the following: * * In the case of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), if the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map) is a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) instance, the [WebScene.initialViewProperties.spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) is used. * * In all other cases, the spatial reference is derived from the first layer that loads in this order: * * [map.basemap.baseLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) * * [map.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) * * [map.ground.layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) - * - * + * + * * When using an [Esri basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap), the default spatial reference is Web Mercator Auxiliary Sphere. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) - * + * * @default null */ spatialReference?: SpatialReferenceProperties; @@ -45718,25 +45718,25 @@ declare namespace __esri { export interface ViewPadding extends Object { /** * The left padding (in pixels). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ left?: number; /** * The top padding (in pixels). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ top?: number; /** * The right padding (in pixels). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ right?: number; /** * The bottom padding (in pixels). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding) */ bottom?: number; @@ -45745,33 +45745,33 @@ declare namespace __esri { interface ViewAnimation extends Accessor, corePromise { /** * The state of the animation. The animation terminates when the state is either `finished` or `stopped` and cannot transition again to `running`. The `finished` state indicates the animation has successfully ended, while the `stopped` state indicates that the animation was interrupted before it reached its final target. **Possible Values:** running | finished | stopped - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#state) - * + * * @default running */ readonly state: string; /** * The target of the animation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#target) */ target: Viewpoint; /** * Finishes the view animation by immediately going to the target and sets the state of the animation to `finished`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#finish) - * - * + * + * */ finish(): void; /** * Stops the view animation at its current state and sets the state of the animation to `stopped`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#stop) - * - * + * + * */ stop(): void; } @@ -45779,7 +45779,7 @@ declare namespace __esri { interface ViewAnimationConstructor { /** * Contains a [state](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#state) property used for checking the state of the animation. The view animation is resolved when the animation has `finished` and is rejected if it is `stopped`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html) */ @@ -45791,7 +45791,7 @@ declare namespace __esri { interface ViewAnimationProperties { /** * The target of the animation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-ViewAnimation.html#target) */ target?: ViewpointProperties; @@ -45800,99 +45800,99 @@ declare namespace __esri { interface WebMap extends Map, corePromise { /** * Object responsible for containing the viewing and editing properties of the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#applicationProperties) */ applicationProperties: any; /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) */ bookmarks: Collection; /** * The initial view of the WebMap. This object contains properties such as [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference), that should be applied to the view when the WebMap loads. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#initialViewProperties) */ initialViewProperties: InitialViewProperties; /** * Indicates whether the instance has loaded. When `true`, the properties of the object can be accessed. A WebMap is considered loaded when its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#layers) and [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#basemap) are created, but not yet loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadError) - * + * * @default null */ readonly loadError: Error; /** - * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#load) operation. - * + * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#load) operation. + * * Value | Description * ------|------------ * not-loaded | The object's resources have not loaded. * loading | The object's resources are currently loading. * loaded | The object's resources have loaded without errors. * failed | The object's resources failed to load. See [loadError](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadError) for more details. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadStatus) - * + * * @default not-loaded */ readonly loadStatus: string; /** * The portal item from which the WebMap is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#portalItem) */ portalItem: PortalItem; /** * Provides multiple slides. Each slide has a different "title", "extent", "basemap", "layers" etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#presentation) */ presentation: any; /** * The version of the source document from which the WebMap was read. The WebMap must be version 2.x to load into an app. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ readonly sourceVersion: WebMapSourceVersion; /** * An array of table objects in the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#tables) */ tables: any[]; /** * The widgets object contains widgets that should be exposed to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#widgets) */ widgets: any; /** * Triggers the loading of the WebMap instance. A WebMap is considered [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded) when its [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#layers) and [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#basemap) are fully created. When created with a [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#portalItem), `load()` will first fetch its data to create the content, otherwise it resolves immediately. The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) automatically calls the `load()` method when a WebMap instance is added to its [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#map) property so it can display in the view and load each individual layer. If the WebMap is used outside of a view, for example to preload it, you must call `load()` explicitly to interact with its resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#load) - * - * + * + * */ load(): IPromise; /** * Loads all the externally loadable resources associated with the webmap. For the webmap this will load the ground, basemap and layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loadAll) - * - * + * + * */ loadAll(): IPromise; } @@ -45900,7 +45900,7 @@ declare namespace __esri { interface WebMapConstructor { /** * Loads a [WebMap](https://doc.arcgis.com/en/arcgis-online/create-maps/make-your-first-map.htm) from [ArcGIS Online](https://www.arcgis.com/home/) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) */ @@ -45912,43 +45912,43 @@ declare namespace __esri { interface WebMapProperties extends MapProperties { /** * Object responsible for containing the viewing and editing properties of the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#applicationProperties) */ applicationProperties?: any; /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) */ bookmarks?: CollectionProperties; /** * The initial view of the WebMap. This object contains properties such as [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference), that should be applied to the view when the WebMap loads. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#initialViewProperties) */ initialViewProperties?: InitialViewPropertiesProperties; /** * The portal item from which the WebMap is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#portalItem) */ portalItem?: PortalItemProperties; /** * Provides multiple slides. Each slide has a different "title", "extent", "basemap", "layers" etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#presentation) */ presentation?: any; /** * An array of table objects in the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#tables) */ tables?: any[]; /** * The widgets object contains widgets that should be exposed to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#widgets) */ widgets?: any; @@ -45957,19 +45957,19 @@ declare namespace __esri { interface Bookmark extends Accessor { /** * The extent of the specified bookmark item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#extent) */ extent: Extent; /** * The name of the bookmark item. Used as a label in the [Bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#name) */ name: string; /** * The URL for a thumbnail image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ thumbnail: BookmarkThumbnail; @@ -45986,19 +45986,19 @@ declare namespace __esri { interface BookmarkProperties { /** * The extent of the specified bookmark item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#extent) */ extent?: ExtentProperties; /** * The name of the bookmark item. Used as a label in the [Bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#name) */ name?: string; /** * The URL for a thumbnail image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ thumbnail?: BookmarkThumbnail; @@ -46008,7 +46008,7 @@ declare namespace __esri { export interface BookmarkThumbnail extends Object { /** * URL to a thumbnail to display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html#thumbnail) */ url?: string; @@ -46017,23 +46017,23 @@ declare namespace __esri { interface InitialViewProperties extends Accessor, corePromise { /** * The spatial reference of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference) */ spatialReference: SpatialReference; /** * The initial viewpoint of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint) */ viewpoint: Viewpoint; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#clone) - * - * + * + * */ clone(): InitialViewProperties; } @@ -46049,13 +46049,13 @@ declare namespace __esri { interface InitialViewPropertiesProperties { /** * The spatial reference of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The initial viewpoint of the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-InitialViewProperties.html#viewpoint) */ viewpoint?: ViewpointProperties; @@ -46065,13 +46065,13 @@ declare namespace __esri { export interface WebMapSourceVersion extends Object { /** * The major version of the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ major: number; /** * The minor version of the WebMap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#sourceVersion) */ minor: number; @@ -46080,151 +46080,151 @@ declare namespace __esri { interface WebScene extends Map, corePromise { /** * Configuration of application and UI elements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#applicationProperties) */ applicationProperties: ApplicationProperties; /** * *This property only applies to local scenes.* Represents an optional clipping area used to define the bounds or [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. If defined, only data (including the basemap) within the area will be displayed. Set the [clippingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) property to `true` to apply the specified clippingArea to the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) */ clippingArea: Extent; /** * *This property only applies to local scenes.* Determines whether clipping using the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) - * + * * @default false */ clippingEnabled: boolean; /** * The height model info of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). This object defines the characteristics of the vertical coordinate system used by the scene. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), the height model info is used to avoid combining layers that have incompatible vertical coordinate systems. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#heightModelInfo) */ heightModelInfo: HeightModelInfo; /** * The initial view of the WebScene. This object contains properties such as [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference), [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode), and [environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) that should be applied to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the scene loads. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) */ initialViewProperties: websceneInitialViewProperties; /** * Indicates whether the instance has loaded. When `true`, the properties of the object can be accessed. A WebScene is considered loaded when its [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) and [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#basemap) are fully created, but not yet loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loaded) - * + * * @default false */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadError) - * + * * @default null */ readonly loadError: Error; /** - * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) operation. - * + * Represents the status of a [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) operation. + * * Value | Description * ------|------------ * not-loaded | The object's resources have not loaded. * loading | The object's resources are currently loading. * loaded | The object's resources have loaded without errors. * failed | The object's resources failed to load. See [loadError](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadError) for more details. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadStatus) - * + * * @default not-loaded */ readonly loadStatus: string; /** * The portal item from which the WebScene is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#portalItem) */ portalItem: PortalItem; /** * Provides a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of slides that act as bookmarks for saving predefined [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) and visible layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation) */ presentation: Presentation; /** * The version of the source document from which the WebScene was read. The WebScene must be version 1.x to load into an app. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ readonly sourceVersion: WebSceneSourceVersion; /** * The URL to the thumbnail used for the web scene. The thumbnail will by default be the thumbnail URL from the portal item associated to the web scene. The thumbnail of the web scene may be updated by changing the thumbnail URL and saving the web scene. Use #updateFrom to update the thumbnail automatically from a specified view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#thumbnailUrl) */ thumbnailUrl: string; /** * Triggers the loading of the WebScene instance. A WebScene is considered [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loaded) when its [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers), [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#basemap) and [ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#ground) are fully created. When created with a [portalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#portalItem), `load()` will first fetch its data to create the content, otherwise it resolves immediately. The [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) automatically calls the `load()` method when a WebScene instance is added to its [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map) property so it can display in the view and load each individual layer. If the WebScene is used outside of a view, for example to preload it, you must call `load()` explicitly to interact with its resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) - * - * + * + * */ load(): IPromise; /** * Loads all the externally loadable resources associated with the webscene. For the webscene this will load the ground, basemap, layers and slide basemaps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#loadAll) - * - * + * + * */ loadAll(): IPromise; /** * Saves the webscene to its associated portal item. The portal item to save to must already exist and be valid. This is a convenience method that will use [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#update) to store the webscene in the item. The web scene is saved according to [web scene specification](https://developers.arcgis.com/web-scene-specification/) standards. Use [updateFrom](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) to store the current view properties in the webscene before saving it. Note that this saves the webscene to its existing item. Depending on how the scene is shared, users that do not own the scene may modify it. To save an existing scene as a new item owned by the user signed into the portal instance, use [saveAs()](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs). The webscene will be automatically loaded if it is not already before saving. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) - * + * * @param options Additional options. * @param options.ignoreUnsupported When `true`, the scene will save even if it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item. - * + * */ save(options?: WebSceneSaveOptions): IPromise; /** * Saves the webscene to a new portal item. If saving has completed successfully, then the saved portal item will be set in the portalItem property of the WebScene. This is a convenience method that will create a new [PortalItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html) and use [PortalUser.addItem()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#addItem) to store the webscene in a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html). Use [updateFrom](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) to store the current view properties in the webscene before saving it. Note that this always saves the webscene as a new portal item owned by the user performing the edits and executing the `saveAs()` method. If you want to modify the existing item without changing its ownership use [save()](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save). The webscene will be automatically loaded if it is not already before saving. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) - * + * * @param portalItem The new portal item to which the scene will be saved. Portal item properties such as the title or description need to be explicitly set on the item and will not be automatically copied from the current associated scene portal item (if any). * @param options additional save options. * @param options.folder the folder in which to save the item. * @param options.ignoreUnsupported allow the scene to be saved even in the case it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item. - * + * */ saveAs(portalItem: PortalItem | PortalItemProperties, options?: WebSceneSaveAsOptions): IPromise; /** * Converts an instance of [this class]() to its ArcGIS portal JSON representation. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide and the [web scene specification](https://developers.arcgis.com/web-scene-specification/) for more information. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#toJSON) - * - * + * + * */ toJSON(): any; /** * Update properties of the WebScene related to the view. This should usually be called just before saving a scene. The following properties are updated from the view: 1. `initialViewProperties.spatialReference` 2. `initialViewProperties.viewingMode` 3. `clippingArea` 4. `heightModelInfo` Depending on the provided options, the following properties are also updated: 1. `initialViewProperties.environment` 2. `initialViewProperties.viewpoint` 3. `thumbnail` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) - * + * * @param view the view to update from. * @param options update options. * @param options.environmentExcluded do not update the initial environment from the view, defaults to false. * @param options.viewpointExcluded do not update the initial viewpoint from the view, defaults to false. * @param options.thumbnailExcluded do not update the thumbnail from the view, defaults to viewpointExcluded. * @param options.thumbnailSize the size of the thumbnail. Defaults to 600x400 (ratio 1.5:1). Note that the thumbnail size may currently not be larger than the size of the view. - * + * */ updateFrom(view: SceneView, options?: WebSceneUpdateFromOptions): IPromise; } @@ -46232,7 +46232,7 @@ declare namespace __esri { interface WebSceneConstructor { /** * The web scene is the core element of 3D mapping across the ArcGIS platform. It defines the content, style, environment, and slides of your scene and it can be shared across multiple ArcGIS web and desktop applications. Web scenes can be created, published, and consumed in [ArcGIS Pro](http://pro.arcgis.com/en/pro-app/help/mapping/map-authoring/author-a-web-scene.htm) and ArcGIS Online with the [Scene Viewer](http://server.arcgis.com/en/portal/latest/use/make-your-first-scene.htm). The web scene is saved as a JSON document that can be consumed by the ArcGIS API for JavaScript via the WebScene class to easily create compelling 3D applications. The JSON document is written according to the [web scene specification](https://developers.arcgis.com/web-scene-specification/). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) */ @@ -46241,11 +46241,11 @@ declare namespace __esri { /** * Creates a new instance of [this class]() and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input `json` parameter often comes from a response to a query operation in the REST API or a [toJSON()](http://pro.arcgis.com/en/pro-app/tool-reference/conversion/features-to-json.htm) method from another ArcGIS product. If the [WebScene]() is used outside of a view, you must call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#load) explicitly to interact with its resources. See the [Using fromJSON()](https://developers.arcgis.com/javascript/latest/guide/using-fromjson/index.html) topic in the Guide for details and examples of when and how to use this function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#fromJSON) - * + * * @param json A JSON representation of the instance in the ArcGIS format. See the [web scene specification](https://developers.arcgis.com/web-scene-specification/) for more detailed information on serializing web scenes to JSON. - * + * */ fromJSON(json: any): any; } @@ -46255,51 +46255,51 @@ declare namespace __esri { interface WebSceneProperties extends MapProperties { /** * Configuration of application and UI elements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#applicationProperties) */ applicationProperties?: ApplicationPropertiesProperties; /** * *This property only applies to local scenes.* Represents an optional clipping area used to define the bounds or [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of a local scene. If defined, only data (including the basemap) within the area will be displayed. Set the [clippingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) property to `true` to apply the specified clippingArea to the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) */ clippingArea?: ExtentProperties; /** * *This property only applies to local scenes.* Determines whether clipping using the [clippingArea](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingArea) is enabled. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#clippingEnabled) - * + * * @default false */ clippingEnabled?: boolean; /** * The height model info of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). This object defines the characteristics of the vertical coordinate system used by the scene. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), the height model info is used to avoid combining layers that have incompatible vertical coordinate systems. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#heightModelInfo) */ heightModelInfo?: HeightModelInfoProperties; /** * The initial view of the WebScene. This object contains properties such as [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint), [spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference), [viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode), and [environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) that should be applied to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the scene loads. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#initialViewProperties) */ initialViewProperties?: websceneInitialViewPropertiesProperties; /** * The portal item from which the WebScene is loaded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#portalItem) */ portalItem?: PortalItemProperties; /** * Provides a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of slides that act as bookmarks for saving predefined [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) and visible layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation) */ presentation?: PresentationProperties; /** * The URL to the thumbnail used for the web scene. The thumbnail will by default be the thumbnail URL from the portal item associated to the web scene. The thumbnail of the web scene may be updated by changing the thumbnail URL and saving the web scene. Use #updateFrom to update the thumbnail automatically from a specified view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#thumbnailUrl) */ thumbnailUrl?: string; @@ -46308,17 +46308,17 @@ declare namespace __esri { interface ApplicationProperties extends Accessor { /** * View-specific properties of application and UI elements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#viewing) */ viewing: Viewing; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#clone) - * - * + * + * */ clone(): ApplicationProperties; } @@ -46334,7 +46334,7 @@ declare namespace __esri { interface ApplicationPropertiesProperties { /** * View-specific properties of application and UI elements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-ApplicationProperties.html#viewing) */ viewing?: ViewingProperties; @@ -46343,29 +46343,29 @@ declare namespace __esri { interface Search extends Accessor { /** * Whether search functionality is enabled in the web scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#enabled) */ enabled: boolean; /** * The hint provided with the search dialog. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#hintText) */ hintText: string; /** * A collection of layers to be included in search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#layers) */ layers: Collection; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#clone) - * - * + * + * */ clone(): Search; } @@ -46381,19 +46381,19 @@ declare namespace __esri { interface SearchProperties { /** * Whether search functionality is enabled in the web scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#enabled) */ enabled?: boolean; /** * The hint provided with the search dialog. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#hintText) */ hintText?: string; /** * A collection of layers to be included in search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Search.html#layers) */ layers?: CollectionProperties; @@ -46402,29 +46402,29 @@ declare namespace __esri { interface SearchLayer extends Accessor { /** * The field to use for search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#field) */ field: SearchLayerField; /** * The id of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#id) */ id: string; /** * The sub layer index. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#subLayer) */ subLayer: number; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#clone) - * - * + * + * */ clone(): SearchLayer; } @@ -46440,19 +46440,19 @@ declare namespace __esri { interface SearchLayerProperties { /** * The field to use for search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#field) */ field?: SearchLayerFieldProperties; /** * The id of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#id) */ id?: string; /** * The sub layer index. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayer.html#subLayer) */ subLayer?: number; @@ -46461,29 +46461,29 @@ declare namespace __esri { interface SearchLayerField extends Accessor { /** * Whether or not the field is an exact match. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#exactMatch) */ exactMatch: boolean; /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#name) */ name: string; /** * The data type of the field. **Possible Values:** small-integer | integer | single | double | long | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#type) */ type: string; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#clone) - * - * + * + * */ clone(): SearchLayerField; } @@ -46499,19 +46499,19 @@ declare namespace __esri { interface SearchLayerFieldProperties { /** * Whether or not the field is an exact match. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#exactMatch) */ exactMatch?: boolean; /** * The name of the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#name) */ name?: string; /** * The data type of the field. **Possible Values:** small-integer | integer | single | double | long | string | date | oid | geometry | blob | raster | guid | global-id | xml - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-SearchLayerField.html#type) */ type?: string; @@ -46520,17 +46520,17 @@ declare namespace __esri { interface Viewing extends Accessor { /** * An object specifying the search parameters set within the web scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Viewing.html#search) */ search: Search; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Viewing.html#clone) - * - * + * + * */ clone(): Viewing; } @@ -46546,7 +46546,7 @@ declare namespace __esri { interface ViewingProperties { /** * An object specifying the search parameters set within the web scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-applicationProperties-Viewing.html#search) */ search?: SearchProperties; @@ -46555,10 +46555,10 @@ declare namespace __esri { interface Background extends Accessor, JSONSupport { /** * Creates a deep clone of the Background. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html#clone) - * - * + * + * */ clone(): Background; } @@ -46566,7 +46566,7 @@ declare namespace __esri { interface BackgroundConstructor { /** * The background of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) that lies behind the sky, atmosphere and stars. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html) */ @@ -46584,19 +46584,19 @@ declare namespace __esri { interface ColorBackground extends Background, JSONSupport { /** * The color of the background. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#color) - * + * * @default black */ color: Color; /** * Creates a deep clone of the object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#clone) - * - * + * + * */ clone(): ColorBackground; } @@ -46604,7 +46604,7 @@ declare namespace __esri { interface ColorBackgroundConstructor { /** * This type of [Background](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-Background.html) allows to set a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) as the background of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). The view environment stars and atmosphere will show on top of the background when enabled. To have a clear background color only, make sure to set both the [view.environment.starsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) and [view.environment.atmosphereEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment) properties to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html) */ @@ -46618,9 +46618,9 @@ declare namespace __esri { interface ColorBackgroundProperties extends BackgroundProperties { /** * The color of the background. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with `r`, `g`, `b`, and `a` properties, or a [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-background-ColorBackground.html#color) - * + * * @default black */ color?: Color | number[] | string; @@ -46629,41 +46629,41 @@ declare namespace __esri { interface Environment extends Accessor { /** * Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#atmosphereEnabled) - * + * * @default true */ atmosphereEnabled: boolean; /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. The default value of `null` displays a single, fully opaque, black color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#background) - * + * * @default null */ background: Background; /** * Settings for defining the lighting of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#lighting) */ lighting: Lighting; /** * Specifies whether stars should be displayed in the sky. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#starsEnabled) - * + * * @default true */ starsEnabled: boolean; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#clone) - * - * + * + * */ clone(): Environment; } @@ -46679,31 +46679,31 @@ declare namespace __esri { interface EnvironmentProperties { /** * Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#atmosphereEnabled) - * + * * @default true */ atmosphereEnabled?: boolean; /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. The default value of `null` displays a single, fully opaque, black color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#background) - * + * * @default null */ background?: BackgroundProperties; /** * Settings for defining the lighting of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#lighting) */ lighting?: LightingProperties; /** * Specifies whether stars should be displayed in the sky. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Environment.html#starsEnabled) - * + * * @default true */ starsEnabled?: boolean; @@ -46712,37 +46712,37 @@ declare namespace __esri { interface websceneInitialViewProperties extends Accessor, corePromise { /** * The initial environment settings of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) */ environment: Environment; /** * The spatial reference of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference) */ spatialReference: SpatialReference; /** * The viewing mode of the scene. Global scenes allow the user to navigate the globe. Local scenes allow for navigation and feature display in a particular "localized" area. Users may also navigate the view's camera below the surface of a basemap in local scenes. **Possible Values:** global | local - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode) - * + * * @default global */ viewingMode: string; /** * The initial viewpoint of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint) */ viewpoint: Viewpoint; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#clone) - * - * + * + * */ clone(): websceneInitialViewProperties; } @@ -46758,27 +46758,27 @@ declare namespace __esri { interface websceneInitialViewPropertiesProperties { /** * The initial environment settings of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#environment) */ environment?: EnvironmentProperties; /** * The spatial reference of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). This indicates the [Projected Coordinate System](https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm) or the [Geographic Coordinate System](https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm) used to locate geographic features in the map. In a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) the following [supported coordinate systems](esri-views-SceneView.html#supported-coordinate-systems) are available. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#spatialReference) */ spatialReference?: SpatialReferenceProperties; /** * The viewing mode of the scene. Global scenes allow the user to navigate the globe. Local scenes allow for navigation and feature display in a particular "localized" area. Users may also navigate the view's camera below the surface of a basemap in local scenes. **Possible Values:** global | local - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode) - * + * * @default global */ viewingMode?: string; /** * The initial viewpoint of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewpoint) */ viewpoint?: ViewpointProperties; @@ -46787,35 +46787,35 @@ declare namespace __esri { interface Lighting extends Accessor, corePromise { /** * The time and date for which the sun position and light direction is computed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#date) - * + * * @default null */ date: Date; /** * Indicates whether to show shadows cast by the sun. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#directShadowsEnabled) - * + * * @default false */ directShadowsEnabled: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. This value does not have an impact on the actual lighting of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#displayUTCOffset) - * + * * @default null */ displayUTCOffset: number; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#clone) - * - * + * + * */ clone(): Lighting; } @@ -46831,25 +46831,25 @@ declare namespace __esri { interface LightingProperties { /** * The time and date for which the sun position and light direction is computed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#date) - * + * * @default null */ date?: DateProperties; /** * Indicates whether to show shadows cast by the sun. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#directShadowsEnabled) - * + * * @default false */ directShadowsEnabled?: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. This value does not have an impact on the actual lighting of the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Lighting.html#displayUTCOffset) - * + * * @default null */ displayUTCOffset?: number; @@ -46858,17 +46858,17 @@ declare namespace __esri { interface Presentation extends Accessor { /** * A collection of [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) that bookmark [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), visible layers, and other settings previously defined in a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) */ slides: Collection; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#clone) - * - * + * + * */ clone(): Presentation; } @@ -46884,7 +46884,7 @@ declare namespace __esri { interface PresentationProperties { /** * A collection of [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) that bookmark [viewpoints](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), visible layers, and other settings previously defined in a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) */ slides?: CollectionProperties; @@ -46892,8 +46892,8 @@ declare namespace __esri { interface Slide extends Accessor { /** - * The basemap of the scene. Only the [base](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) layers of the basemap are stored in a slide. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. - * + * The basemap of the scene. Only the [base](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) layers of the basemap are stored in a slide. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. + * * Value | Description * ------|------------ * streets | ![basemap-streets](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets.jpg) @@ -46906,70 +46906,70 @@ declare namespace __esri { * national-geographic | ![basemap-national-geographic](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/national-geographic.jpg) * terrain | ![basemap-terrain](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/terrain.jpg) * osm | ![basemap-osm](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/osm.jpg) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap) */ basemap: Basemap; /** * The description of the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ description: SlideDescription; /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ environment: Environment; /** * Ground properties for this slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ ground: SlideGround; /** * The unique id of a slide within the [slides property](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) of a [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#id) */ id: string; /** * A data URI encoded thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ thumbnail: SlideThumbnail; /** * The title of the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ title: SlideTitle; /** * The viewpoint of the slide. This acts like a bookmark, saving a predefined location or point of view from which to view the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) */ viewpoint: Viewpoint; /** - * The visible layers of the scene. This is a collection of objects that stores references (by ID) to the [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) and [ground layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that are set as `visible` when a slide is applied to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When assigning visible layers, the following types of values will be automatically casted: + * The visible layers of the scene. This is a collection of objects that stores references (by ID) to the [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) and [ground layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that are set as `visible` when a slide is applied to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When assigning visible layers, the following types of values will be automatically casted: * * Array (or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)) of [Layer instances](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html): `[layerInstance, layerInstance]` * * Array (or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)) of [Layer IDs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id): `["layer-1", "layer-2"]` - * - * + * + * * The specification for each object in the collection is outlined in the table below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ visibleLayers: Collection; /** * Applies a slide's settings to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) - * + * * @param view The SceneView the slide should be applied to. * @param options Animation options. See properties below for object specifications. * @param options.animate Indicates whether to animate the slide transition. @@ -46977,26 +46977,26 @@ declare namespace __esri { * @param options.duration Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration. * @param options.maxDuration The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. * @param options.easing The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: `linear`, `in-cubic`, `out-cubic`, `in-out-cubic`, `in-expo`, `out-expo`, `in-out-expo` By default, animations that are less than 1000 ms use an out easing function; longer animations use an in-out function. - * + * */ applyTo(view: SceneView, options?: SlideApplyToOptions): IPromise; /** * Creates a deep clone of this object. Note that the basemap instance is cloned, but the layers within the basemap are copied. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#clone) - * - * + * + * */ clone(): Slide; /** * Updates a slide from a [WebScene's slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides). Updating the slide is asynchronous and a snapshot of the view is only complete once the returned promise has resolved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) - * + * * @param view The SceneView from which the slide should update. * @param options Update options. See properties below for object specifications. * @param options.screenshot Screenshot options to use. See properties below for object specifications. - * + * */ updateFrom(view: SceneView, options?: SlideUpdateFromOptions): IPromise; } @@ -47004,7 +47004,7 @@ declare namespace __esri { interface SlideConstructor { /** * A slide stores a snapshot of several pre-set properties of the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) and [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), such as the [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap), [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) and [visible layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers). The [visible layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) may contain references (by [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id)) to both operational layers from the [scene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) as well as elevation layers from the [ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers), which affect the surface elevation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html) */ @@ -47013,13 +47013,13 @@ declare namespace __esri { /** * Creates a slide from a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), which may be added to the [slides](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) in the WebScene's [presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#presentation). Updating the slide is asynchronous and a snapshot of the view is only complete once the returned promise has resolved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) - * + * * @param view The SceneView from which the slide should be created. * @param options Creation options. See properties below for object specifications. * @param options.screenshot Screenshot options to use. See properties below for object specifications. - * + * */ createFrom(view: SceneView, options?: SlideCreateFromOptions): IPromise; } @@ -47028,8 +47028,8 @@ declare namespace __esri { interface SlideProperties { /** - * The basemap of the scene. Only the [base](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) layers of the basemap are stored in a slide. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. - * + * The basemap of the scene. Only the [base](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) layers of the basemap are stored in a slide. This value can be an instance of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) or one of the strings listed in the table below. + * * Value | Description * ------|------------ * streets | ![basemap-streets](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/streets.jpg) @@ -47042,61 +47042,61 @@ declare namespace __esri { * national-geographic | ![basemap-national-geographic](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/national-geographic.jpg) * terrain | ![basemap-terrain](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/terrain.jpg) * osm | ![basemap-osm](https://developers.arcgis.com/javascript/assets/img/apiref/basemap/osm.jpg) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#basemap) */ basemap?: BasemapProperties | string; /** * The description of the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ description?: SlideDescriptionProperties | string; /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#environment) */ environment?: EnvironmentProperties; /** * Ground properties for this slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ ground?: SlideGroundProperties; /** * The unique id of a slide within the [slides property](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html#slides) of a [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#id) */ id?: string; /** * A data URI encoded thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ thumbnail?: SlideThumbnailProperties | string; /** * The title of the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ title?: SlideTitleProperties | string; /** * The viewpoint of the slide. This acts like a bookmark, saving a predefined location or point of view from which to view the scene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#viewpoint) */ viewpoint?: ViewpointProperties; /** - * The visible layers of the scene. This is a collection of objects that stores references (by ID) to the [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) and [ground layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that are set as `visible` when a slide is applied to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When assigning visible layers, the following types of values will be automatically casted: + * The visible layers of the scene. This is a collection of objects that stores references (by ID) to the [scene layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) and [ground layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that are set as `visible` when a slide is applied to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). When assigning visible layers, the following types of values will be automatically casted: * * Array (or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)) of [Layer instances](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html): `[layerInstance, layerInstance]` * * Array (or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)) of [Layer IDs](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id): `["layer-1", "layer-2"]` - * - * + * + * * The specification for each object in the collection is outlined in the table below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ visibleLayers?: CollectionProperties; @@ -47106,37 +47106,37 @@ declare namespace __esri { export interface SlideApplyToOptions extends Object { /** * Indicates whether to animate the slide transition. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) - * + * * @default true */ animate?: boolean; /** * Increases or decreases the animation speed by the specified factor. A speedFactor of 2 will make the animation twice as fast, while a speedFactor of 0.5 will make the animation half as fast. Setting the speed factor will automatically adapt the default maxDuration accordingly. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) - * + * * @default 1 */ speedFactor?: number; /** * Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) */ duration?: number; /** * The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) - * + * * @default 8000 */ maxDuration?: number; /** * The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: `linear`, `in-cubic`, `out-cubic`, `in-out-cubic`, `in-expo`, `out-expo`, `in-out-expo` By default, animations that are less than 1000 ms use an out easing function; longer animations use an in-out function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#applyTo) */ easing?: string | EasingFunction; @@ -47146,7 +47146,7 @@ declare namespace __esri { export interface SlideCreateFromOptions extends Object { /** * Screenshot options to use. See properties below for object specifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) */ screenshot?: SlideCreateFromOptionsScreenshot; @@ -47156,33 +47156,33 @@ declare namespace __esri { export interface SlideCreateFromOptionsScreenshot extends Object { /** * The image format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) - * + * * @default jpeg */ format?: string; /** * The image quality (due to compression). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) - * + * * @default 80 */ quality?: number; /** * The image width. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) - * + * * @default 120 */ width?: number; /** * The image height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#createFrom) - * + * * @default 75 */ height?: number; @@ -47192,7 +47192,7 @@ declare namespace __esri { export interface SlideDescriptionProperties extends Object { /** * The description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ text?: string; @@ -47201,7 +47201,7 @@ declare namespace __esri { export interface SlideDescription extends AnonymousAccessor { /** * The description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#description) */ text?: string; @@ -47211,7 +47211,7 @@ declare namespace __esri { export interface SlideGroundProperties extends Object { /** * Ground opacity - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ opacity?: number; @@ -47220,7 +47220,7 @@ declare namespace __esri { export interface SlideGround extends AnonymousAccessor { /** * Ground opacity - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#ground) */ opacity?: number; @@ -47230,7 +47230,7 @@ declare namespace __esri { export interface SlideThumbnailProperties extends Object { /** * The URI pointing to the thumbnail image representing the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ url?: string; @@ -47239,7 +47239,7 @@ declare namespace __esri { export interface SlideThumbnail extends AnonymousAccessor { /** * The URI pointing to the thumbnail image representing the slide. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#thumbnail) */ url?: string; @@ -47249,7 +47249,7 @@ declare namespace __esri { export interface SlideTitleProperties extends Object { /** * The title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ text?: string; @@ -47258,7 +47258,7 @@ declare namespace __esri { export interface SlideTitle extends AnonymousAccessor { /** * The title. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#title) */ text?: string; @@ -47268,7 +47268,7 @@ declare namespace __esri { export interface SlideUpdateFromOptions extends Object { /** * Screenshot options to use. See properties below for object specifications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) */ screenshot: SlideUpdateFromOptionsScreenshot; @@ -47278,33 +47278,33 @@ declare namespace __esri { export interface SlideUpdateFromOptionsScreenshot extends Object { /** * The image format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) - * + * * @default jpeg */ format?: string; /** * The image quality (due to compression). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) - * + * * @default 80 */ quality?: number; /** * The image width. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) - * + * * @default 120 */ width?: number; /** * The image height. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#updateFrom) - * + * * @default 75 */ height?: number; @@ -47314,7 +47314,7 @@ declare namespace __esri { export interface SlideVisibleLayersProperties extends Object { /** * The ID of a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) in the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) or [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that is made `visible` in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the slide is applied to the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ id?: string; @@ -47323,7 +47323,7 @@ declare namespace __esri { export interface SlideVisibleLayers extends AnonymousAccessor { /** * The ID of a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id) in the [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#layers) or [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#layers) that is made `visible` in the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) when the slide is applied to the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers) */ id: string; @@ -47333,13 +47333,13 @@ declare namespace __esri { export interface WebSceneSaveAsOptions extends Object { /** * the folder in which to save the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) */ folder?: PortalFolder; /** * allow the scene to be saved even in the case it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#saveAs) */ ignoreUnsupported?: boolean; @@ -47349,7 +47349,7 @@ declare namespace __esri { export interface WebSceneSaveOptions extends Object { /** * When `true`, the scene will save even if it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the scene may appear different when reloaded from its portal item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#save) */ ignoreUnsupported?: boolean; @@ -47359,13 +47359,13 @@ declare namespace __esri { export interface WebSceneSourceVersion extends Object { /** * The major version of the WebScene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ major: number; /** * The minor version of the WebScene. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#sourceVersion) */ minor: number; @@ -47375,25 +47375,25 @@ declare namespace __esri { export interface WebSceneUpdateFromOptions extends Object { /** * do not update the initial environment from the view, defaults to false. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ environmentExcluded?: boolean; /** * do not update the initial viewpoint from the view, defaults to false. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ viewpointExcluded?: boolean; /** * do not update the thumbnail from the view, defaults to viewpointExcluded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ thumbnailExcluded?: boolean; /** * the size of the thumbnail. Defaults to 600x400 (ratio 1.5:1). Note that the thumbnail size may currently not be larger than the size of the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ thumbnailSize?: WebSceneUpdateFromOptionsThumbnailSize; @@ -47403,13 +47403,13 @@ declare namespace __esri { export interface WebSceneUpdateFromOptionsThumbnailSize extends Object { /** * the width of the thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ width: number; /** * the height of the thumbnail. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html#updateFrom) */ height: number; @@ -47418,37 +47418,37 @@ declare namespace __esri { interface AreaMeasurement3D extends Widget { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | square-inches | square-feet | square-yards | square-miles | square-meters | square-kilometers | square-us-feet | acres | ares | hectares - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit) */ unit: string; /** * List of unit options in the widget drop down list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions) - * + * * @default ["metric", "imperial", "square-inches", "square-feet", "square-yards", "square-miles", "square-us-feet", "square-meters", "square-kilometers", "acres", "ares", "hectares"] */ unitOptions: string[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#view) */ view: SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [AreaMeasurement3DViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#viewModel) */ viewModel: AreaMeasurement3DViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#render) - * - * + * + * */ render(): any; } @@ -47456,7 +47456,7 @@ declare namespace __esri { interface AreaMeasurement3DConstructor { /** * The AreaMeasurement3D widget calculates and displays the area and perimeter of a polygon. This widget can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the area and perimeter of a polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html) */ @@ -47468,27 +47468,27 @@ declare namespace __esri { interface AreaMeasurement3DProperties extends WidgetProperties { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | square-inches | square-feet | square-yards | square-miles | square-meters | square-kilometers | square-us-feet | acres | ares | hectares - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit) */ unit?: string; /** * List of unit options in the widget drop down list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions) - * + * * @default ["metric", "imperial", "square-inches", "square-feet", "square-yards", "square-miles", "square-us-feet", "square-meters", "square-kilometers", "acres", "ares", "hectares"] */ unitOptions?: string[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [AreaMeasurement3DViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#viewModel) */ viewModel?: AreaMeasurement3DViewModelProperties; @@ -47497,52 +47497,52 @@ declare namespace __esri { interface AreaMeasurement3DViewModel extends Accessor { /** * The current measurement of the area. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ readonly measurement: AreaMeasurement3DViewModelMeasurement; /** - * The view model's state. - * + * The view model's state. + * * Value | Description * ------------|------------- * disabled | not ready yet * ready | ready for measuring * measuring | currently measuring - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | square-inches | square-feet | square-yards | square-miles | square-meters | square-kilometers | square-us-feet | acres | ares | hectares - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit) */ unit: string; /** * List of unit systems (imperial, metric) and specific units for displaying the area values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions) - * + * * @default ["metric", "imperial", "square-inches", "square-feet", "square-yards", "square-miles", "square-us-feet", "square-meters", "square-kilometers", "acres", "ares", "hectares"] */ unitOptions: string[]; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view) */ view: SceneView; /** * Clears the current measurement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#clearMeasurement) - * - * + * + * */ clearMeasurement(): void; } @@ -47558,21 +47558,21 @@ declare namespace __esri { interface AreaMeasurement3DViewModelProperties { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | square-inches | square-feet | square-yards | square-miles | square-meters | square-kilometers | square-us-feet | acres | ares | hectares - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit) */ unit?: string; /** * List of unit systems (imperial, metric) and specific units for displaying the area values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions) - * + * * @default ["metric", "imperial", "square-inches", "square-feet", "square-yards", "square-miles", "square-us-feet", "square-meters", "square-kilometers", "acres", "ares", "hectares"] */ unitOptions?: string[]; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view) */ view?: SceneViewProperties; @@ -47582,19 +47582,19 @@ declare namespace __esri { export interface AreaMeasurement3DViewModelMeasurement extends Object { /** * Describes the mode in which the measurement was taken. In `euclidean` mode, the area and perimeter length are computed from a flat polygon with straight segments on the perimeter in the [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system. In `geodesic` mode, the area and perimeter length are computed from a geodesic polygon on the WGS84 ellipsoid. **Possible Values:** euclidean | geodesic - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ measurementMode: string; /** * The area of the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ area: MeasurementValue; /** * The perimeter length of the polygon. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement) */ perimeterLength: MeasurementValue; @@ -47602,26 +47602,26 @@ declare namespace __esri { /** * Measurement value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ export interface MeasurementValue extends Object { /** * Textual representation of the measured value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ text: string; /** - * State of the measured value. - * + * State of the measured value. + * * Value | Description * ------------|------------- * available | measured value is available * unavailable | measured value is not available due an incomplete measurement * invalid | measured value is not available due to an invalid measurement configuration (e.g. self-intersecting polygon) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue) */ state: string; @@ -47630,49 +47630,49 @@ declare namespace __esri { interface Attribution extends Widget { /** * Full attribution text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#attributionText) */ readonly attributionText: string; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#iconClass) */ readonly iconClass: string; /** * Text used to split attribution by [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#itemDelimiter) - * + * * @default | */ itemDelimiter: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#label) */ readonly label: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [AttributionViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#viewModel) */ viewModel: AttributionViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#render) - * - * + * + * */ render(): any; } @@ -47680,7 +47680,7 @@ declare namespace __esri { interface AttributionConstructor { /** * The Attribution displays attribution text for the layers in a map. The text displayed for the layers is either a list of data providers or sources as defined in the layer's custom attribution data, or the copyright text. This widget automatically updates based on layer visibility and map extent and displays a single line of attribution that can be expanded with a single click to view all data sources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html) */ @@ -47692,21 +47692,21 @@ declare namespace __esri { interface AttributionProperties extends WidgetProperties { /** * Text used to split attribution by [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#itemDelimiter) - * + * * @default | */ itemDelimiter?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [AttributionViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html#viewModel) */ viewModel?: AttributionViewModelProperties; @@ -47715,21 +47715,21 @@ declare namespace __esri { interface AttributionViewModel extends Accessor { /** * A collection of [AttributionItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#items) */ readonly items: Collection; /** * The view model's state. **Possible Values:** ready | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which the view model will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#view) */ view: MapView | SceneView; @@ -47738,7 +47738,7 @@ declare namespace __esri { interface AttributionViewModelConstructor { /** * Provides the logic for the [Attribution](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution.html) widget. Displays attribution text for the layers in a map. The text displayed for the layers is either a list of data providers or sources as defined in the layer's custom attribution data, or the copyright text. The attribution is automatically updated based on layer visibility and map extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html) */ @@ -47750,7 +47750,7 @@ declare namespace __esri { interface AttributionViewModelProperties { /** * The view from which the view model will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -47758,19 +47758,19 @@ declare namespace __esri { /** * The following properties define an attribution item that contains the attribution text for a layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ export interface AttributionItem extends Object { /** * The attribution text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ text: string; /** * The layer that has the attribution text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attribution-AttributionViewModel.html#AttributionItem) */ layer: Layer; @@ -47779,47 +47779,47 @@ declare namespace __esri { interface BasemapGallery extends Widget { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#activeBasemap) */ activeBasemap: Basemap; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#iconClass) */ iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#label) */ readonly label: string; /** * The source for basemaps that the widget will display. This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s, a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance, or a URL to a portal instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html) that points to the default portal instance set in [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#source) */ source: LocalBasemapsSource | PortalBasemapsSource; /** * The view from which the widget will operate. This view provides access to the active [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BasemapGalleryViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#viewModel) */ viewModel: BasemapGalleryViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#render) - * - * + * + * */ render(): any; } @@ -47827,7 +47827,7 @@ declare namespace __esri { interface BasemapGalleryConstructor { /** * The BasemapGallery widget displays a collection images representing basemaps from ArcGIS.com or a user-defined set of map or image services. When a new basemap is selected from the BasemapGallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery. By default, the BasemapGallery widget looks like the following image. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html) */ @@ -47839,31 +47839,31 @@ declare namespace __esri { interface BasemapGalleryProperties extends WidgetProperties { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#activeBasemap) */ activeBasemap?: BasemapProperties; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#iconClass) */ iconClass?: string; /** * The source for basemaps that the widget will display. This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s, a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance, or a URL to a portal instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html) that points to the default portal instance set in [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#source) */ source?: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties; /** * The view from which the widget will operate. This view provides access to the active [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BasemapGalleryViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery.html#viewModel) */ viewModel?: BasemapGalleryViewModelProperties; @@ -47872,45 +47872,45 @@ declare namespace __esri { interface BasemapGalleryViewModel extends Accessor { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap) */ activeBasemap: Basemap; /** * A collection of [BasemapGalleryItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html)s representing basemaps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#items) */ items: Collection; /** * The source for basemaps that the widget will display. This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s, a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance or a URL to a portal instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html) that points to the default portal instance set in [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) */ source: LocalBasemapsSource | PortalBasemapsSource; /** * The view model's state. **Possible Values:** ready | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which the widget will operate. This view provides access to the active [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#view) */ view: MapView | SceneView; /** * A convenience function to check basemap equality. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#basemapEquals) - * + * * @param basemap1 The basemap to compare against `basemap2`. * @param basemap2 The basemap to compare against `basemap1`. - * + * */ basemapEquals(basemap1: Basemap, basemap2: Basemap): boolean; } @@ -47926,25 +47926,25 @@ declare namespace __esri { interface BasemapGalleryViewModelProperties { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap) */ activeBasemap?: BasemapProperties; /** * A collection of [BasemapGalleryItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html)s representing basemaps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#items) */ items?: CollectionProperties; /** * The source for basemaps that the widget will display. This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s, a [Portal](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html) instance or a URL to a portal instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html) that points to the default portal instance set in [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source) */ source?: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties; /** * The view from which the widget will operate. This view provides access to the active [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -47953,27 +47953,27 @@ declare namespace __esri { interface BasemapGalleryItem extends Accessor { /** * The item's associated basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap) */ basemap: Basemap; /** * The Error object returned if an error occurred. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#error) */ readonly error: Error; /** * The item's state. **Possible Values:** loading | ready | error - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#state) - * + * * @default loading */ readonly state: string; /** * The view associated with this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#view) */ view: MapView | SceneView; @@ -47990,13 +47990,13 @@ declare namespace __esri { interface BasemapGalleryItemProperties { /** * The item's associated basemap. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap) */ basemap?: BasemapProperties; /** * The view associated with this item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-BasemapGalleryItem.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -48005,23 +48005,23 @@ declare namespace __esri { interface LocalBasemapsSource extends Accessor { /** * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps) */ basemaps: Collection; /** * The source's state. The state is always `ready`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#state) */ readonly state: string; /** * Refreshes the source basemaps. Note: `refresh` will not affect LocalBasemapsSource. Modify basemaps directly instead. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#refresh) - * - * + * + * */ refresh(): void; } @@ -48037,7 +48037,7 @@ declare namespace __esri { interface LocalBasemapsSourceProperties { /** * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps) */ basemaps?: CollectionProperties; @@ -48046,25 +48046,25 @@ declare namespace __esri { interface PortalBasemapsSource extends LocalBasemapsSource { /** * Function used to filter basemaps after being fetched from the Portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction) */ filterFunction: Function; /** * The Portal from which to fetch basemaps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal) */ portal: Portal; /** * An object with key-value pairs used to create a custom basemap gallery group query. Note that all parameters will be joined using the `AND` operator. A query string can also be provided for more advanced use cases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#query) */ query: any | string; /** * Callback for updating basemaps after being fetched and filtered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback) */ updateBasemapsCallback: Function; @@ -48081,25 +48081,25 @@ declare namespace __esri { interface PortalBasemapsSourceProperties extends LocalBasemapsSourceProperties { /** * Function used to filter basemaps after being fetched from the Portal. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction) */ filterFunction?: Function; /** * The Portal from which to fetch basemaps. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal) */ portal?: PortalProperties; /** * An object with key-value pairs used to create a custom basemap gallery group query. Note that all parameters will be joined using the `AND` operator. A query string can also be provided for more advanced use cases. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#query) */ query?: any | string; /** * Callback for updating basemaps after being fetched and filtered. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback) */ updateBasemapsCallback?: Function; @@ -48108,53 +48108,53 @@ declare namespace __esri { interface BasemapToggle extends Widget { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#activeBasemap) */ readonly activeBasemap: Basemap; /** - * The next basemap for toggling. One of the following values may be set to this property: + * The next basemap for toggling. One of the following values may be set to this property: * * The [string ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) of any Esri basemap. * * A custom [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) object. Since this property may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html), the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) module does not need to be included in the `require()` function in most applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap) */ nextBasemap: Basemap; /** * Indicates if the title of the basemap is visible in the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#titleVisible) - * + * * @default false */ titleVisible: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This view provides the BasemapToggle widget with access to the initial [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) to toggle from via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BasemapToggleViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#viewModel) */ viewModel: BasemapToggleViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#render) - * - * + * + * */ render(): any; /** * Toggles to the [next basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#toggle) - * - * + * + * */ toggle(): void; } @@ -48162,7 +48162,7 @@ declare namespace __esri { interface BasemapToggleConstructor { /** * The BasemapToggle provides a widget which allows an end-user to switch between two basemaps. The toggled basemap is set inside the [view's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html) */ @@ -48173,30 +48173,30 @@ declare namespace __esri { interface BasemapToggleProperties extends WidgetProperties { /** - * The next basemap for toggling. One of the following values may be set to this property: + * The next basemap for toggling. One of the following values may be set to this property: * * The [string ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) of any Esri basemap. * * A custom [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) object. Since this property may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html), the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) module does not need to be included in the `require()` function in most applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#nextBasemap) */ nextBasemap?: BasemapProperties | string; /** * Indicates if the title of the basemap is visible in the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#titleVisible) - * + * * @default false */ titleVisible?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). This view provides the BasemapToggle widget with access to the initial [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) to toggle from via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BasemapToggleViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#viewModel) */ viewModel?: BasemapToggleViewModelProperties; @@ -48205,39 +48205,39 @@ declare namespace __esri { interface BasemapToggleViewModel extends Accessor, Evented { /** * The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#activeBasemap) */ readonly activeBasemap: Basemap; /** - * The next basemap for toggling. One of the following values may be set to this property: + * The next basemap for toggling. One of the following values may be set to this property: * * The [string ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) of any Esri basemap. * * A custom [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) object. Since this property may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html), the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) module does not need to be included in the `require()` function in most applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap) */ nextBasemap: Basemap; /** * The view model's state. **Possible Values:** ready | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which the widget will operate. This view provides access to the initial [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) to toggle from via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#view) */ view: MapView | SceneView; /** * Toggles to the [next basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#toggle) - * - * + * + * */ toggle(): void; } @@ -48250,11 +48250,11 @@ declare namespace __esri { /** * Helper method to find a basemap's thumbnail URL. If the basemap does not have a thumbnail URL defined, this utility will try to find a thumbnail URL from the best matching well-known basemap. If no match is found, a thumbnail URL from the basemap's base layers will be used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#getThumbnailUrl) - * + * * @param basemap The basemap used to retrieve the thumbnail URL. - * + * */ getThumbnailUrl(basemap: Basemap): string; } @@ -48263,16 +48263,16 @@ declare namespace __esri { interface BasemapToggleViewModelProperties { /** - * The next basemap for toggling. One of the following values may be set to this property: + * The next basemap for toggling. One of the following values may be set to this property: * * The [string ID](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) of any Esri basemap. * * A custom [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) object. Since this property may be [autocast](https://developers.arcgis.com/javascript/latest/guide/autocasting/index.html), the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) module does not need to be included in the `require()` function in most applications. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap) */ nextBasemap?: BasemapProperties | string; /** * The view from which the widget will operate. This view provides access to the initial [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap) to toggle from via the view's [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -48281,50 +48281,50 @@ declare namespace __esri { interface Bookmarks extends Widget, GoTo { /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#bookmarks) */ readonly bookmarks: Collection; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#label) */ readonly label: string; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#view) */ view: MapView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BookmarksViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#viewModel) */ viewModel: BookmarksViewModel; /** * Zoom to a specific bookmark. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#goTo) - * + * * @param Bookmark The bookmark to zoom to. - * + * */ goTo(Bookmark: Bookmark): IPromise; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#render) - * - * + * + * */ render(): any; } @@ -48332,7 +48332,7 @@ declare namespace __esri { interface BookmarksConstructor { /** * The Bookmarks widget allows end users to quickly navigate to a particular area of interest. It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html), which typically are defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html) */ @@ -48344,13 +48344,13 @@ declare namespace __esri { interface BookmarksProperties extends WidgetProperties, GoToProperties { /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#view) */ view?: MapViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [BookmarksViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#viewModel) */ viewModel?: BookmarksViewModelProperties; @@ -48359,38 +48359,38 @@ declare namespace __esri { interface BookmarksViewModel extends Accessor, GoTo { /** * The [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) that is being navigated to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#activeBookmark) */ readonly activeBookmark: Bookmark; /** * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#bookmarks) */ readonly bookmarks: Collection; /** * The view model's state. **Possible Values:** loading | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#view) */ view: MapView; /** * Zoom to a specific bookmark. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#goTo) - * + * * @param Bookmark The bookmark to zoom to. - * + * */ goTo(Bookmark: Bookmark): IPromise; } @@ -48406,7 +48406,7 @@ declare namespace __esri { interface BookmarksViewModelProperties extends GoToProperties { /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#view) */ view?: MapViewProperties; @@ -48415,101 +48415,101 @@ declare namespace __esri { interface ColorSlider extends Accessor, Widgette { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#handlesVisible) - * + * * @default true */ handlesVisible: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogram) */ histogram: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogramVisible) - * + * * @default true */ histogramVisible: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics), but may not be less than the value of the maximum stop of the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable). This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue) */ maxValue: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics), but may not be greater than the value of the minimum stop of the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable). This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) */ minValue: number; /** * Indicates the number of handles to show on the slider. Acceptable values are `2` or `3`. If `3` handles are specified, then the [syncedHandles](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#syncedHandles) property may be enabled to sync the movement of the outside handles with the middle, or primary, handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#numHandles) - * + * * @default {"value":2,"set":""} */ numHandles: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ statistics: ColorSliderStatistics; /** * Indicates whether to show the average in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible: boolean; /** * Only applicable when [numHandles](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#numHandles) is set to `3`. This property indicates whether the outside handles are synced with the middle, or primary, handle. If the primary handle is dragged then the outside handles are dragged while maintaining the same distance from the primary handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#syncedHandles) - * + * * @default false */ syncedHandles: boolean; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#ticksVisible) - * + * * @default true */ ticksVisible: boolean; /** * Each object in this array represents a stop in the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable) associated with the slider. The properties of each object describe whether the stop has a slider handle, the value of the handle and its associated color. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#values) */ readonly values: ColorSliderValues[]; /** * The color visual variable represented by the slider. This must be set initially on the slider for it to render in the view. This may be created manually (see snippet below) or generated from the [colorRendererCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html) helper methods. A new color visual variable is created each time the user slides handles or changes the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) or the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable) */ visualVariable: ColorVisualVariable; @@ -48518,7 +48518,7 @@ declare namespace __esri { interface ColorSliderConstructor { /** * The ColorSlider is a widget intended for authoring and exploring data-driven visualizations in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) using color. To display properly, this slider requires a [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable) and a [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) object. Other optional properties may be used, including adding a [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogram). Most of the various options that affect the UI of the slider are labeled in the image below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html) */ @@ -48530,95 +48530,95 @@ declare namespace __esri { interface ColorSliderProperties extends WidgetteProperties { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#handlesVisible) - * + * * @default true */ handlesVisible?: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogram) */ histogram?: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogramVisible) - * + * * @default true */ histogramVisible?: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth?: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics), but may not be less than the value of the maximum stop of the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable). This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue) */ maxValue?: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics), but may not be greater than the value of the minimum stop of the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable). This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) */ minValue?: number; /** * Indicates the number of handles to show on the slider. Acceptable values are `2` or `3`. If `3` handles are specified, then the [syncedHandles](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#syncedHandles) property may be enabled to sync the movement of the outside handles with the middle, or primary, handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#numHandles) - * + * * @default {"value":2,"set":""} */ numHandles?: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ statistics?: ColorSliderStatistics; /** * Indicates whether to show the average in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible?: boolean; /** * Only applicable when [numHandles](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#numHandles) is set to `3`. This property indicates whether the outside handles are synced with the middle, or primary, handle. If the primary handle is dragged then the outside handles are dragged while maintaining the same distance from the primary handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#syncedHandles) - * + * * @default false */ syncedHandles?: boolean; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#ticksVisible) - * + * * @default true */ ticksVisible?: boolean; /** * The color visual variable represented by the slider. This must be set initially on the slider for it to render in the view. This may be created manually (see snippet below) or generated from the [colorRendererCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-color.html) helper methods. A new color visual variable is created each time the user slides handles or changes the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#minValue) or the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#visualVariable) */ visualVariable?: ColorVisualVariable; @@ -48628,25 +48628,25 @@ declare namespace __esri { export interface ColorSliderStatistics extends Object { /** * The average of all data values represented in the color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ avg: number; /** * The maximum of all data values represented in the color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ max: number; /** * The minimum of all data values represented in the color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ min: number; /** * The standard deviation calculated from all data values represented in the color visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#statistics) */ stddev: number; @@ -48656,19 +48656,19 @@ declare namespace __esri { export interface ColorSliderValues extends Object { /** * The color used to represent features with values at the associated stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#values) */ color: Color; /** * The value of the stop for the associated handle. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#values) */ value: number; /** * The label used to display the value to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ColorSlider.html#values) */ label: string; @@ -48677,43 +48677,43 @@ declare namespace __esri { interface Compass extends Widget, GoTo { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#label) */ readonly label: string; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or rotation (MapView). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [CompassViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#viewModel) */ viewModel: CompassViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#render) - * - * + * + * */ render(): any; /** * If working in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html), sets the view's [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) to `0`. If working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), sets the camera's [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) to `0`. This method is executed each time the [Compass](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#reset) - * - * + * + * */ reset(): void; } @@ -48721,7 +48721,7 @@ declare namespace __esri { interface CompassConstructor { /** * The Compass widget indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading). Clicking the Compass widget rotates the view to face north (heading = 0). This widget is added to a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) by default. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) */ @@ -48733,13 +48733,13 @@ declare namespace __esri { interface CompassProperties extends WidgetProperties, GoToProperties { /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or rotation (MapView). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [CompassViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html#viewModel) */ viewModel?: CompassViewModelProperties; @@ -48748,33 +48748,33 @@ declare namespace __esri { interface CompassViewModel extends Accessor, GoTo { /** * The orientation axes (x, y, z). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#orientation) - * + * * @default { x: 0, y: 0, z: 0 } */ orientation: any; /** * The view model's state. **Possible Values:** compass | rotation | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or rotation (MapView). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#view) */ view: MapView | SceneView; /** * If working in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html), sets the view's [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) is to `0`. If working in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html), sets the camera's [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading) to `0`. This method is executed each time the [Compass](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#reset) - * - * + * + * */ reset(): void; } @@ -48782,7 +48782,7 @@ declare namespace __esri { interface CompassViewModelConstructor { /** * Provides the logic for the [Compass](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html) */ @@ -48794,15 +48794,15 @@ declare namespace __esri { interface CompassViewModelProperties extends GoToProperties { /** * The orientation axes (x, y, z). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#orientation) - * + * * @default { x: 0, y: 0, z: 0 } */ orientation?: any; /** * The view in which the Compass obtains and indicates camera [heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading), using a (SceneView) or rotation (MapView). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -48811,85 +48811,85 @@ declare namespace __esri { interface CoordinateConversion extends Widget, GoTo { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions) */ conversions: Collection; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). Setting this property will update all [conversions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#currentLocation) */ currentLocation: Point; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. The default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats) */ formats: Collection; /** - * Describes the current mode of the widget. **Possible Values:** live | capture + * Describes the current mode of the widget. **Possible Values:** live | capture * * While in `live` mode, the widget will update as the cursor moves. * * While in `capture` mode, the widget will update on mouse click and display a graphic marking the current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#mode) - * + * * @default live */ mode: string; /** * If this property is set to `true`, multiple conversions can be displayed. For a simpler experience with only one conversion at a time, this property can be set to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#multipleConversions) - * + * * @default true */ multipleConversions: boolean; /** * Determines whether the widget should expand up or down. If set to `auto` the widget will be oriented based on its position in the view. **Possible Values:** auto | expand-up | expand-down - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#orientation) - * + * * @default auto */ orientation: string; /** * The number of milliseconds of delay before conversion requests will be sent to the [GeometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html). This only affects conversions that cannot be performed in the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#requestDelay) - * + * * @default 300 */ requestDelay: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#view) */ view: MapView | SceneView; /** * The view model for this widget. The view model contains the logic that controls the Coordinate Widget's behavior. See the [CoordinateConversionViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#viewModel) */ viewModel: CoordinateConversionViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#render) - * - * + * + * */ render(): any; /** * Attempt to convert a string into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). The format of the string must be specified. A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be obtained from the [formats](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#reverseConvert) - * + * * @param coordinate The coordinate string. * @param format Specifies the format of the input coordinate. - * + * */ reverseConvert(coordinate: string, format: Format): IPromise; } @@ -48897,7 +48897,7 @@ declare namespace __esri { interface CoordinateConversionConstructor { /** * The CoordinateConversion widget provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the widget provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) */ @@ -48909,65 +48909,65 @@ declare namespace __esri { interface CoordinateConversionProperties extends WidgetProperties, GoToProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions) */ conversions?: CollectionProperties; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). Setting this property will update all [conversions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#currentLocation) */ currentLocation?: PointProperties; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. The default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats) */ formats?: CollectionProperties; /** - * Describes the current mode of the widget. **Possible Values:** live | capture + * Describes the current mode of the widget. **Possible Values:** live | capture * * While in `live` mode, the widget will update as the cursor moves. * * While in `capture` mode, the widget will update on mouse click and display a graphic marking the current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#mode) - * + * * @default live */ mode?: string; /** * If this property is set to `true`, multiple conversions can be displayed. For a simpler experience with only one conversion at a time, this property can be set to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#multipleConversions) - * + * * @default true */ multipleConversions?: boolean; /** * Determines whether the widget should expand up or down. If set to `auto` the widget will be oriented based on its position in the view. **Possible Values:** auto | expand-up | expand-down - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#orientation) - * + * * @default auto */ orientation?: string; /** * The number of milliseconds of delay before conversion requests will be sent to the [GeometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html). This only affects conversions that cannot be performed in the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#requestDelay) - * + * * @default 300 */ requestDelay?: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. The view model contains the logic that controls the Coordinate Widget's behavior. See the [CoordinateConversionViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#viewModel) */ viewModel?: CoordinateConversionViewModelProperties; @@ -48976,89 +48976,89 @@ declare namespace __esri { interface CoordinateConversionViewModel extends Accessor, GoTo { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions) */ conversions: Collection; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). Setting this property will update all [conversions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation) */ currentLocation: Point; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. The default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats) */ formats: Collection; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol) */ locationSymbol: SimpleMarkerSymbol | PictureMarkerSymbol; /** - * Describes the current mode of the widget. **Possible Values:** live | capture + * Describes the current mode of the widget. **Possible Values:** live | capture * * While in `live` mode, the widget will update as the cursor moves. * * While in `capture` mode, the widget will update on mouse click and display a graphic marking the current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode) - * + * * @default live */ mode: string; /** * The number of milliseconds of delay before conversion requests will be sent to the [GeometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html). This only affects conversions that cannot be performed in the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#requestDelay) - * + * * @default 300 */ requestDelay: number; /** * The view model's state. **Possible Values:** ready | loading | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view) */ view: MapView | SceneView; /** * Attempt to convert a point into a [Position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#convert) - * + * * @param point The point to convert. * @param format The format that describes how the point should be converted. - * + * */ convert(point: Point, format: Format): IPromise; /** * Attempt to convert a string into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). The format of the string must be specified. A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be obtained from the [formats](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats) property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#reverseConvert) - * + * * @param coordinate The coordinate string. * @param format Specifies the format of the input coordinate. - * + * */ reverseConvert(coordinate: string, format: Format): IPromise; /** * Update the input conversions based on the input point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#updateConversions) - * + * * @param location A point that will be used to update each input conversion. * @param conversions An array of [Conversions](esri-widgets-CoordinateConversion-support-Conversion.html) to be updated. - * + * */ updateConversions(location: Point, conversions: Conversion[]): IPromise; } @@ -49074,49 +49074,49 @@ declare namespace __esri { interface CoordinateConversionViewModelProperties extends GoToProperties { /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html) that the widget is currently displaying. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions) */ conversions?: CollectionProperties; /** * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). Setting this property will update all [conversions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation) */ currentLocation?: PointProperties; /** * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) that the widget is capable of displaying. The default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats) */ formats?: CollectionProperties; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode is active. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol) */ locationSymbol?: SimpleMarkerSymbolProperties | PictureMarkerSymbolProperties; /** - * Describes the current mode of the widget. **Possible Values:** live | capture + * Describes the current mode of the widget. **Possible Values:** live | capture * * While in `live` mode, the widget will update as the cursor moves. * * While in `capture` mode, the widget will update on mouse click and display a graphic marking the current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode) - * + * * @default live */ mode?: string; /** * The number of milliseconds of delay before conversion requests will be sent to the [GeometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-GeometryService.html). This only affects conversions that cannot be performed in the browser. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#requestDelay) - * + * * @default 300 */ requestDelay?: number; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -49124,19 +49124,19 @@ declare namespace __esri { /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ export interface Position extends Object { /** * A point geometry representing the location described by the conversion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ location: Point; /** * A string representing the location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position) */ coordinate: string; @@ -49146,19 +49146,19 @@ declare namespace __esri { interface Conversion { /** * A formatted string based on the current [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#position) and display information on the [format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#format). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#displayCoordinate) */ readonly displayCoordinate: string; /** * The [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html) for this conversion. The Format contains information detailing how the Conversion should be performed and how it will be displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#format) */ format: Format; /** * The position property contains the location information for this conversion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#position) */ position: ConversionPosition; @@ -49168,19 +49168,19 @@ declare namespace __esri { /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ export interface ConversionPosition extends Object { /** * A point geometry representing the location described by the conversion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ location: Point; /** * A string representing the location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html#Position) */ coordinate: string; @@ -49190,53 +49190,53 @@ declare namespace __esri { interface Format { /** * Contains information that describes how this Format should be converted. This property should only be set when creating a custom Format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#conversionInfo) - * + * * @default null */ conversionInfo: ConversionInfo; /** * A array of [Coordinate Segments](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment). Each segment represents a section of the Format's coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#coordinateSegments) - * + * * @default null */ coordinateSegments: CoordinateSegment[]; /** * A string that serves as a pattern describing how this Format should be displayed. The pattern should contain all of aliases specified by the Format's [coordinateSegments property](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#coordinateSegments). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#currentPattern) - * + * * @default null */ currentPattern: string; /** * The default pattern describing how this Format should be displayed. See [currentPattern](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#currentPattern). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#defaultPattern) - * + * * @default null */ defaultPattern: string; /** * The name of the coordinate. A [CoordinateConversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) widget should not contain multiple Formats with the same name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#name) - * + * * @default null */ name: string; /** * The [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) for this format. Coordinates generated for a format will be derived from points in this spatial reference. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#spatialReference) */ spatialReference: SpatialReference; /** * The view model of the [CoordinateConversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html) widget that is utilizing this format. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#viewModel) */ viewModel: CoordinateConversionViewModel; @@ -49246,50 +49246,50 @@ declare namespace __esri { /** * This object describes how a Format should be projected and formatted for display. Used to define custom Formats that require custom conversion and/or projection logic. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) */ export interface ConversionInfo extends Object { /** * A function that takes a point and returns a [position](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) - * - * + * + * */ convert(): void; /** * A function that takes a string and returns a Point. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#ConversionInfo) - * - * + * + * */ reverseConvert(): void; } /** - * A coordinate segment represents one piece of a coordinate string. + * A coordinate segment represents one piece of a coordinate string. * > A MGRS coordinate, for example `30UVG898998`, is described by four segments: 1. Alias `Z`, the gridzone: `30U` 2. Alias `S`, the 100,000 meter square designator: `VG` 3. Alias `X`, the easting (x coordinate with respect to the 10,000 meter square): `898` 4. Alias `Y`, the northing (y coordinate with respect to the 10,000 meter square): `998` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ export interface CoordinateSegment extends Object { /** * A string that provides the name for this segment of a coordinate string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ alias: string; /** * A string that describes the role of this segment. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ description: string; /** * A regular expression that should extract this segment from the complete coordinate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#CoordinateSegment) */ searchPattern: RegExp; @@ -49297,19 +49297,19 @@ declare namespace __esri { /** * Describes a point in terms of a location, a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html), and a coordinate, a string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ export interface FormatPosition extends Object { /** * A point geometry representing the location described by the conversion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ location: Point; /** * A string representing the location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html#Position) */ coordinate: string; @@ -49318,87 +49318,87 @@ declare namespace __esri { interface Directions extends Widget, GoTo { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#label) */ readonly label: string; /** * The maximum number of stops allowed for routing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#maxStops) - * + * * @default 50 */ maxStops: number; /** * The URL of the REST endpoint of the Route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#routeServiceUrl) - * + * * @default "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World" */ routeServiceUrl: string; /** * Defines the symbol used to draw the route on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#routeSymbol) */ routeSymbol: SimpleLineSymbol; /** * Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). Note that the default `searchProperties` differ slightly from the [Search widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#searchProperties) - * + * * @default null */ searchProperties: DirectionsSearchProperties; /** * The default stop symbols used to display locations between the origin and final destination. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ stopSymbols: DirectionsStopSymbols; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [DirectionsViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#viewModel) */ viewModel: DirectionsViewModel; /** * Calculate the route to the input locations and display the list of directions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#getDirections) - * - * + * + * */ getDirections(): IPromise; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#render) - * - * + * + * */ render(): any; /** * Zoom so that the full route is displayed within the current map extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#zoomToRoute) - * - * + * + * */ zoomToRoute(): void; } @@ -49406,7 +49406,7 @@ declare namespace __esri { interface DirectionsConstructor { /** * The Directions Widget provides a way to build driving and walking directions using ArcGIS online and custom Network Analysis Route services. Similar to how the [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html) works, this widget generates a route finding a least-cost path between multiple points using a specified network. The resulting directions are displayed with detailed turn-by-turn instructions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html) */ @@ -49418,49 +49418,49 @@ declare namespace __esri { interface DirectionsProperties extends WidgetProperties, GoToProperties { /** * The maximum number of stops allowed for routing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#maxStops) - * + * * @default 50 */ maxStops?: number; /** * The URL of the REST endpoint of the Route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#routeServiceUrl) - * + * * @default "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World" */ routeServiceUrl?: string; /** * Defines the symbol used to draw the route on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#routeSymbol) */ routeSymbol?: SimpleLineSymbolProperties; /** * Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). Note that the default `searchProperties` differ slightly from the [Search widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#searchProperties) - * + * * @default null */ searchProperties?: DirectionsSearchProperties; /** * The default stop symbols used to display locations between the origin and final destination. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ stopSymbols?: DirectionsStopSymbols; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [DirectionsViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#viewModel) */ viewModel?: DirectionsViewModelProperties; @@ -49469,166 +49469,166 @@ declare namespace __esri { interface DirectionsViewModel extends Accessor, GoTo { /** * The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service. For example, set `impedanceAttribute = "Time"` for the quickest route and `impedanceAttribute = "Length"` for shortest drive, assuming the service has those two esriNAUTCost attributes. For more information, see [Understanding the network attribute](http://resources.arcgis.com/en/help/main/10.2/index.html#//00470000000m000000). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#impedanceAttribute) */ impedanceAttribute: string; /** * The most recent route result. Returns an object containing properties for any barriers used when generating the route, messages that may arise when solving the route, and finally an array of returned [RouteResults](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) - * + * * @default null */ readonly lastRoute: DirectionsViewModelLastRoute; /** * The maximum number of stops allowed for routing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#maxStops) - * + * * @default 50 */ maxStops: number; /** * Route Parameters object used to call the service. Please refer to the [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html) documentation for the list of available settings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeParameters) */ routeParameters: RouteParameters; /** * The URL of the REST endpoint of the Route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeServiceUrl) - * + * * @default "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World" */ routeServiceUrl: string; /** * Defines the symbol used to draw the route on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeSymbol) */ routeSymbol: SimpleLineSymbol; /** * The selected travel mode. More information can be found in the [ArcGIS Online documentation](https://doc.arcgis.com/en/arcgis-online/reference/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) - * + * * @default null | 'Driving Time' */ readonly selectedTravelMode: DirectionsViewModelSelectedTravelMode; /** * The Service Description object returned by the Route REST Endpoint. This object contains service specific details like available Cost attributes, supported Restrictions, default Attribute Parameter Values, Service Limits (like maximum input stop count), default Impedance Attribute, etc. This information is useful when implementing complex logistics scenarios operating with limitations or preferences on vehicle or stop properties, for example avoiding toll roads, dealing with hazardous materials, working with stop service times, etc. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#serviceDescription) - * + * * @default null */ readonly serviceDescription: any; /** * The current state of the view model. **Possible Values:** disabled | ready - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * An array of graphics that define the stop locations along the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stops) */ stops: Collection; /** * The default stop symbols used to display locations between the origin and final destination. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ stopSymbols: DirectionsViewModelStopSymbols; /** * The name of the network attribute to use for the drive time when computing directions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ timeAttribute: DirectionsViewModelTimeAttribute; /** * Array of objects containing properties specific to either an ArcGIS service or organization's travel modes. More information can be found in the [ArcGIS Online documentation](https://doc.arcgis.com/en/arcgis-online/reference/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#travelModes) */ readonly travelModes: TravelMode[]; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#view) */ view: MapView | SceneView; /** * Centers the map at the specified maneuver or stop. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#centerAt) - * + * * @param stopOrManeuver The stop or maneuver where the map should be centered. - * + * */ centerAt(stopOrManeuver: Graphic): void; /** * Clears any highlighted route segments. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#clearHighlights) - * - * + * + * */ clearHighlights(): void; /** * Removes the route directions from the directions list, leaving the inputs untouched. The route and locations persist on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#clearResults) - * - * + * + * */ clearResults(): void; /** * Returns cost attribute name specific to a particular route service. This can be used as a [travel mode impedance](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getCostAttribute) - * + * * @param attributeName The attribute name specifying the cost attribute used as an impedance. - * + * */ getCostAttribute(attributeName: string): string; /** * Calculate the route to the input locations and display the list of directions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#getDirections) - * - * + * + * */ getDirections(): IPromise; /** * Highlights the specified route segment on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#highlightSegment) - * + * * @param maneuver The route segment to highlight. - * + * */ highlightSegment(maneuver: Graphic): void; /** * Resets the state of the ViewModel, clearing off all the input stops, and results in the widget. The results persist in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#reset) - * - * + * + * */ reset(): void; /** * Zoom so that the full route is displayed within the current map extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#zoomToRoute) - * - * + * + * */ zoomToRoute(): void; } @@ -49636,7 +49636,7 @@ declare namespace __esri { interface DirectionsViewModelConstructor { /** * Provides the communication and data manipulation logic for the [Directions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html) */ @@ -49648,59 +49648,59 @@ declare namespace __esri { interface DirectionsViewModelProperties extends GoToProperties { /** * The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the specific routing network layer used in your [RouteTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-RouteTask.html). You can specify any attribute names listed in the Service Directory under `Network Dataset -> Network Attributes` as `Usage Type: esriNAUTCost`. You can also specify a value of `none` to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service. For example, set `impedanceAttribute = "Time"` for the quickest route and `impedanceAttribute = "Length"` for shortest drive, assuming the service has those two esriNAUTCost attributes. For more information, see [Understanding the network attribute](http://resources.arcgis.com/en/help/main/10.2/index.html#//00470000000m000000). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#impedanceAttribute) */ impedanceAttribute?: string; /** * The maximum number of stops allowed for routing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#maxStops) - * + * * @default 50 */ maxStops?: number; /** * Route Parameters object used to call the service. Please refer to the [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteParameters.html) documentation for the list of available settings. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeParameters) */ routeParameters?: RouteParametersProperties; /** * The URL of the REST endpoint of the Route service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeServiceUrl) - * + * * @default "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World" */ routeServiceUrl?: string; /** * Defines the symbol used to draw the route on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#routeSymbol) */ routeSymbol?: SimpleLineSymbolProperties; /** * An array of graphics that define the stop locations along the route. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stops) */ stops?: CollectionProperties; /** * The default stop symbols used to display locations between the origin and final destination. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ stopSymbols?: DirectionsViewModelStopSymbols; /** * The name of the network attribute to use for the drive time when computing directions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ timeAttribute?: DirectionsViewModelTimeAttribute; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -49710,31 +49710,31 @@ declare namespace __esri { export interface DirectionsViewModelLastRoute extends Object { /** * Array of graphics representing the point barriers. For a list of properties returned for each barrier, see the [barriers](https://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/barriers.htm) help documentation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ barriers: Graphic[]; /** * An array of messages serialized to JSON. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ messages: DirectionsViewModelLastRouteMessages[]; /** * Array of graphics representing the polygon barriers. For a list of properties returned for each barrier, see the [barriers](https://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/barriers.htm) help documentation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ polygonBarriers: Graphic[]; /** * Array of graphics representing the polygon barriers. For a list of properties returned for each barrier, see the [barriers](https://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/barriers.htm) help documentation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ polylineBarriers: Graphic[]; /** * An array of [RouteResults](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-RouteResult.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ routeResults: RouteResult; @@ -49744,13 +49744,13 @@ declare namespace __esri { export interface DirectionsViewModelLastRouteMessages extends Object { /** * A descriptive message of the returned mesage. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ description: string; /** * Number indicating the message type returned from the service. This number correlates to one of the possible values listed below. - * + * * Number | Value * ------|------------ * 0 | informative @@ -49761,8 +49761,8 @@ declare namespace __esri { * 100 | error * 101 | empty * 200 | abort - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#lastRoute) */ type: number; @@ -49772,31 +49772,31 @@ declare namespace __esri { export interface DirectionsViewModelSelectedTravelMode extends TravelMode { /** * The description explaining the selected travel mode. A listing of these descriptions can be found in the [ArcGIS Online documentation](https://doc.arcgis.com/en/arcgis-online/reference/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ description: string; /** * The unique identifier specific for this travel mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ id: string; /** * The cost attribute on which to optimize the analysis. For example `Miles`, `Minutes`, `Travel Time`, `Kilometers`, `TimeAt1KPH`, `WalkTime`, and `TruckTravelTime`. Take note that attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ impedanceAttributeName: string; /** * Name of the travel mode. Users of ArcGIS Online or ArcGIS Enterprise can define custom travel modes inside their Organization settings. Authors of stand alone Network Analysis Services can define their own travel modes inside a network dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ name: string; /** * The time-based cost attribute for reporting directions. For example, `Minutes`, `Travel Time`, `TimeAt1KPH`, `WalkTime`, and `TruckTravelTime`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#selectedTravelMode) */ timeAttributeName: string; @@ -49806,31 +49806,31 @@ declare namespace __esri { export interface DirectionsViewModelStopSymbols extends Object { /** * The first stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ first?: Symbol; /** * The middle stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ middle?: Symbol; /** * The last stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ last?: Symbol; /** * An unlocated stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ unlocated?: Symbol; /** * A waypoint stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#stopSymbols) */ waypoint?: Symbol; @@ -49840,13 +49840,13 @@ declare namespace __esri { export interface DirectionsViewModelTimeAttribute extends Object { /** * The name of the network attribute to use for the drive time when computing directions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ name: string; /** * The units to use when calculating drive time for directions. **Possible Values:** feet | kilometers | meters | miles | nautical-miles | yards - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#timeAttribute) */ units?: string; @@ -49854,37 +49854,37 @@ declare namespace __esri { /** * Array of objects containing properties specific to either an ArcGIS service or organization's travel modes. More information can be found in the [ArcGIS Online documentation](https://doc.arcgis.com/en/arcgis-online/reference/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ export interface TravelMode extends Object { /** * The description explaining the selected travel mode. A listing of these descriptions can be found in the [ArcGIS Online documentation](https://doc.arcgis.com/en/arcgis-online/reference/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ description?: string; /** * The unique identifier specific for this travel mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ id?: string; /** * The cost attribute on which to optimize the analysis. For example `Miles`, `Minutes`, `Travel Time`, `Kilometers`, `TimeAt1KPH`, `WalkTime`, and `TruckTravelTime`. Take note that attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ impedanceAttributeName?: string; /** * Name of the travel mode. Users of ArcGIS Online or ArcGIS Enterprise can define custom travel modes inside their Organization settings. Authors of stand alone Network Analysis Services can define their own travel modes inside a network dataset. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ name?: string; /** * The time-based cost attribute for reporting directions. For example, `Minutes`, `Travel Time`, `TimeAt1KPH`, `WalkTime`, and `TruckTravelTime`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#TravelMode) */ timeAttributeName?: string; @@ -49894,31 +49894,31 @@ declare namespace __esri { export interface DirectionsStopSymbols extends Object { /** * The first stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ first?: Symbol; /** * The middle stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ middle?: Symbol; /** * The last stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ last?: Symbol; /** * An unlocated stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ unlocated?: Symbol; /** * A waypoint stop symbol. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#stopSymbols) */ waypoint?: Symbol; @@ -49926,109 +49926,109 @@ declare namespace __esri { /** * Configurable Search properties of the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ export interface DirectionsSearchProperties extends Object { /** * Indicates whether to show the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a result is selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ popupOpenOnSelect?: boolean; /** * Number index indicating the current selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ activeSourceIndex?: number; /** * Indicates whether to automatically navigate to the selected result once selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ autoNavigate?: boolean; /** * Indicates whether to automatically select and zoom to the first geocoded result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ autoSelect?: boolean; /** * Indicates the maximum number of search results to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ maxResults?: number; /** * Indicates the maximum number of suggestions to return for the widget's input. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ maxSuggestions?: number; /** * Indicates the minimum number of characters required before querying for a suggestion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ minSuggestCharacters?: number; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ popupEnabled?: boolean; /** * String value used as a hint for input text when searching on multiple sources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ allPlaceholder?: string; /** * A customized PopupTemplate for the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ popupTemplate?: PopupTemplate; /** * Indicates whether to show a graphic on the map for the selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ searchAllEnabled?: boolean; /** * The value of the search box input text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ searchTerm?: string; /** * Specifies the sources to search in the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#view). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ sources?: Collection; /** * Indicates whether to display suggestions as the user enters input text in the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ suggestionsEnabled?: boolean; /** * The view of the widget. - * + * * [Read more...](global.html) */ view?: MapView | SceneView; /** * The Search widget's view model. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#SearchProperties) */ viewModel?: SearchViewModel; @@ -50037,37 +50037,37 @@ declare namespace __esri { interface DirectLineMeasurement3D extends Widget { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | inches | feet | yards | miles | nautical-miles | meters | kilometers | us-feet - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unit) */ unit: string; /** * List of unit options in the widget drop down list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unitOptions) - * + * * @default ["metric", "imperial", "inches", "feet", "yards", "miles", "nautical-miles", "us-feet", "meters", "kilometers"] */ unitOptions: string[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#view) */ view: SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [DirectLineMeasurement3DViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#viewModel) */ viewModel: DirectLineMeasurement3DViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#render) - * - * + * + * */ render(): any; } @@ -50075,7 +50075,7 @@ declare namespace __esri { interface DirectLineMeasurement3DConstructor { /** * The DirectLineMeasurement3D widget calculates and displays the 3D distance between two points. This widget can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the vertical, horizontal, and direct distance between two points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html) */ @@ -50087,27 +50087,27 @@ declare namespace __esri { interface DirectLineMeasurement3DProperties extends WidgetProperties { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | inches | feet | yards | miles | nautical-miles | meters | kilometers | us-feet - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unit) */ unit?: string; /** * List of unit options in the widget drop down list. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unitOptions) - * + * * @default ["metric", "imperial", "inches", "feet", "yards", "miles", "nautical-miles", "us-feet", "meters", "kilometers"] */ unitOptions?: string[]; /** * A reference to the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [DirectLineMeasurement3DViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#viewModel) */ viewModel?: DirectLineMeasurement3DViewModelProperties; @@ -50116,52 +50116,52 @@ declare namespace __esri { interface DirectLineMeasurement3DViewModel extends Accessor { /** * The current measurement calculated between the two points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ readonly measurement: DirectLineMeasurement3DViewModelMeasurement; /** - * The view model's state. - * + * The view model's state. + * * Value | Description * ------------|------------- * disabled | not ready yet * ready | ready for measuring * measuring | currently measuring - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | inches | feet | yards | miles | nautical-miles | meters | kilometers | us-feet - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit) */ unit: string; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions) - * + * * @default ["metric", "imperial", "inches", "feet", "yards", "miles", "nautical-miles", "us-feet", "meters", "kilometers"] */ unitOptions: string[]; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view) */ view: SceneView; /** * Clears the current measurement. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#clearMeasurement) - * - * + * + * */ clearMeasurement(): void; } @@ -50177,21 +50177,21 @@ declare namespace __esri { interface DirectLineMeasurement3DViewModelProperties { /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. **Possible Values:** imperial | metric | inches | feet | yards | miles | nautical-miles | meters | kilometers | us-feet - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit) */ unit?: string; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions) - * + * * @default ["metric", "imperial", "inches", "feet", "yards", "miles", "nautical-miles", "us-feet", "meters", "kilometers"] */ unitOptions?: string[]; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view) */ view?: SceneViewProperties; @@ -50201,25 +50201,25 @@ declare namespace __esri { export interface DirectLineMeasurement3DViewModelMeasurement extends Object { /** * Describes the mode in which the measurement was taken. In `euclidean` mode, the distances are measured as straight lines in the [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system. In `geodesic` mode, the distances are measured as geodesic lines on the WGS84 ellipsoid. **Possible Values:** euclidean | geodesic - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ measurementMode: string; /** * The direct distance between the two points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ directDistance: DirectLineMeasurement3DViewModelMeasurementValue; /** * The horizontal distance between the two points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ horizontalDistance: DirectLineMeasurement3DViewModelMeasurementValue; /** * The vertical distance between the two points. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement) */ verticalDistance: DirectLineMeasurement3DViewModelMeasurementValue; @@ -50227,25 +50227,25 @@ declare namespace __esri { /** * Measurement value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ export interface DirectLineMeasurement3DViewModelMeasurementValue extends Object { /** * Textual representation of the measured value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ text: string; /** - * State of the measured value. - * + * State of the measured value. + * * Value | Description * ------------|------------- * available | measured value is available * unavailable | measured value is not available due an incomplete measurement or because the value is not available for the given measurement configuration (e.g. direct distance is unavailable in `geodesic` mode) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue) */ state: string; @@ -50254,124 +50254,124 @@ declare namespace __esri { interface Expand extends Widget { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse) - * + * * @default false */ autoCollapse: boolean; /** * Icon font used to style the Expand button. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIconClass) */ collapseIconClass: string; /** * Tooltip to display to indicate Expand widget can be collapsed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip) - * + * * @default "Collapse" (English locale) */ collapseTooltip: string; /** * The content to display within the expanded Expand widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) */ content: Node | string | Widget; /** * Indicates whether the widget is currently expanded or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded) - * + * * @default false */ expanded: boolean; /** * Icon font used to style the Expand button. Will automatically use the [content's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) iconClass if it has one. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIconClass) */ expandIconClass: string; /** * Tooltip to display to indicate Expand widget can be expanded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip) - * + * * @default "Expand" (English locale) */ expandTooltip: string; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the [view.ui](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ui). For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the `top-left` group, then the first instance is collapsed, allowing the content of the second instance to be fully visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group) */ group: string; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. ![expand widget icon number](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/expand-with-iconnumber.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber) */ iconNumber: number; /** - * The mode in which the widget displays. These modes are listed below. - * + * The mode in which the widget displays. These modes are listed below. + * * mode | description * ---------------|------------ * auto | This is the default mode. It is responsive to browser size changes and will update based on whether the widget is viewed in a desktop or mobile application. * floating | Use this mode if you wish to always display the widget as floating regardless of browser size. * drawer | Use this mode if you wish to always display the widget in a panel regardless of browser size. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode) - * + * * @default "auto" */ mode: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ExpandViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#viewModel) */ viewModel: ExpandViewModel; /** * Collapse the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapse) - * - * + * + * */ collapse(): void; /** * Expand the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expand) - * - * + * + * */ expand(): void; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#render) - * - * + * + * */ render(): any; /** * Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#toggle) - * - * + * + * */ toggle(): void; } @@ -50387,90 +50387,90 @@ declare namespace __esri { interface ExpandProperties extends WidgetProperties { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse) - * + * * @default false */ autoCollapse?: boolean; /** * Icon font used to style the Expand button. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIconClass) */ collapseIconClass?: string; /** * Tooltip to display to indicate Expand widget can be collapsed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip) - * + * * @default "Collapse" (English locale) */ collapseTooltip?: string; /** * The content to display within the expanded Expand widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) */ content?: Node | string | WidgetProperties; /** * Indicates whether the widget is currently expanded or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded) - * + * * @default false */ expanded?: boolean; /** * Icon font used to style the Expand button. Will automatically use the [content's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) iconClass if it has one. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIconClass) */ expandIconClass?: string; /** * Tooltip to display to indicate Expand widget can be expanded. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip) - * + * * @default "Expand" (English locale) */ expandTooltip?: string; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the [view.ui](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ui). For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the `top-left` group, then the first instance is collapsed, allowing the content of the second instance to be fully visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group) */ group?: string; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. ![expand widget icon number](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/expand-with-iconnumber.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber) */ iconNumber?: number; /** - * The mode in which the widget displays. These modes are listed below. - * + * The mode in which the widget displays. These modes are listed below. + * * mode | description * ---------------|------------ * auto | This is the default mode. It is responsive to browser size changes and will update based on whether the widget is viewed in a desktop or mobile application. * floating | Use this mode if you wish to always display the widget as floating regardless of browser size. * drawer | Use this mode if you wish to always display the widget in a panel regardless of browser size. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode) - * + * * @default "auto" */ mode?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ExpandViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#viewModel) */ viewModel?: ExpandViewModelProperties; @@ -50479,37 +50479,37 @@ declare namespace __esri { interface ExpandViewModel extends Accessor { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#autoCollapse) - * + * * @default false */ autoCollapse: boolean; /** * Whether the widget is currently expanded or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#expanded) - * + * * @default false */ readonly expanded: boolean; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the [view.ui](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ui). For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the `top-left` group, then the first instance is collapsed, allowing the content of the second instance to be fully visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#group) */ group: string; /** * The view model's state. **Possible Values:** ready | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view in which the Expand is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#view) */ view: MapView | SceneView; @@ -50526,21 +50526,21 @@ declare namespace __esri { interface ExpandViewModelProperties { /** * Automatically collapses the expand widget instance when the view's viewpoint updates. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#autoCollapse) - * + * * @default false */ autoCollapse?: boolean; /** * This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the [view.ui](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ui). For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the `top-left` group, then the first instance is collapsed, allowing the content of the second instance to be fully visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#group) */ group?: string; /** * The view in which the Expand is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand-ExpandViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -50549,69 +50549,69 @@ declare namespace __esri { interface Feature extends Widget { /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) - * + * * @default null */ graphic: Graphic; /** * The title for the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) - * + * * @default null */ readonly title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#view) - * + * * @default null */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FeatureViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#viewModel) */ viewModel: FeatureViewModel; /** * Paginates to a specified [media](esri-PopupTemplate.html#media) info object. For example, you may have [media](esri-PopupTemplate.html#media) content which contains multiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos` you wish to display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#goToMedia) - * + * * @param contentElementIndex The index position of the [media](esri-PopupTemplate.html#media) content element to be updated. * @param mediaInfoIndex The index position of the [media](esri-PopupTemplate.html#media) info object you wish to display. - * + * */ goToMedia(contentElementIndex: number, mediaInfoIndex: number): void; /** * Paginates to the next [media](esri-PopupTemplate.html#media) info. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#nextMedia) - * + * * @param contentElementIndex The index position of the [media](esri-PopupTemplate.html#media) content element. - * + * */ nextMedia(contentElementIndex: number): void; /** * Paginates to the previous [media](esri-PopupTemplate.html#media) info in the specified [media](esri-PopupTemplate.html#media) content element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#previousMedia) - * + * * @param contentElementIndex The index position of the [media](esri-PopupTemplate.html#media) content element. - * + * */ previousMedia(contentElementIndex: number): void; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#render) - * - * + * + * */ render(): any; } @@ -50627,23 +50627,23 @@ declare namespace __esri { interface FeatureProperties extends WidgetProperties { /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) - * + * * @default null */ graphic?: GraphicProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#view) - * + * * @default null */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FeatureViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#viewModel) */ viewModel?: FeatureViewModelProperties; @@ -50652,9 +50652,9 @@ declare namespace __esri { interface FeatureViewModel extends Accessor { /** * The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#content) - * + * * @default null */ readonly content: string | any[] | HTMLElement | Widget; @@ -50662,41 +50662,41 @@ declare namespace __esri { * The formatted attributes calculated from `fieldInfo` [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content. They are obtained from the feature's [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) attribute values and can be read: * * globally using the [fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) property directly at the root level of the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), or * * per an individual content element. This element is defined with a type of fields on the PopupTemplate's content property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#formattedAttributes) - * + * * @default null */ readonly formattedAttributes: FeatureViewModelFormattedAttributes; /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) - * + * * @default null */ graphic: Graphic; /** * The title for the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#title) - * + * * @default null */ readonly title: string; /** * The view associated with the Feature instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#view) - * + * * @default null */ view: MapView | SceneView; /** * Indicates whether the feature is currently waiting for all of its content to finish loading. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#waitingForContent) - * + * * @default true */ readonly waitingForContent: boolean; @@ -50713,17 +50713,17 @@ declare namespace __esri { interface FeatureViewModelProperties { /** * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#graphic) - * + * * @default null */ graphic?: GraphicProperties; /** * The view associated with the Feature instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#view) - * + * * @default null */ view?: MapViewProperties | SceneViewProperties; @@ -50733,13 +50733,13 @@ declare namespace __esri { export interface FeatureViewModelFormattedAttributes extends Object { /** * The formatted attributes specified at the root level of the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) using the [PopupTemplate.fieldInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#fieldInfos) property. - * + * * [Read more...](global.html) */ global?: any; /** * The formatted attributes for an individual content element. This is derived from the module:esri/PopupTemplate#fields content property of the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) defined as type `fields`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#formattedAttributes) */ content?: any; @@ -50748,52 +50748,52 @@ declare namespace __esri { interface FeatureForm extends Widget { /** * The associated feature containing the editable attributes. A common way to access this is via the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) or [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) `hitTest()` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#feature) */ feature: Graphic; /** - * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. + * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. * > When not set, all fields except for `editor`, `globalID`, and `objectID` fields will be included, otherwise it is up to the developer to set the right field(s) to override and display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#fieldConfig) */ fieldConfig: FieldConfig[]; /** * Layer containing the editable feature attributes. If this layer is not specified, it is the same as the [graphic's layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer) */ layer: FeatureLayer; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FeatureFormViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#viewModel) */ viewModel: FeatureFormViewModel; /** * Returns all of the field values, regardless of whether or not they were updated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#getValues) - * - * + * + * */ getValues(): any; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#render) - * - * + * + * */ render(): any; /** * Fires the [submit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#event:submit) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#submit) - * - * + * + * */ submit(): void; } @@ -50801,7 +50801,7 @@ declare namespace __esri { interface FeatureFormConstructor { /** * The FeatureForm widget displays attributes of a feature. This widget renders input fields based on the feature's attributes and whether the field allows editing. Use this widget, in combination with [FeatureLayer.applyEdits](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#applyEdits), to enable an end user to update a feature's attribute on a specified editable feature layer(s). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) */ @@ -50813,26 +50813,26 @@ declare namespace __esri { interface FeatureFormProperties extends WidgetProperties { /** * The associated feature containing the editable attributes. A common way to access this is via the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) or [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) `hitTest()` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#feature) */ feature?: GraphicProperties; /** - * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. + * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. * > When not set, all fields except for `editor`, `globalID`, and `objectID` fields will be included, otherwise it is up to the developer to set the right field(s) to override and display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#fieldConfig) */ fieldConfig?: FieldConfigProperties[]; /** * Layer containing the editable feature attributes. If this layer is not specified, it is the same as the [graphic's layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer) */ layer?: FeatureLayerProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FeatureFormViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#viewModel) */ viewModel?: FeatureFormViewModelProperties; @@ -50841,58 +50841,58 @@ declare namespace __esri { interface FeatureFormViewModel extends Accessor, Evented { /** * The associated feature containing the editable attributes. A common way to access this is via the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) or [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) `hitTest()` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#feature) */ feature: Graphic; /** - * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. + * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. * > When not set, all fields except for `editor`, `globalID`, and `objectID` fields will be included, otherwise it is up to the developer to set the right field(s) to override and display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#fieldConfig) */ fieldConfig: FieldConfig[]; /** * The input fields to be rendered by the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#inputField) */ readonly inputField: InputField[]; /** * Layer containing the editable feature attributes. If this layer is not specified, it is the same as the [graphic's layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#layer) */ layer: FeatureLayer; /** - * The widget's state. Possible values are in the table below. - * + * The widget's state. Possible values are in the table below. + * * Value | Description * ------|------------ * ready | Dependencies are met and has valid property values. * disabled | Dependencies are missing and cannot provide valid inputs. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * Returns all of the field values, regardless of whether or not they were updated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#getValues) - * - * + * + * */ getValues(): any; /** * Fires the [submit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#event:submit) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#submit) - * - * + * + * */ submit(): void; } @@ -50900,7 +50900,7 @@ declare namespace __esri { interface FeatureFormViewModelConstructor { /** * Provides the logic for the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html) */ @@ -50912,20 +50912,20 @@ declare namespace __esri { interface FeatureFormViewModelProperties { /** * The associated feature containing the editable attributes. A common way to access this is via the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#hitTest) or [SceneView's](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest) `hitTest()` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#feature) */ feature?: GraphicProperties; /** - * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. + * Array of field configuration objects. This is where you specify what fields to display and how you wish to display them. * > When not set, all fields except for `editor`, `globalID`, and `objectID` fields will be included, otherwise it is up to the developer to set the right field(s) to override and display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#fieldConfig) */ fieldConfig?: FieldConfigProperties[]; /** * Layer containing the editable feature attributes. If this layer is not specified, it is the same as the [graphic's layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#layer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#layer) */ layer?: FeatureLayerProperties; @@ -50934,13 +50934,13 @@ declare namespace __esri { interface FieldConfig extends Accessor { /** * The field name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldConfig.html#name) */ name: string; /** * The field options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldConfig.html#options) */ options: FieldOptions; @@ -50957,13 +50957,13 @@ declare namespace __esri { interface FieldConfigProperties { /** * The field name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldConfig.html#name) */ name?: string; /** * The field options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldConfig.html#options) */ options?: FieldOptionsProperties; @@ -50972,75 +50972,75 @@ declare namespace __esri { interface FieldOptions extends Accessor { /** * The field's description. The description is shown below the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#description) */ description: string; /** - * The field's domain. This is used to constrain the allowable values of the layer. + * The field's domain. This is used to constrain the allowable values of the layer. * > This only applies to relevant field types. For example, [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) only applies to `numeric` and `date` field types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#domain) */ domain: CodedValueDomain | RangeDomain; /** - * Indicates whether the field is editable. + * Indicates whether the field is editable. * > This does not change the underlying service's field and whether it is editable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#editable) - * + * * @default true */ editable: boolean; /** - * The type of editor to use for `string` field types. Possible values are in the table below. - * + * The type of editor to use for `string` field types. Possible values are in the table below. + * * Value | Description * ------|------------ * text-box | An HTML textbox will be used to capture input. * text-area | An HTML textarea will be used to capture input. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#editorType) - * + * * @default "text-box" */ editorType: string; /** * This property is rendered as a tooltip in the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. It displays a hint for the attribute field's value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#hint) */ hint: string; /** * The field's label. The label is shown above the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#label) */ label: string; /** - * Restricts the input length. + * Restricts the input length. * > This only applies to `numeric` and `text` field types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#maxLength) - * + * * @default -1 */ maxLength: number; /** - * Indicates whether the field is required. - * > This cannot change the underlying service's field requirements. - * + * Indicates whether the field is required. + * > This cannot change the underlying service's field requirements. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#required) - * + * * @default false */ required: boolean; /** * When `true`, the field is displayed. Otherwise, it is hidden. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#visible) - * + * * @default true */ visible: boolean; @@ -51057,75 +51057,75 @@ declare namespace __esri { interface FieldOptionsProperties { /** * The field's description. The description is shown below the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#description) */ description?: string; /** - * The field's domain. This is used to constrain the allowable values of the layer. + * The field's domain. This is used to constrain the allowable values of the layer. * > This only applies to relevant field types. For example, [RangeDomain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-RangeDomain.html) only applies to `numeric` and `date` field types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#domain) */ domain?: CodedValueDomainProperties | RangeDomainProperties; /** - * Indicates whether the field is editable. + * Indicates whether the field is editable. * > This does not change the underlying service's field and whether it is editable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#editable) - * + * * @default true */ editable?: boolean; /** - * The type of editor to use for `string` field types. Possible values are in the table below. - * + * The type of editor to use for `string` field types. Possible values are in the table below. + * * Value | Description * ------|------------ * text-box | An HTML textbox will be used to capture input. * text-area | An HTML textarea will be used to capture input. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#editorType) - * + * * @default "text-box" */ editorType?: string; /** * This property is rendered as a tooltip in the [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) widget. It displays a hint for the attribute field's value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#hint) */ hint?: string; /** * The field's label. The label is shown above the field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#label) */ label?: string; /** - * Restricts the input length. + * Restricts the input length. * > This only applies to `numeric` and `text` field types. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#maxLength) - * + * * @default -1 */ maxLength?: number; /** - * Indicates whether the field is required. - * > This cannot change the underlying service's field requirements. - * + * Indicates whether the field is required. + * > This cannot change the underlying service's field requirements. + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#required) - * + * * @default false */ required?: boolean; /** * When `true`, the field is displayed. Otherwise, it is hidden. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FieldOptions.html#visible) - * + * * @default true */ visible?: boolean; @@ -51134,107 +51134,107 @@ declare namespace __esri { interface InputField extends Accessor { /** * The field's description. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#description) */ readonly description: string; /** * The input value's domain. This is used to constrain the allowable values of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#domain) */ readonly domain: CodedValueDomain | RangeDomain; /** * When true, the field is editable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#editable) */ readonly editable: boolean; /** - * The type of editor used when working with `string` fields. Possible values are in the table below. - * + * The type of editor used when working with `string` fields. Possible values are in the table below. + * * Value | Description * ------|------------ * text-box | An HTML textbox used to capture input. * text-area | An HTML textarea used to capture input. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#editorType) - * + * * @default "text-box" */ readonly editorType: string; /** * If the input field's value is invalid, this property returns validation error code. Otherwise, it is `null`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#error) */ readonly error: string; /** * A user-friendly formatted error message based on the [validation error code](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#error). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#errorMessage) */ readonly errorMessage: string; /** * A hint for the field's value. This property is rendered as a tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#hint) */ readonly hint: string; /** * The field's label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#label) */ readonly label: string; /** * Restricts the input length. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#maxLength) */ readonly maxLength: number; /** * The associated field name. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#name) */ readonly name: string; /** * Indicates whether the field is required. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#required) */ readonly required: boolean; /** - * The type of input field. Possible values are listed below. - * + * The type of input field. Possible values are listed below. + * * Value | Description * ------|------------ * number | Input represents a number. * text | Input represents text. * date | Input represents a date. * unsupported | The field represents an unsupported value. A `blob` field type is an example of this. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#type) */ readonly type: string; /** * When `true`, the input value is invalid. Otherwise, it is valid. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#valid) */ readonly valid: boolean; /** * The input's value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#value) */ readonly value: number | string | any; /** * When `true`, the field is displayed. Otherwise, it is hidden. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-InputField.html#visible) */ readonly visible: boolean; @@ -51255,29 +51255,29 @@ declare namespace __esri { interface Fullscreen extends Widget { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#element) */ element: HTMLElement; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FullscreenViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#viewModel) */ viewModel: FullscreenViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#render) - * - * + * + * */ render(): any; } @@ -51285,7 +51285,7 @@ declare namespace __esri { interface FullscreenConstructor { /** * Provides a simple widget to present the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) or a user-defined [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) using the entire screen. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html) */ @@ -51297,19 +51297,19 @@ declare namespace __esri { interface FullscreenProperties extends WidgetProperties { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#element) */ element?: HTMLElement; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [FullscreenViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen.html#viewModel) */ viewModel?: FullscreenViewModelProperties; @@ -51318,47 +51318,47 @@ declare namespace __esri { interface FullscreenViewModel extends Accessor { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#element) */ element: HTMLElement; /** * The view model's state. **Possible Values:** active | ready | feature-unsupported | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view associated with the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#view) */ view: MapView | SceneView; /** * Enter fullscreen - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#enter) - * - * + * + * */ enter(): void; /** * Exit fullscreen - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#exit) - * - * + * + * */ exit(): void; /** * Toggle fullscreen - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#toggle) - * - * + * + * */ toggle(): void; } @@ -51374,13 +51374,13 @@ declare namespace __esri { interface FullscreenViewModelProperties { /** * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#element) */ element?: HTMLElement; /** * The view associated with the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -51389,60 +51389,60 @@ declare namespace __esri { interface Home extends Widget, GoTo { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#label) */ readonly label: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [HomeViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewModel) */ viewModel: HomeViewModel; /** - * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: + * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: * * If no [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is provided, the value is `null`. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready, but the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is not defined, the initial value of the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is determined when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) became ready. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready and the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is defined by the user, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint) */ viewpoint: Viewpoint; /** * This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#cancelGo) - * - * + * + * */ cancelGo(): void; /** * Animates the view to the initial Viewpoint of the view or the value of [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#go) - * - * + * + * */ go(): void; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#render) - * - * + * + * */ render(): any; } @@ -51450,7 +51450,7 @@ declare namespace __esri { interface HomeConstructor { /** * Provides a simple widget that switches the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to its initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or a previously defined [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint). By default this button looks like the following: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html) */ @@ -51462,22 +51462,22 @@ declare namespace __esri { interface HomeProperties extends WidgetProperties, GoToProperties { /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [HomeViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewModel) */ viewModel?: HomeViewModelProperties; /** - * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: + * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: * * If no [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is provided, the value is `null`. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready, but the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is not defined, the initial value of the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is determined when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) became ready. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready and the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is defined by the user, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home.html#viewpoint) */ viewpoint?: ViewpointProperties; @@ -51486,44 +51486,44 @@ declare namespace __esri { interface HomeViewModel extends Accessor, Evented, GoTo { /** * The current state of the widget. **Possible Values:** disabled | ready | going-home - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view associated with the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#view) */ view: MapView | SceneView; /** - * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: + * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: * * If no [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is provided, the value is `null`. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready, but the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is not defined, the initial value of the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is determined when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) became ready. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready and the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is defined by the user, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint) - * + * * @default null */ viewpoint: Viewpoint; /** * This function provides the ability to interrupt and cancel the process of navigating the view back to the view's initial extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#cancelGo) - * - * + * + * */ cancelGo(): void; /** * Animates the view to the initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) of the view or the value of [viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#go) - * - * + * + * */ go(): void; } @@ -51539,18 +51539,18 @@ declare namespace __esri { interface HomeViewModelProperties extends GoToProperties { /** * The view associated with the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; /** - * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: + * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html), or point of view, to zoom to when going home. The initial value is determined a few different ways: * * If no [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is provided, the value is `null`. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready, but the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is not defined, the initial value of the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is determined when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) became ready. * * If the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is ready and the [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) is defined by the user, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#viewpoint) - * + * * @default null */ viewpoint?: ViewpointProperties; @@ -51559,65 +51559,65 @@ declare namespace __esri { interface LayerList extends Widget { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#label) */ readonly label: string; /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). Each list item can be modified according to its modifiable properties. Actions can be added to list items using the [actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) property of the ListItem. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) */ listItemCreatedFunction: ListItemCreatedHandler; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#operationalItems) */ readonly operationalItems: Collection; /** * Option for enabling status indicators, which indicate whether or not each layer is loading resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#statusIndicatorsVisible) - * + * * @default true */ statusIndicatorsVisible: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [LayerListViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel) */ viewModel: LayerListViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#render) - * - * + * + * */ render(): any; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#event:trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#triggerAction) - * + * * @param action The action to execute. * @param item An item associated with the action. - * + * */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; } @@ -51633,27 +51633,27 @@ declare namespace __esri { interface LayerListProperties extends WidgetProperties { /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). Each list item can be modified according to its modifiable properties. Actions can be added to list items using the [actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) property of the ListItem. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) */ listItemCreatedFunction?: ListItemCreatedHandler; /** * Option for enabling status indicators, which indicate whether or not each layer is loading resources. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#statusIndicatorsVisible) - * + * * @default true */ statusIndicatorsVisible?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [LayerListViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#viewModel) */ viewModel?: LayerListViewModelProperties; @@ -51662,39 +51662,39 @@ declare namespace __esri { interface LayerListViewModel extends Accessor { /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). Each list item can be modified according to its modifiable propeties. Actions can be added to list items using the [actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) property of the ListItem. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction) */ listItemCreatedFunction: Function; /** * A collection of [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#operationalItems) */ readonly operationalItems: Collection; /** * The view model's state. **Possible Values:** loading | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#view) */ view: MapView | SceneView; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#event:trigger-action) event and executes the given [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#triggerAction) - * + * * @param action The action to execute. * @param item An item associated with the action. - * + * */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; } @@ -51710,13 +51710,13 @@ declare namespace __esri { interface LayerListViewModelProperties { /** * Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html). Each list item can be modified according to its modifiable propeties. Actions can be added to list items using the [actionsSections](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) property of the ListItem. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction) */ listItemCreatedFunction?: Function; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -51725,115 +51725,115 @@ declare namespace __esri { interface ListItem { /** * Whether the actional panel is open in the LayerList. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsOpen) - * + * * @default false */ actionsOpen: boolean; /** * A nested 2-dimensional collection of actions that could be triggered on the item. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#actionsSections) */ actionsSections: Collection>; /** * When a layer contains sublayers, this property is a Collection of ListItem objects belonging to the given layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#children) */ children: Collection; /** * The Error object returned if an error occurred. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#error) */ readonly error: Error; /** * The layer associated with the triggered action. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer) - * + * * @default null */ layer: Layer; /** * The [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) displaying data for the associated [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layer). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#layerView) */ readonly layerView: LayerView; /** * Whether the layer is open in the LayerList. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#open) - * + * * @default false */ open: boolean; /** * Allows you to display custom content for each ListItem in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. A common scenario for using ListItemPanel is to display a [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget within each list item. The `legend` keyword can be used in the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#content) property of the panel to display a legend for each layer in the LayerList. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#panel) */ panel: ListItemPanel; /** * The parent of this item - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#parent) - * + * * @default null */ parent: ListItem; /** * The title of the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#title) */ title: string; /** * Value is `true` when the layer is updating; for example, if it is in the process of fetching data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#updating) - * + * * @default false */ readonly updating: boolean; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#view) */ view: MapView | SceneView; /** * Indicates how to manage the visibility of the children layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visibilityMode) */ readonly visibilityMode: string; /** * Indicates if the ListItem is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visible) - * + * * @default true */ visible: boolean; /** * Whether the layer is visible at the current scale or not. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#visibleAtCurrentScale) - * + * * @default true */ readonly visibleAtCurrentScale: boolean; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html#clone) - * - * + * + * */ clone(): ListItem; } @@ -51850,49 +51850,49 @@ declare namespace __esri { interface ListItemPanel { /** * Adds a CSS class used to style a node that represents the panel. Clicking the node will open and close the panel. Typically, an icon font is used for this property. [Esri Icon Fonts](https://developers.arcgis.com/javascript/latest/guide/esri-icon-font/index.html) are automatically made available and can be used to represent this content. To use one of these provided icon fonts, you must prefix the class name with `esri-`. For example, the default icon font is `esri-icon-layer-list`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#className) - * + * * @default esri-icon-layer-list */ className: string; /** * The content displayed in the ListItem panel. This can be raw text, a [Widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) instance, an HTML Element, or an array of any of those elements. If the text `legend` is used, then an instance of the [Legend](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) widget is placed in the content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#content) */ content: Widget | HTMLElement | string | any[]; /** * The URL or data URI of an image used to represent the panel. This property will be used as a background image for the node. If neither `image` nor `className` are specified, a default icon ![default icon](https://developers.arcgis.com/javascript/assets/img/guide/whats-new/41/default-action.png) will display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#image) */ image: string; /** * The panel's parent ListItem that represents a layer in the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#listItem) */ listItem: ListItem; /** * Indicates if the panel's content is open and visible to the user. This is different from the [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#visible) property, which is used for toggling the visibility of the icon used to control whether the content is expanded or collapsed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#open) - * + * * @default false */ open: boolean; /** * The title of the panel. By default, this title matches the ListItem's title. Changing this value will not change the title of the ListItem in the LayerList. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#title) */ title: string; /** * Indicates if the node containing the [image](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#image) or [icon font](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#className) is visible to the user. Setting this value to `false` will prevent the user from toggling the visibility of the panel's content. Use [open](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#open) to programmatically set the visibility of the panel's content. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html#visible) - * + * * @default true */ visible: boolean; @@ -51901,7 +51901,7 @@ declare namespace __esri { interface ListItemPanelConstructor { /** * This class allows you to display custom content for each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. ListItemPanel objects typically aren't constructed. Rather, they are modified using the [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction) property in the [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItemPanel.html) */ @@ -51916,43 +51916,43 @@ declare namespace __esri { interface Legend extends Widget { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#label) */ readonly label: string; /** * Specifies a subset of the layers to display in the legend. If this property is not set, all layers in the map will display in the legend. Objects in this array are defined with the properties listed below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layerInfos: LegendLayerInfos[]; /** * Indicates the style of the legend. The style determines the legend's layout and behavior. You can either specify a string or an object to indicate the style. The known string values are the same values listed in the table within the `type` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) - * + * * @default classic */ style: string | LegendStyle; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#view) */ view: MapView | SceneView; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#render) - * - * + * + * */ render(): any; } @@ -51960,7 +51960,7 @@ declare namespace __esri { interface LegendConstructor { /** * The Legend widget displays labels and symbols for layers in a map. Labels and their corresponding symbols depend on the values set in the [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) of the layer. The legend will only display layers and sublayers that are visible in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html) */ @@ -51972,21 +51972,21 @@ declare namespace __esri { interface LegendProperties extends WidgetProperties { /** * Specifies a subset of the layers to display in the legend. If this property is not set, all layers in the map will display in the legend. Objects in this array are defined with the properties listed below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layerInfos?: LegendLayerInfos[]; /** * Indicates the style of the legend. The style determines the legend's layout and behavior. You can either specify a string or an object to indicate the style. The known string values are the same values listed in the table within the `type` property. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) - * + * * @default classic */ style?: string | LegendStyle; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -51996,13 +51996,13 @@ declare namespace __esri { export interface LegendLayerInfos extends Object { /** * Specifies a title for the layer to display above its symbols and descriptions. If no title is specified the service name is used. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ title?: string; /** * A layer to display in the legend. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos) */ layer: Layer; @@ -52011,29 +52011,29 @@ declare namespace __esri { export interface LegendStyle extends Object { /** - * Specifies the style of the legend. There are two possible values listed in the table below: - * + * Specifies the style of the legend. There are two possible values listed in the table below: + * * Value | Description * ------|------------ * classic | The legend has a portrait orientation. The user can scroll vertically when many elements are included in the legend's content. * card | In wide views, the legend has a landscape orientation that allows users to scroll horizontally to view all legend elements. This style can be responsive, making it ideal for mobile web apps. In smaller views, the legend collapses to occupy less space. One element is shown at a time in a card-style layout, which the user can navigate horizontally. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) */ type: string; /** - * When a `card` type is specified, you can specify one of the following layout options. - * + * When a `card` type is specified, you can specify one of the following layout options. + * * Value | Description * ------|------------ * auto | This layout is responsive so that in wide views the legend has a `side-by-side` layout, and a `stack` layout in smaller (mobile) views. * side-by-side | The legend has a landscape orientation that allows users to scroll horizontally to view multiple legend cards at a time. * stack | The legend cards are stacked, which conserves space, but restricts the user to seeing only one card at a time. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style) - * + * * @default stack */ layout?: string; @@ -52042,89 +52042,89 @@ declare namespace __esri { interface Locate extends Widget, GoTo { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions: any; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#graphic) */ graphic: Graphic; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#iconClass) */ iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#label) */ readonly label: string; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#event:track) event. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. For 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) and [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#scale) - * + * * @default null */ scale: number; /** * Indicates whether the widget will automatically [rotate to user's direction](https://www.w3.org/TR/geolocation-API/#coordinates_interface). Set to `false` to disable this behavior. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#useHeadingEnabled) - * + * * @default true */ useHeadingEnabled: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [LocateViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#viewModel) */ viewModel: LocateViewModel; /** * This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#cancelLocate) - * - * + * + * */ cancelLocate(): void; /** * Animates the view to the user's location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#locate) - * - * + * + * */ locate(): IPromise; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#render) - * - * + * + * */ render(): any; } @@ -52132,7 +52132,7 @@ declare namespace __esri { interface LocateConstructor { /** * Provides a simple widget that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location. The view rotates according to the direction where the tracked device is heading towards. By default the widget looks like the following: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html) */ @@ -52144,57 +52144,57 @@ declare namespace __esri { interface LocateProperties extends WidgetProperties, GoToProperties { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions?: any; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#graphic) */ graphic?: GraphicProperties; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#iconClass) */ iconClass?: string; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#event:track) event. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. For 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) and [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#scale) - * + * * @default null */ scale?: number; /** * Indicates whether the widget will automatically [rotate to user's direction](https://www.w3.org/TR/geolocation-API/#coordinates_interface). Set to `false` to disable this behavior. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#useHeadingEnabled) - * + * * @default true */ useHeadingEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [LocateViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html#viewModel) */ viewModel?: LocateViewModelProperties; @@ -52203,27 +52203,27 @@ declare namespace __esri { interface LocateViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { /** * The current state of the widget. **Possible Values:** disabled | ready | locating - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#cancelLocate) - * - * + * + * */ cancelLocate(): void; /** * Animates the view to the user's location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) - * - * + * + * */ locate(): IPromise; } @@ -52231,7 +52231,7 @@ declare namespace __esri { interface LocateViewModelConstructor { /** * Provides the logic for the [Locate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html) widget, which animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html) */ @@ -52247,57 +52247,57 @@ declare namespace __esri { interface NavigationToggle extends Widget { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#label) */ readonly label: string; /** - * Sets the layout of the widget to either `horizontal` or `vertical`. See the table below for a list of possible values. - * + * Sets the layout of the widget to either `horizontal` or `vertical`. See the table below for a list of possible values. + * * Possible Value | Example * ---------------|-------- * vertical | ![navigation-toggle](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/navigation-toggle.png) * horizontal | ![navigation-toggle-horizontal](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/navigation-toggle-horizontal.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#layout) - * + * * @default vertical */ layout: string; /** * A reference to the SceneView. Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) */ view: SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [NavigationToggleViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#viewModel) */ viewModel: NavigationToggleViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#render) - * - * + * + * */ render(): any; /** * Toggles the navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) from `pan` to `rotate` or vice versa. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#toggle) - * - * + * + * */ toggle(): void; } @@ -52305,7 +52305,7 @@ declare namespace __esri { interface NavigationToggleConstructor { /** * Provides two simple buttons for toggling the [navigation mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Note that this widget is designed only for 3D mouse interaction in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). It has no effect on touch navigation and it should not be used with 2D mouse interaction in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html) */ @@ -52316,28 +52316,28 @@ declare namespace __esri { interface NavigationToggleProperties extends WidgetProperties { /** - * Sets the layout of the widget to either `horizontal` or `vertical`. See the table below for a list of possible values. - * + * Sets the layout of the widget to either `horizontal` or `vertical`. See the table below for a list of possible values. + * * Possible Value | Example * ---------------|-------- * vertical | ![navigation-toggle](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/navigation-toggle.png) * horizontal | ![navigation-toggle-horizontal](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/navigation-toggle-horizontal.png) - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#layout) - * + * * @default vertical */ layout?: string; /** * A reference to the SceneView. Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#view) */ view?: SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [NavigationToggleViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html#viewModel) */ viewModel?: NavigationToggleViewModelProperties; @@ -52345,40 +52345,40 @@ declare namespace __esri { interface NavigationToggleViewModel extends Accessor { /** - * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). See the table below for a list of possible values. - * + * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------- * pan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view. * rotate | The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) - * + * * @default pan */ navigationMode: string; /** * The state of the widget. **Possible Values:** disabled | ready - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view associated with the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) */ view: SceneView; /** * Toggles the navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) from `pan` to `rotate` or vice versa. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#toggle) - * - * + * + * */ toggle(): void; } @@ -52386,7 +52386,7 @@ declare namespace __esri { interface NavigationToggleViewModelConstructor { /** * Provides the logic for the [NavigationToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle.html) widget, which provides two simple buttons for toggling the [navigation mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Note that this is not designed for 2D mouse interaction in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html), nor for touch navigation. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html) */ @@ -52397,22 +52397,22 @@ declare namespace __esri { interface NavigationToggleViewModelProperties { /** - * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). See the table below for a list of possible values. - * + * The navigation mode of the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view). See the table below for a list of possible values. + * * Possible Value | Description * ---------------|------------- * pan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view. * rotate | The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode) - * + * * @default pan */ navigationMode?: string; /** * The view associated with the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-NavigationToggle-NavigationToggleViewModel.html#view) */ view?: SceneViewProperties; @@ -52421,196 +52421,196 @@ declare namespace __esri { interface Popup extends Widget, GoTo, Evented { /** * Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. You may override this action by removing it from the `actions` array or by setting the [overwriteActions](esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). The order of each action in the popup is the order in which they appear in the array. The [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the popup that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) */ actions: Collection; /** * Position of the popup in relation to the selected feature. **Possible Values:** auto | top-center | top-right | bottom-left | bottom-center | bottom-right | Function - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#alignment) - * + * * @default "auto" */ alignment: string | Function; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoCloseEnabled) - * + * * @default false */ autoCloseEnabled: boolean; /** * Indicates whether the popup displays its content. If `true`, only the header displays. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapsed) - * + * * @default false */ collapsed: boolean; /** * Indicates whether to enable collapse functionality for the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapseEnabled) - * + * * @default true */ collapseEnabled: boolean; /** * The content of the popup. When set directly on the Popup, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) */ content: string | HTMLElement | Widget; /** * Dock position in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). **Possible Values:** top-left | top-center | top-right | bottom-left | bottom-center | bottom-right - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#currentDockPosition) */ readonly currentDockPosition: string; /** * Indicates whether the placement of the popup is docked to the side of the view. Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) assigned to it. Rather it is attached to a side, the top, or the bottom of the view. See [dockOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) to override default options related to docking the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockEnabled) - * + * * @default false */ dockEnabled: boolean; /** * Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) assigned to it. Rather it is placed in one of the corners of the view or to the top or bottom of it. This property allows the developer to set various options for docking the popup. See the object specification table below to override default docking properties on the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ dockOptions: PopupDockOptions; /** * The number of selected [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) available to the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#featureCount) - * + * * @default 0 */ readonly featureCount: number; /** * Shows pagination for the popup if available. This allows the user to scroll through various [selected features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) using either arrows ![popup-pagination-arrows](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popup-pagination-arrows.png) or a menu. ![popup-feature-menu](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popup-pagination-menu.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#featureNavigationEnabled) */ featureNavigationEnabled: boolean; /** * An array of features associated with the popup. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). When more than one graphic exists in this array, the current content of the Popup is set based on the value of the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). This value is `null` if no features are associated with the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) */ features: Graphic[]; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#highlightEnabled) - * + * * @default true */ highlightEnabled: boolean; /** * Point used to position the popup. This is automatically set when viewing the popup by selecting a feature. If using the Popup to display content not related to features in the map, such as the results from a task, then you must set this property before making the popup [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) */ location: Point; /** * An array of pending Promises that have not yet been fulfilled. If there are no pending promises, the value is `null`. When the pending promises are resolved they are removed from this array and the features they return are pushed into the [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) */ promises: IPromise[]; /** * The selected feature accessed by the popup. The content of the Popup is determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) assigned to this feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) */ readonly selectedFeature: Graphic; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) are set, the first index is automatically selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeatureIndex) */ selectedFeatureIndex: number; /** * Indicates whether to display a spinner at the popup location prior to its display when it has pending promises. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#spinnerEnabled) */ spinnerEnabled: boolean; /** * The title of the popup. This can be set generically on the popup no matter the features that are selected. If the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the corresponding template is used here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) */ title: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#view) */ view: MapView | SceneView; /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [PopupViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#viewModel) */ viewModel: PopupViewModel; /** * Indicates whether the popup is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) */ visible: boolean; /** * Use this method to remove focus from the Widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#blur) - * - * + * + * */ blur(): void; /** * Removes [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises), [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content), [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) and [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) from the Popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#clear) - * - * + * + * */ clear(): void; /** * Closes the popup by setting its [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) property to `false`. Users can alternatively close the popup by directly setting the [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) property to `false`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#close) - * - * + * + * */ close(): void; /** * Use this method to give focus to the Widget if the widget is able to be focused. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#focus) - * - * + * + * */ focus(): void; /** * Selects the feature at the next index in relation to the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#next) - * - * + * + * */ next(): PopupViewModel; /** * Opens the popup at the given location with content defined either explicitly with `content` or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. This method sets the popup's [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) property to `true`. Users can alternatively open the popup by directly setting the [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) property to `true`. The popup will only display if the view's size constraints in [dockOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) are met or the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) property is set to a geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) - * + * * @param options Defines the location and content of the popup when opened. * @param options.title Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. * @param options.content Sets the the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup. @@ -52620,40 +52620,40 @@ declare namespace __esri { * @param options.featureMenuOpen **Since:** 4.5 This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features returned from the query and choose the selection they want to display within the popup. * @param options.updateLocationEnabled When `true` indicates the popup should update its [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) for each paginated feature based on the [selected feature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) geometry. * @param options.collapsed **Since:** 4.5 When `true`, indicates that only the popup header will display. - * + * */ open(options?: PopupOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#previous) - * - * + * + * */ previous(): PopupViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#render) - * - * + * + * */ render(): any; /** * Positions the popup on the view. Moves the popup into the view's extent if the popup is partially or fully outside the view's extent. If the popup is partially out of view, the view will move to fully show the popup. If the popup is fully out of view, the view will move to the popup's location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#reposition) - * - * + * + * */ reposition(): void; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#triggerAction) - * + * * @param actionIndex The index of the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) to execute. - * + * */ triggerAction(actionIndex: number): void; } @@ -52661,7 +52661,7 @@ declare namespace __esri { interface PopupConstructor { /** * The popup widget allows users to view content from feature attributes. Popups enhance web applications by providing users with a simple way to interact with and view attributes in a layer. They play an important role in relaying information to the user, which improves the storytelling capabilities of the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) */ @@ -52673,127 +52673,127 @@ declare namespace __esri { interface PopupProperties extends WidgetProperties, GoToProperties { /** * Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. You may override this action by removing it from the `actions` array or by setting the [overwriteActions](esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). The order of each action in the popup is the order in which they appear in the array. The [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the popup that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#actions) */ actions?: CollectionProperties; /** * Position of the popup in relation to the selected feature. **Possible Values:** auto | top-center | top-right | bottom-left | bottom-center | bottom-right | Function - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#alignment) - * + * * @default "auto" */ alignment?: string | Function; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#autoCloseEnabled) - * + * * @default false */ autoCloseEnabled?: boolean; /** * Indicates whether the popup displays its content. If `true`, only the header displays. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapsed) - * + * * @default false */ collapsed?: boolean; /** * Indicates whether to enable collapse functionality for the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#collapseEnabled) - * + * * @default true */ collapseEnabled?: boolean; /** * The content of the popup. When set directly on the Popup, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) */ content?: string | HTMLElement | WidgetProperties; /** * Indicates whether the placement of the popup is docked to the side of the view. Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) assigned to it. Rather it is attached to a side, the top, or the bottom of the view. See [dockOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) to override default options related to docking the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockEnabled) - * + * * @default false */ dockEnabled?: boolean; /** * Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) assigned to it. Rather it is placed in one of the corners of the view or to the top or bottom of it. This property allows the developer to set various options for docking the popup. See the object specification table below to override default docking properties on the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ dockOptions?: PopupDockOptions; /** * Shows pagination for the popup if available. This allows the user to scroll through various [selected features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) using either arrows ![popup-pagination-arrows](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popup-pagination-arrows.png) or a menu. ![popup-feature-menu](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popup-pagination-menu.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#featureNavigationEnabled) */ featureNavigationEnabled?: boolean; /** * An array of features associated with the popup. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). When more than one graphic exists in this array, the current content of the Popup is set based on the value of the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). This value is `null` if no features are associated with the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) */ features?: GraphicProperties[]; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#highlightEnabled) - * + * * @default true */ highlightEnabled?: boolean; /** * Point used to position the popup. This is automatically set when viewing the popup by selecting a feature. If using the Popup to display content not related to features in the map, such as the results from a task, then you must set this property before making the popup [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) */ location?: PointProperties; /** * An array of pending Promises that have not yet been fulfilled. If there are no pending promises, the value is `null`. When the pending promises are resolved they are removed from this array and the features they return are pushed into the [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) */ promises?: IPromise[]; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features) are set, the first index is automatically selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeatureIndex) */ selectedFeatureIndex?: number; /** * Indicates whether to display a spinner at the popup location prior to its display when it has pending promises. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#spinnerEnabled) */ spinnerEnabled?: boolean; /** * The title of the popup. This can be set generically on the popup no matter the features that are selected. If the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the corresponding template is used here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) */ title?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [PopupViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#viewModel) */ viewModel?: PopupViewModelProperties; /** * Indicates whether the popup is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#visible) */ visible?: boolean; @@ -52802,150 +52802,150 @@ declare namespace __esri { interface PopupViewModel extends Accessor, Evented, GoTo { /** * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. Each action may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. You may override this action by removing it from the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) or by setting the [overwriteActions](esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). The order of each action in the popup is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). The [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#event:trigger-action) event fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the popup that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#actions) */ actions: Collection; /** * A collection of [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggles](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) used within the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#allActions) */ readonly allActions: Collection; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#autoCloseEnabled) - * + * * @default false */ autoCloseEnabled: boolean; /** * The content of the popup. When set directly on the Popup, this content may only be static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#content) */ content: string | HTMLElement | Widget; /** * The number of selected [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) available to the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#featureCount) - * + * * @default 0 */ readonly featureCount: number; /** * An array of features associated with the popup. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#content) and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#title) of the poup is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). When more than one graphic exists in this array, the current content of the Popup is set based on the value of the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature). This value is `null` if no features are associated with the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) */ features: Graphic[]; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#highlightEnabled) - * + * * @default true */ highlightEnabled: boolean; /** * Geometry used to position the popup. This is automatically set when viewing the popup by selecting a feature. If using the Popup to display content not related to features in the map, such as the results from a task, then you must set this property before making the popup [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#visible) to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#location) */ location: Point; /** * The number of [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promises) remaining to be resolved. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#pendingPromisesCount) - * + * * @default 0 */ readonly pendingPromisesCount: number; /** * The number of selected [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promises) available to the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promiseCount) - * + * * @default 0 */ readonly promiseCount: number; /** * An array of pending Promises that have not yet been fulfilled. If there are no pending Promises, the value is `null`. When the pending Promises are resolved they are removed from this array and the features they return are pushed into the [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promises) */ promises: IPromise[]; /** * The selected feature accessed by the popup. The content of the Popup is determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) assigned to this feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature) */ readonly selectedFeature: Graphic; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) are set, the first index is automatically selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeatureIndex) */ selectedFeatureIndex: number; /** * The view model's state. **Possible Values:** ready | disabled - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The title of the popup. This can be set generically on the popup no matter the features that are selected. If the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature) has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the corresponding template is used here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#title) */ title: string; /** * The view associated with the Popup instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#view) */ view: MapView | SceneView; /** * Indicates whether the popup is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#visible) */ visible: boolean; /** * Removes [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promises), [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features), [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#content), [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#title) and [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#location) from the Popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#clear) - * - * + * + * */ clear(): void; /** * Selects the feature at the next index in relation to the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#next) - * - * + * + * */ next(): PopupViewModel; /** * Selects the feature at the previous index in relation to the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#previous) - * - * + * + * */ previous(): PopupViewModel; /** * Triggers the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#event:trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#actions) at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#actions) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#triggerAction) - * + * * @param actionIndex The index of the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#actions) to execute. - * + * */ triggerAction(actionIndex: number): void; @@ -52956,7 +52956,7 @@ declare namespace __esri { interface PopupViewModelConstructor { /** * Provides the logic for the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) widget, which allows users to view content from feature attributes. Popups enhance web applications by providing users with a simple way to interact with and view attributes in a layer. They play an important role in relaying information to the user, which improves the storytelling capabilities of the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html) */ @@ -52968,71 +52968,71 @@ declare namespace __esri { interface PopupViewModelProperties extends GoToProperties { /** * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects. Each action may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a `zoom-to` action styled with a magnifying glass icon ![popupTemplate-zoom-action](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/popuptemplate-zoom-action.png). When this icon is clicked, the view zooms in four LODs and centers on the selected feature. You may override this action by removing it from the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) or by setting the [overwriteActions](esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). The order of each action in the popup is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html). The [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#event:trigger-action) event fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a `zoom-out` action to the popup that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom `zoom-out` function in the [trigger-action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#event:trigger-action) event handler. See the sample code snippet below for more details on how this works. Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#actions) */ actions?: CollectionProperties; /** * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#autoCloseEnabled) - * + * * @default false */ autoCloseEnabled?: boolean; /** * The content of the popup. When set directly on the Popup, this content may only be static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#content) */ content?: string | HTMLElement | WidgetProperties; /** * An array of features associated with the popup. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#content) and [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#title) of the poup is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). When more than one graphic exists in this array, the current content of the Popup is set based on the value of the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature). This value is `null` if no features are associated with the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) */ features?: GraphicProperties[]; /** * Highlight the selected popup feature using the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlightOptions) set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions) set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#highlightEnabled) - * + * * @default true */ highlightEnabled?: boolean; /** * Geometry used to position the popup. This is automatically set when viewing the popup by selecting a feature. If using the Popup to display content not related to features in the map, such as the results from a task, then you must set this property before making the popup [visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#visible) to the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#location) */ location?: PointProperties; /** * An array of pending Promises that have not yet been fulfilled. If there are no pending Promises, the value is `null`. When the pending Promises are resolved they are removed from this array and the features they return are pushed into the [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) array. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#promises) */ promises?: IPromise[]; /** * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#features) are set, the first index is automatically selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeatureIndex) */ selectedFeatureIndex?: number; /** * The title of the popup. This can be set generically on the popup no matter the features that are selected. If the [selected feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#selectedFeature) has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the corresponding template is used here. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#title) */ title?: string; /** * The view associated with the Popup instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * Indicates whether the popup is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#visible) */ visible?: boolean; @@ -53047,21 +53047,21 @@ declare namespace __esri { export interface PopupDockOptions extends Object { /** * Defines the dimensions of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which to dock the popup. Set to `false` to disable docking at a breakpoint. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) - * + * * @default true */ breakpoint?: boolean | PopupDockOptionsBreakpoint; /** * If `true`, displays the dock button. If `false`, hides the dock button from the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) */ buttonEnabled?: boolean; /** - * The position in the view at which to dock the popup. Can be set as either a string or function. See the table below for known string values and their position in the view based on the view's size. - * + * The position in the view at which to dock the popup. Can be set as either a string or function. See the table below for known string values and their position in the view based on the view's size. + * * Known Value | View size > breakpoint | View size < breakpoint * --------------- | ------------------------------- | ------------- * auto | top-right | bottom 100% @@ -53071,10 +53071,10 @@ declare namespace __esri { * bottom-left | bottom-left | bottom 100% * bottom-center | bottom-center | bottom 100% * bottom-right | bottom-right | bottom 100% - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) - * + * * @default auto */ position?: string | Function; @@ -53084,17 +53084,17 @@ declare namespace __esri { export interface PopupDockOptionsBreakpoint extends Object { /** * The maximum width of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which the popup will be set to dockEnabled automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) - * + * * @default 544 */ width?: number; /** * The maximum height of the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) at which the popup will be set to dockEnabled automatically. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#dockOptions) - * + * * @default 544 */ height?: number; @@ -53104,55 +53104,55 @@ declare namespace __esri { export interface PopupOpenOptions extends Object { /** * Sets the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#title) of the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ title?: string; /** * Sets the the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#content) of the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ content?: string | HTMLElement | Widget; /** * Sets the popup's [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location), which is the geometry used to position the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ location?: Geometry; /** * Sets the popup's [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#features), which populate the title and content of the popup based on each graphic's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ features?: Graphic[]; /** * Sets pending [promises](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#promises) on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) */ promises?: IPromise[]; /** * **Since:** 4.5 This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features returned from the query and choose the selection they want to display within the popup. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) - * + * * @default false */ featureMenuOpen?: boolean; /** * When `true` indicates the popup should update its [location](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#location) for each paginated feature based on the [selected feature's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature) geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) - * + * * @default false */ updateLocationEnabled?: boolean; /** * **Since:** 4.5 When `true`, indicates that only the popup header will display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#open) - * + * * @default false */ collapsed?: boolean; @@ -53161,47 +53161,47 @@ declare namespace __esri { interface Print extends Widget { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#label) */ readonly label: string; /** * The URL of the REST endpoint of the Export Web Map Task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) */ printServiceUrl: string; /** * Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions) */ templateOptions: TemplateOptions; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#view) */ view: MapView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [PrintViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#viewModel) */ viewModel: PrintViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#render) - * - * + * + * */ render(): any; } @@ -53209,7 +53209,7 @@ declare namespace __esri { interface PrintConstructor { /** * The Print widget connects your application with a [printing service](https://server.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed. It takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS, which can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc. The Print widget works with the [PrintTask](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-PrintTask.html) which generates a printer-ready version of the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) */ @@ -53221,25 +53221,25 @@ declare namespace __esri { interface PrintProperties extends WidgetProperties { /** * The URL of the REST endpoint of the Export Web Map Task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl) */ printServiceUrl?: string; /** * Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions) */ templateOptions?: TemplateOptionsProperties; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#view) */ view?: MapViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [PrintViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#viewModel) */ viewModel?: PrintViewModelProperties; @@ -53248,32 +53248,32 @@ declare namespace __esri { interface PrintViewModel extends Accessor { /** * The URL of the REST endpoint of the Export Web Map Task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printServiceUrl) */ printServiceUrl: string; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#updateDelay) - * + * * @default 1000 */ updateDelay: number; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#view) */ view: MapView; /** * Prints (exports) the current MapView according to selected options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#print) - * + * * @param printTemplate The [PrintTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-PrintTemplate.html) is used to specify the layout template options which is then used by the PrintTask to generate the print page. - * + * */ print(printTemplate: PrintTemplate): IPromise; } @@ -53289,21 +53289,21 @@ declare namespace __esri { interface PrintViewModelProperties { /** * The URL of the REST endpoint of the Export Web Map Task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#printServiceUrl) */ printServiceUrl?: string; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#updateDelay) - * + * * @default 1000 */ updateDelay?: number; /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#view) */ view?: MapViewProperties; @@ -53312,57 +53312,57 @@ declare namespace __esri { interface TemplateOptions extends Accessor { /** * When `false`, the attribution is not displayed on the printout. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. Reference our policies on [Licensing & Attribution](https://developers.arcgis.com/javascript/latest/guide/licensing/) for specific attribution requirements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#attributionEnabled) - * + * * @default true */ attributionEnabled: boolean; /** * The text used for the author if the specified layout contains an author text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#author) */ author: string; /** * The text used for the copyright if the specified layout contains an copyright text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#copyright) */ copyright: string; /** * Resolution in dots per inch. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#dpi) - * + * * @default 96 */ dpi: string; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. By default they are removed to reduce the request size. Only applicable to custom print services which use the feature attributes, for example to display a table of features and their attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#forceFeatureAttributes) - * + * * @default false */ forceFeatureAttributes: boolean; /** * The output format for the printed map. **Possible Values:** pdf | png32 | png8 | jpg | gif | eps | svg | svgz - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) - * + * * @default pdf */ format: string; /** * Map height. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#height) */ height: number; /** * The layout used for the print output. When the value is `map-only` or is empty, the output map does not contain any page layout surroundings (for example, title, legend, scale bar and so forth). The print service provides out-of-the-box templates listed in possible values. The server administrator can add additional templates to the print service. Possible values are listed below: - * + * * Value | Description * | --- | --- * map-only | Map does not contain any layout elements. Only map image is printed. @@ -53374,38 +53374,38 @@ declare namespace __esri { * letter-ansi-a-portrait | Letter ANSI A Portrait * tabloid-ansi-b-landscape| Tabloid ANSI B Landscape * tabloid-ansi-b-portrait | Tabloid ANSI B Portrait - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) - * + * * @default letter-ansi-a-landscape */ layout: string; /** * When `false`, the legend is not displayed on the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#legendEnabled) - * + * * @default true */ legendEnabled: boolean; /** * When `true`, scale is used in the printed map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) - * + * * @default false */ scaleEnabled: boolean; /** * The text used for the map title if the specified layout contains a title text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) */ title: string; /** * Map width. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#width) */ width: number; @@ -53422,57 +53422,57 @@ declare namespace __esri { interface TemplateOptionsProperties { /** * When `false`, the attribution is not displayed on the printout. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. Reference our policies on [Licensing & Attribution](https://developers.arcgis.com/javascript/latest/guide/licensing/) for specific attribution requirements. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#attributionEnabled) - * + * * @default true */ attributionEnabled?: boolean; /** * The text used for the author if the specified layout contains an author text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#author) */ author?: string; /** * The text used for the copyright if the specified layout contains an copyright text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#copyright) */ copyright?: string; /** * Resolution in dots per inch. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#dpi) - * + * * @default 96 */ dpi?: string; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. By default they are removed to reduce the request size. Only applicable to custom print services which use the feature attributes, for example to display a table of features and their attributes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#forceFeatureAttributes) - * + * * @default false */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. **Possible Values:** pdf | png32 | png8 | jpg | gif | eps | svg | svgz - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#format) - * + * * @default pdf */ format?: string; /** * Map height. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#height) */ height?: number; /** * The layout used for the print output. When the value is `map-only` or is empty, the output map does not contain any page layout surroundings (for example, title, legend, scale bar and so forth). The print service provides out-of-the-box templates listed in possible values. The server administrator can add additional templates to the print service. Possible values are listed below: - * + * * Value | Description * | --- | --- * map-only | Map does not contain any layout elements. Only map image is printed. @@ -53484,38 +53484,38 @@ declare namespace __esri { * letter-ansi-a-portrait | Letter ANSI A Portrait * tabloid-ansi-b-landscape| Tabloid ANSI B Landscape * tabloid-ansi-b-portrait | Tabloid ANSI B Portrait - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) - * + * * @default letter-ansi-a-landscape */ layout?: string; /** * When `false`, the legend is not displayed on the printout. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#legendEnabled) - * + * * @default true */ legendEnabled?: boolean; /** * When `true`, scale is used in the printed map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) - * + * * @default false */ scaleEnabled?: boolean; /** * The text used for the map title if the specified layout contains a title text element. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) */ title?: string; /** * Map width. This only applies when the [layout](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#layout) value is `map-only`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#width) */ width?: number; @@ -53524,37 +53524,37 @@ declare namespace __esri { interface ScaleBar extends Widget { /** * The style for the scale bar. When `unit` is set to `dual`, the style will always be `line`. **Possible Values:** ruler | line - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#style) */ style: string; /** * Units to use for the scale bar. When using `dual`, the scale bar displays both metric and non-metric units. Metric values shows either kilometers or meters depending on the scale, and similarly non-metric values shows miles and feet depending on the scale. **Possible Values:** non-metric | metric | dual - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#unit) - * + * * @default non-metric (i.e. miles and feet) */ unit: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#view) */ view: MapView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ScaleBarViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#viewModel) */ viewModel: ScaleBarViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#render) - * - * + * + * */ render(): any; } @@ -53562,7 +53562,7 @@ declare namespace __esri { interface ScaleBarConstructor { /** * The ScaleBar widget displays a scale bar on the map or in a specified HTML node. The widget respects various coordinate systems and displays units in metric or non-metric values. Metric values shows either kilometers or meters depending on the scale, and likewise non-metric values shows miles and feet depending on the scale. When working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar. The ScaleBar sample, which uses a map using the Web Mercator projection, shows this behavior. Open the sample and note that as you pan the map south towards the equator the scale bar gets shorter and as you pan north it gets longer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html) */ @@ -53574,27 +53574,27 @@ declare namespace __esri { interface ScaleBarProperties extends WidgetProperties { /** * The style for the scale bar. When `unit` is set to `dual`, the style will always be `line`. **Possible Values:** ruler | line - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#style) */ style?: string; /** * Units to use for the scale bar. When using `dual`, the scale bar displays both metric and non-metric units. Metric values shows either kilometers or meters depending on the scale, and similarly non-metric values shows miles and feet depending on the scale. **Possible Values:** non-metric | metric | dual - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#unit) - * + * * @default non-metric (i.e. miles and feet) */ unit?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#view) */ view?: MapViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ScaleBarViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#viewModel) */ viewModel?: ScaleBarViewModelProperties; @@ -53603,7 +53603,7 @@ declare namespace __esri { interface ScaleBarViewModel extends Accessor { /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html#view) */ view: MapView; @@ -53620,7 +53620,7 @@ declare namespace __esri { interface ScaleBarViewModelProperties { /** * The view from which the widget will operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar-ScaleBarViewModel.html#view) */ view?: MapViewProperties; @@ -53629,238 +53629,238 @@ declare namespace __esri { interface widgetsSearch extends Widget, GoTo { /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) object currently selected. Can be either a [FeatureLayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) or a module:esri/widget/Search/LocatorSearchSource. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSource) - * + * * @default null */ readonly activeSource: FeatureLayerSearchSource | LocatorSearchSource; /** * The selected source's index. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSourceIndex) - * + * * @default 0 */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget. ![search-allPlaceholder](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-allplaceholder.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allPlaceholder) - * + * * @default "Find address or place" */ allPlaceholder: string; /** * Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a [search-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#event:search-complete) event handler and get the results through the event object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#autoSelect) - * + * * @default true */ autoSelect: boolean; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#iconClass) */ readonly iconClass: string; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. This can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources) - * + * * @default true */ includeDefaultSources: boolean | Function; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#label) */ readonly label: string; /** - * Enables location services within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) + * Enables location services within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) * > The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/Window/isSecureContext#Browser_compatibility) (currently Chrome and Firefox). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#locationEnabled) - * + * * @default true */ locationEnabled: boolean; /** * The maximum number of results returned by the widget if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxResults) - * + * * @default 6 */ maxResults: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. If working with the default [ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm), the default remains at `5`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * A customized PopupTemplate for the selected feature. Note that specifying a wildcard {*} for the popupTemplate will return all fields in addition to search-specific fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupTemplate) - * + * * @default null */ popupTemplate: PopupTemplate; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#portal) */ portal: Portal; /** - * The graphic used to highlight the resulting feature or location. + * The graphic used to highlight the resulting feature or location. * A graphic will be placed in the View's [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) for [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) that do not support the `highlight` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) */ readonly resultGraphic: Graphic; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) will display at the location of the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphicEnabled) - * + * * @default true */ resultGraphicEnabled: boolean; /** * An array of objects, each containing a [SearchResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) from the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#results) */ readonly results: any[]; /** * Indicates whether to display the option to search all sources. When `true`, the "All" option is displayed by default: ![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-true.png) When `false`, no option to search all sources at once is available: ![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-false.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchAllEnabled) - * + * * @default true */ searchAllEnabled: boolean; /** * The value of the search box input text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchTerm) */ searchTerm: string; /** * The result selected from a search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#selectedResult) */ readonly selectedResult: SearchResult; /** - * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) specified by the Search widget instance. There are two types of sources: + * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) specified by the Search widget instance. There are two types of sources: * * [FeatureLayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) * * [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html) - * - * + * + * * Any combination of these sources may be used together in the same instance of the Search widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) */ sources: Collection; /** * An array of results from the [suggest method](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). This is available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestions) */ readonly suggestions: SuggestResult[]; /** * Enable suggestions for the widget. This is only available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [SearchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#viewModel) */ viewModel: SearchViewModel; /** * Unfocuses the widget's text input. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#blur) - * - * + * + * */ blur(): void; /** * Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. It also hides any open menus. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#clear) - * - * + * + * */ clear(): void; /** * Brings focus to the widget's text input. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#focus) - * - * + * + * */ focus(): void; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#render) - * - * + * + * */ render(): any; /** * Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified [Locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html) and returns any applicable results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search) - * + * * @param searchTerm This searchTerm can be a string, geometry, suggest candidate object, or an array of [longitude,latitude] coordinate pairs. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text. - * + * */ search(searchTerm?: string | Geometry | SuggestResult | number[][]): IPromise; /** * Performs a suggest() request on the active Locator. It also uses the current value of the widget or one that is passed in. Suggestions are available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest) - * + * * @param value The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget. - * + * */ suggest(value?: string): IPromise; } @@ -53868,7 +53868,7 @@ declare namespace __esri { interface widgetsSearchConstructor { /** * The Search widget provides a way to perform search operations on [locator service(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html) and/or [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature layer(s). If using a locator with a geocoding service, the [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) operation is used, whereas [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-support-Query.html) are used on feature layers. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) */ @@ -53880,141 +53880,141 @@ declare namespace __esri { interface widgetsSearchProperties extends WidgetProperties, GoToProperties { /** * The selected source's index. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSourceIndex) - * + * * @default 0 */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget. ![search-allPlaceholder](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-allplaceholder.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allPlaceholder) - * + * * @default "Find address or place" */ allPlaceholder?: string; /** * Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a [search-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#event:search-complete) event handler and get the results through the event object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#autoSelect) - * + * * @default true */ autoSelect?: boolean; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. This can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources) - * + * * @default true */ includeDefaultSources?: boolean | Function; /** - * Enables location services within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) + * Enables location services within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) * > The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/Window/isSecureContext#Browser_compatibility) (currently Chrome and Firefox). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#locationEnabled) - * + * * @default true */ locationEnabled?: boolean; /** * The maximum number of results returned by the widget if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxResults) - * + * * @default 6 */ maxResults?: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. If working with the default [ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm), the default remains at `5`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters?: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * A customized PopupTemplate for the selected feature. Note that specifying a wildcard {*} for the popupTemplate will return all fields in addition to search-specific fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupTemplate) - * + * * @default null */ popupTemplate?: PopupTemplateProperties; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#portal) */ portal?: PortalProperties; /** * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) will display at the location of the selected feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphicEnabled) - * + * * @default true */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. When `true`, the "All" option is displayed by default: ![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-true.png) When `false`, no option to search all sources at once is available: ![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-false.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchAllEnabled) - * + * * @default true */ searchAllEnabled?: boolean; /** * The value of the search box input text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchTerm) */ searchTerm?: string; /** - * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) specified by the Search widget instance. There are two types of sources: + * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) specified by the Search widget instance. There are two types of sources: * * [FeatureLayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) * * [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html) - * - * + * + * * Any combination of these sources may be used together in the same instance of the Search widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) */ sources?: CollectionProperties; /** * Enable suggestions for the widget. This is only available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [SearchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#viewModel) */ viewModel?: SearchViewModelProperties; @@ -54023,55 +54023,55 @@ declare namespace __esri { interface FeatureLayerSearchSource extends SearchSource, JSONSupport { /** * The results are displayed using this field. Defaults to the layer's `displayField` or the first string field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#displayField) */ displayField: string; /** * Indicates to only return results that match the search value exactly. This property only applies to `string` field searches. `exactMatch` is always `true` when searching fields of type `number`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#exactMatch) - * + * * @default false */ exactMatch: boolean; /** * The feature layer queried in the search. This is **required**. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#featureLayer) */ featureLayer: FeatureLayer; /** * The name of the source for display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#name) */ name: string; /** * An array of string values representing the names of fields in the feature layer to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#searchFields) */ searchFields: string[]; /** * A template string used to display multiple fields in a defined order when results are displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#searchTemplate) */ searchTemplate: string; /** * A template string used to display multiple fields in a defined order when suggestions are displayed. This takes precedence over `displayField`. Field names in the template must have the following format: `{FieldName}`. An example suggestionTemplate could look something like: `Name: {OWNER}, Parcel: {PARCEL_ID}`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#suggestionTemplate) */ suggestionTemplate: string; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#clone) - * - * + * + * */ clone(): FeatureLayerSearchSource; } @@ -54089,45 +54089,45 @@ declare namespace __esri { interface FeatureLayerSearchSourceProperties extends SearchSourceProperties { /** * The results are displayed using this field. Defaults to the layer's `displayField` or the first string field. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#displayField) */ displayField?: string; /** * Indicates to only return results that match the search value exactly. This property only applies to `string` field searches. `exactMatch` is always `true` when searching fields of type `number`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#exactMatch) - * + * * @default false */ exactMatch?: boolean; /** * The feature layer queried in the search. This is **required**. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#featureLayer) */ featureLayer?: FeatureLayerProperties; /** * The name of the source for display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#name) */ name?: string; /** * An array of string values representing the names of fields in the feature layer to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#searchFields) */ searchFields?: string[]; /** * A template string used to display multiple fields in a defined order when results are displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#searchTemplate) */ searchTemplate?: string; /** * A template string used to display multiple fields in a defined order when suggestions are displayed. This takes precedence over `displayField`. Field names in the template must have the following format: `{FieldName}`. An example suggestionTemplate could look something like: `Name: {OWNER}, Parcel: {PARCEL_ID}`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html#suggestionTemplate) */ suggestionTemplate?: string; @@ -54136,61 +54136,61 @@ declare namespace __esri { interface LocatorSearchSource extends SearchSource, JSONSupport { /** * A string array which limits the results to one or more categories. For example, `Populated Place` or `airport`. Only applicable when using the World Geocode Service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#categories) */ categories: string[]; /** * Constricts search results to a specified country code. For example, `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#countryCode) */ countryCode: string; /** * Sets the sources for local `distance` and `minScale` for searching. See the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchOptions) */ localSearchOptions: LocatorSearchSourceLocalSearchOptions; /** * When reverse geocoding a result, use this distance in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locationToAddressDistance) - * + * * @default 1500 */ locationToAddressDistance: number; /** * The locator task used to search. This is **required** and defaults to the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locator) */ locator: Locator; /** * The name of the source for display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#name) */ name: string; /** * A template string used to display multiple fields in a defined order when results are displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#searchTemplate) */ searchTemplate: string; /** * The field name of the Single Line Address Field in the REST services directory for the locator service. Common values are `SingleLine` and `SingleLineFieldName`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#singleLineFieldName) */ singleLineFieldName: string; /** * Creates a deep clone of this object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#clone) - * - * + * + * */ clone(): LocatorSearchSource; } @@ -54208,51 +54208,51 @@ declare namespace __esri { interface LocatorSearchSourceProperties extends SearchSourceProperties { /** * A string array which limits the results to one or more categories. For example, `Populated Place` or `airport`. Only applicable when using the World Geocode Service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#categories) */ categories?: string[]; /** * Constricts search results to a specified country code. For example, `US` for United States or `SE` for Sweden. Only applies to the World Geocode Service. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#countryCode) */ countryCode?: string; /** * Sets the sources for local `distance` and `minScale` for searching. See the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchOptions) */ localSearchOptions?: LocatorSearchSourceLocalSearchOptions; /** * When reverse geocoding a result, use this distance in meters. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locationToAddressDistance) - * + * * @default 1500 */ locationToAddressDistance?: number; /** * The locator task used to search. This is **required** and defaults to the [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#locator) */ locator?: LocatorProperties; /** * The name of the source for display. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#name) */ name?: string; /** * A template string used to display multiple fields in a defined order when results are displayed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#searchTemplate) */ searchTemplate?: string; /** * The field name of the Single Line Address Field in the REST services directory for the locator service. Common values are `SingleLine` and `SingleLineFieldName`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#singleLineFieldName) */ singleLineFieldName?: string; @@ -54262,13 +54262,13 @@ declare namespace __esri { export interface LocatorSearchSourceLocalSearchOptions extends Object { /** * The distance to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchOptions) */ distance?: number; /** * The minimum scale used to search locally. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html#localSearchOptions) */ minScale?: number; @@ -54277,110 +54277,110 @@ declare namespace __esri { interface SearchSource extends JSONSupport { /** * Indicates whether to automatically navigate to the selected result once selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#autoNavigate) - * + * * @default true */ autoNavigate: boolean; /** * This property replaces the now deprecated `searchQueryParams`, `suggestQueryParams`, and `searchExtent` properties. Please see the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ filter: SearchSourceFilter; /** * Indicates the maximum number of search results to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxResults) - * + * * @default 6 */ maxResults: number; /** * Indicates the maximum number of suggestions to return for the widget's input. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions: number; /** * Indicates the minimum number of characters required before querying for a suggestion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters: number; /** * Specifies the fields returned with the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#outFields) */ outFields: string[]; /** * Used as a hint for the source input text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#placeholder) */ placeholder: string; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupEnabled) */ popupEnabled: boolean; /** - * The popup template used to display search results. If no popup is needed, set the source's popupTemplate to `null`. + * The popup template used to display search results. If no popup is needed, set the source's popupTemplate to `null`. * > This property should be set in instances where there is no existing [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) configured. For example, [feature sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) will default to any existing [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) configured on the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupTemplate) */ popupTemplate: PopupTemplate; /** * Specify this to prefix the user's input of the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#prefix) */ prefix: string; /** * Indicates whether to show a graphic on the map for the selected source using the [resultSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultGraphicEnabled) */ resultGraphicEnabled: boolean; /** * The symbol used to display the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol) */ resultSymbol: Symbol; /** * Specify this to add a suffix to the user's input for the search value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suffix) */ suffix: string; /** * Indicates whether to display suggestions as the user enters input text in the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled: boolean; /** * Indicates whether to constrain the search results to the view's extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#withinViewEnabled) - * + * * @default false */ withinViewEnabled: boolean; /** * The set zoom scale for the resulting search result. This scale is automatically honored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#zoomScale) */ zoomScale: number; @@ -54399,110 +54399,110 @@ declare namespace __esri { interface SearchSourceProperties { /** * Indicates whether to automatically navigate to the selected result once selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#autoNavigate) - * + * * @default true */ autoNavigate?: boolean; /** * This property replaces the now deprecated `searchQueryParams`, `suggestQueryParams`, and `searchExtent` properties. Please see the object specification table below for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ filter?: SearchSourceFilter; /** * Indicates the maximum number of search results to return. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxResults) - * + * * @default 6 */ maxResults?: number; /** * Indicates the maximum number of suggestions to return for the widget's input. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions?: number; /** * Indicates the minimum number of characters required before querying for a suggestion. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters?: number; /** * Specifies the fields returned with the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#outFields) */ outFields?: string[]; /** * Used as a hint for the source input text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#placeholder) */ placeholder?: string; /** * Indicates whether to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when a selected result is clicked. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupEnabled) */ popupEnabled?: boolean; /** - * The popup template used to display search results. If no popup is needed, set the source's popupTemplate to `null`. + * The popup template used to display search results. If no popup is needed, set the source's popupTemplate to `null`. * > This property should be set in instances where there is no existing [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) configured. For example, [feature sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) will default to any existing [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) configured on the layer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#popupTemplate) */ popupTemplate?: PopupTemplateProperties; /** * Specify this to prefix the user's input of the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#prefix) */ prefix?: string; /** * Indicates whether to show a graphic on the map for the selected source using the [resultSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultGraphicEnabled) */ resultGraphicEnabled?: boolean; /** * The symbol used to display the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#resultSymbol) */ resultSymbol?: SymbolProperties; /** * Specify this to add a suffix to the user's input for the search value. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suffix) */ suffix?: string; /** * Indicates whether to display suggestions as the user enters input text in the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled?: boolean; /** * Indicates whether to constrain the search results to the view's extent. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#withinViewEnabled) - * + * * @default false */ withinViewEnabled?: boolean; /** * The set zoom scale for the resulting search result. This scale is automatically honored. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#zoomScale) */ zoomScale?: number; @@ -54512,13 +54512,13 @@ declare namespace __esri { export interface SearchSourceFilter extends Object { /** * The where clause specified for filtering suggests or search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ where?: string; /** * The filter geometry for suggests or search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchSource.html#filter) */ geometry?: Geometry; @@ -54527,268 +54527,268 @@ declare namespace __esri { interface SearchViewModel extends Accessor, Evented, GoTo { /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) object currently selected. Can be either a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or a [locator task](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSource) */ readonly activeSource: FeatureLayerSearchSource | LocatorSearchSource; /** * The selected source's index. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSourceIndex) - * + * * @default 0 */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget. ![search-allPlaceholder](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-allplaceholder.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allPlaceholder) - * + * * @default "Find address or place" */ allPlaceholder: string; /** * The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) and [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). The [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) displays first in the Search UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allSources) */ readonly allSources: Collection; /** * Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a [search-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#event:search-complete) event handler and get the results through the event object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#autoSelect) - * + * * @default true */ autoSelect: boolean; /** * A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of module:esri/widgets/Search/FeaturelayerSource and/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html). This property may contain [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) [locators](http://enterprise.arcgis.com/en/server/latest/publish-services/windows/geocode-services.htm) and any web map or web scene [configurable search sources](http://doc.arcgis.com/en/arcgis-online/create-maps/configure-feature-search.htm). This property is used to populate the Search UI if the [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) property is not set. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) */ readonly defaultSources: Collection; /** * The default [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the search result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbol) - * + * * @default PictureMarkerSymbol */ defaultSymbol: Symbol; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. This can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#includeDefaultSources) - * + * * @default true */ includeDefaultSources: boolean | Function; /** - * Indicates whether location services are enabled within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) + * Indicates whether location services are enabled within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) * > The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/Window/isSecureContext#Browser_compatibility) (currently Chrome and Firefox). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#locationEnabled) */ locationEnabled: boolean; /** * The maximum character length of the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxInputLength) - * + * * @default 128 */ maxInputLength: number; /** * The maximum number of results returned by the widget if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxResults) - * + * * @default 6 */ maxResults: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. If working with the default [ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm), the default remains at `5`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters: number; /** * The placeholder used by the [activeSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSource). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#placeholder) */ readonly placeholder: string; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupEnabled) - * + * * @default true */ popupEnabled: boolean; /** * A customized PopupTemplate for the selected feature. Note that specifying a wildcard {*} for the popupTemplate will return all fields in addition to search-specific fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupTemplate) - * + * * @default null */ popupTemplate: PopupTemplate; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#portal) */ portal: Portal; /** * The graphic used to highlight the resulting feature or location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) - * + * * @default null */ readonly resultGraphic: Graphic; /** - * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. + * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. * A graphic will be placed in the View's [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) for [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) that do not support the `highlight` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphicEnabled) - * + * * @default true */ resultGraphicEnabled: boolean; /** * An array of current results from the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#results) - * + * * @default null */ readonly results: any[]; /** * Indicates whether to display the option to search all sources. When `true`, the "All" option is displayed by default: ![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-true.png) When `false`, no option to search all sources at once is available: ![search-searchAllEnabled-true-false](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-false.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchAllEnabled) - * + * * @default true */ searchAllEnabled: boolean; /** * The value of the search box input text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchTerm) */ searchTerm: string; /** * The result selected from a search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#selectedResult) - * + * * @default null */ readonly selectedResult: any; /** * The selected SuggestResult. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#selectedSuggestion) - * + * * @default null */ readonly selectedSuggestion: Geometry | SearchViewModelSuggestResult; /** - * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) specified by the Search widget instance. There are two types of sources: + * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) specified by the Search widget instance. There are two types of sources: * * [FeatureLayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) * * [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html) - * - * + * + * * Any combination of these sources may be used together in the same instance of the Search widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) */ sources: Collection; /** * The current state of the widget. This property was removed from [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html) and should now be accessed within the [SearchViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html). **Possible Values:** ready | disabled | searching - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state) - * + * * @default ready */ readonly state: string; /** * The millisecond delay after keyup and before making a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) network request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionDelay) - * + * * @default 150 */ suggestionDelay: number; /** * An array of results from the [suggest method](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). This is available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestions) - * + * * @default null */ readonly suggestions: SearchViewModelSuggestResult[]; /** * Enable suggestions for the widget. This is only available if working with a 10.3 or greater geocoding service that has [suggest capability loaded] (https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) - * + * * @default null */ view: MapView | SceneView; /** * Clears the current value, search results, suggest results, graphic, and graphics layer. It also hides any open menus. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#clear) - * - * + * + * */ clear(): void; /** * Depending on the sources specified, `search()` queries the feature layer(s) and/or performs address matching using any specified [Locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html) and returns the applicable results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search) - * + * * @param searchTerm This searchTerm can be a string, geometry, suggest candidate object, or an array of [latitude,longitude]. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text (featurelayer). - * + * */ search(searchTerm?: string | Geometry | SearchViewModelSuggestResult | number[][]): IPromise; /** * Returns search results near your current location. It checks whether [locationEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#locationEnabled) is `true`. If so, and your browser supports [geolocation](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/Using_geolocation), it will return search results nearby your current location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchNearby) - * - * + * + * */ searchNearby(): IPromise; /** * Performs a suggest() request on the active Locator. It also uses the current value of the widget or one that is passed in. Suggestions are available if working with a 10.3 or greater geocoding service that has [suggest capability loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.`supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) - * + * * @param value The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget. - * + * */ suggest(value?: string): IPromise; @@ -54817,160 +54817,160 @@ declare namespace __esri { interface SearchViewModelProperties extends GoToProperties { /** * The selected source's index. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#activeSourceIndex) - * + * * @default 0 */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget. ![search-allPlaceholder](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-allplaceholder.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#allPlaceholder) - * + * * @default "Find address or place" */ allPlaceholder?: string; /** * Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a [search-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#event:search-complete) event handler and get the results through the event object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#autoSelect) - * + * * @default true */ autoSelect?: boolean; /** * The default [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html) for the search result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSymbol) - * + * * @default PictureMarkerSymbol */ defaultSymbol?: SymbolProperties; /** * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI. This can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#includeDefaultSources) - * + * * @default true */ includeDefaultSources?: boolean | Function; /** - * Indicates whether location services are enabled within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) + * Indicates whether location services are enabled within the widget. ![locationEnabled](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-locationEnabled.png) * > The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/Window/isSecureContext#Browser_compatibility) (currently Chrome and Firefox). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#locationEnabled) */ locationEnabled?: boolean; /** * The maximum character length of the search text. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxInputLength) - * + * * @default 128 */ maxInputLength?: number; /** * The maximum number of results returned by the widget if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxResults) - * + * * @default 6 */ maxResults?: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. If working with the default [ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm), the default remains at `5`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#maxSuggestions) - * + * * @default 6 */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#minSuggestCharacters) - * + * * @default 1 */ minSuggestCharacters?: number; /** * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupEnabled) - * + * * @default true */ popupEnabled?: boolean; /** * A customized PopupTemplate for the selected feature. Note that specifying a wildcard {*} for the popupTemplate will return all fields in addition to search-specific fields. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#popupTemplate) - * + * * @default null */ popupTemplate?: PopupTemplateProperties; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#portal) */ portal?: PortalProperties; /** - * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. + * Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphic) will display at the location of the selected feature. * A graphic will be placed in the View's [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics) for [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) that do not support the `highlight` method. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#resultGraphicEnabled) - * + * * @default true */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. When `true`, the "All" option is displayed by default: ![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-true.png) When `false`, no option to search all sources at once is available: ![search-searchAllEnabled-true-false](https://developers.arcgis.com/javascript/assets/img/apiref/widgets/search-enablesearchingall-false.png) - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchAllEnabled) - * + * * @default true */ searchAllEnabled?: boolean; /** * The value of the search box input text string. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#searchTerm) */ searchTerm?: string; /** - * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) specified by the Search widget instance. There are two types of sources: + * The Search widget may be used to search features in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or geocode locations with a [Locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-Locator.html). The `sources` property defines the sources from which to search for the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) specified by the Search widget instance. There are two types of sources: * * [FeatureLayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-FeatureLayerSearchSource.html) * * [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html) - * - * + * + * * Any combination of these sources may be used together in the same instance of the Search widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) */ sources?: CollectionProperties; /** * The millisecond delay after keyup and before making a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest) network request. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionDelay) - * + * * @default 150 */ suggestionDelay?: number; /** * Enable suggestions for the widget. This is only available if working with a 10.3 or greater geocoding service that has [suggest capability loaded] (https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggestionsEnabled) - * + * * @default true */ suggestionsEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#view) - * + * * @default null */ view?: MapViewProperties | SceneViewProperties; @@ -54994,37 +54994,37 @@ declare namespace __esri { /** * When resolved, returns this response after calling [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ export interface SearchViewModelSearchResponse extends Object { /** * The index of the source from which the search result was obtained. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ errors: Error[]; /** * The number of search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ numResults: number; /** * The searched expression - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ searchTerm: string; /** * An array of objects representing the results of search. See object specification table below for more information about the result object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ results: SearchViewModelSearchResponseResults[]; @@ -55032,25 +55032,25 @@ declare namespace __esri { /** * The result object returned from the [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#search). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ export interface SearchViewModelSearchResult extends Object { /** * The extent, or bounding box, of the returned feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ extent: Extent; /** * The resulting feature or location obtained from the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ feature: Graphic; /** * The name of the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResult) */ name: string; @@ -55083,37 +55083,37 @@ declare namespace __esri { /** * When resolved, returns this reponse after calling [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ export interface SearchViewModelSuggestResponse extends Object { /** * The index of the source from which suggestions are obtained. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ errors: Error[]; /** * The number of suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ numResults: number; /** * The search expression used for the suggest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ searchTerm: string; /** * An array of objects representing the results of suggest. See object specification table below for more information about the result object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ results: SearchViewModelSuggestResponseResults[]; @@ -55121,25 +55121,25 @@ declare namespace __esri { /** * The result object returned from a [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#suggest). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ export interface SearchViewModelSuggestResult extends Object { /** * The key related to the suggest result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ key: string; /** * The string name of the suggested location to geocode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ text: string; /** * The index of the currently selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResult) */ sourceIndex: number; @@ -55162,19 +55162,19 @@ declare namespace __esri { export interface SearchViewModelSearchResponseResults extends Object { /** * An array of search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ results: SearchViewModelSearchResult[]; /** * The index of the currently selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) of the selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SearchResponse) */ source: any; @@ -55204,19 +55204,19 @@ declare namespace __esri { export interface SearchViewModelSuggestResponseResults extends Object { /** * An array of suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ results: SearchViewModelSuggestResult[]; /** * The index of the currently selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) of the selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#SuggestResponse) */ source: any; @@ -55224,37 +55224,37 @@ declare namespace __esri { /** * When resolved, returns this response after calling [search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ export interface SearchResponse extends Object { /** * The index of the source from which the search result was obtained. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ errors: Error[]; /** * The number of search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ numResults: number; /** * The searched expression - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ searchTerm: string; /** * An array of objects representing the results of search. See object specification table below for more information about the result object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ results: SearchResponseResults[]; @@ -55262,25 +55262,25 @@ declare namespace __esri { /** * The result object returned from a [search()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#search). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ export interface SearchResult extends Object { /** * The extent, or bounding box, of the returned feature. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ extent: Extent; /** * The resulting feature or location obtained from the search. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ feature: Graphic; /** * The name of the result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) */ name: string; @@ -55288,37 +55288,37 @@ declare namespace __esri { /** * When resolved, returns this response after calling [suggest](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ export interface SuggestResponse extends Object { /** * The index of the source from which suggestions are obtained. This value is `-1` when all sources are selected. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ activeSourceIndex: number; /** * An array of error objects returned from the suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ errors: Error[]; /** * The number of suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ numResults: number; /** * The search expression used for the suggest. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ searchTerm: string; /** * An array of objects representing the results of suggest. See object specification table below for more information about the result object. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ results: SuggestResponseResults[]; @@ -55326,25 +55326,25 @@ declare namespace __esri { /** * The result object returned from a [suggest()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ export interface SuggestResult extends Object { /** * The key related to the suggest result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ key: string; /** * The string name of the suggested location to geocode. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ text: string; /** * The index of the currently selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResult) */ sourceIndex: number; @@ -55354,19 +55354,19 @@ declare namespace __esri { export interface SearchResponseResults extends Object { /** * An array of search results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ results: SearchResult[]; /** * The index of the currently selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) of the selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResponse) */ source: any; @@ -55376,19 +55376,19 @@ declare namespace __esri { export interface SuggestResponseResults extends Object { /** * An array of suggest results. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ results: SuggestResult[]; /** * The index of the currently selected source. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ sourceIndex: number; /** * The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) of the selected result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SuggestResponse) */ source: any; @@ -55397,103 +55397,103 @@ declare namespace __esri { interface SizeSlider extends Accessor, Widgette { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#handlesVisible) - * + * * @default true */ handlesVisible: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogram) */ histogram: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogramVisible) - * + * * @default true */ histogramVisible: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * The size in points or pixels with which features will be represented at or above the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxSize) */ readonly maxSize: number; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics), but may not be smaller than the upper value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue) */ maxValue: number; /** * The size in points or pixels with which features will be represented at or below the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minSize) */ readonly minSize: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics), but may not be greater than the lower value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) */ minValue: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) */ statistics: SizeSliderStatistics; /** * Indicates whether to show the average value of features in the dataset in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible: boolean; /** * The symbol on the slider representing the features in the view. This symbol type should match the symbol type of the appropriate features. This can be an instance of [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), which is the default value, or [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#symbol) */ symbol: SimpleMarkerSymbol | SimpleLineSymbol; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#ticksVisible) - * + * * @default true */ ticksVisible: boolean; /** * Represents the data values corresponding to the handles on the slider. It is an array of numbers indicating the `minDataValue` and the `maxDataValue` of the [visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#SizeVisualVariable) represented by the slider. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#values) */ readonly values: number[]; /** * The size visual variable represented by the slider. This must be set initially on the slider for it to render in the view. This may be created manually (see snippet below) or generated from the sizeRendererCreator helper methods. A new size visual variable is created each time the user slides handles or changes the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) or the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#visualVariable) */ visualVariable: SizeVisualVariable; @@ -55502,7 +55502,7 @@ declare namespace __esri { interface SizeSliderConstructor { /** * The SizeSlider is a widget intended for authoring and exploring data-driven visualizations in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) using the size of marker symbols or 3D object symbol layers. To display properly, this slider requires a [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#visualVariable) and [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) object. Other optional properties may be used including adding a [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogram). Most of the various options that affect the UI of the slider are labeled in the image below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html) */ @@ -55514,85 +55514,85 @@ declare namespace __esri { interface SizeSliderProperties extends WidgetteProperties { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#handlesVisible) - * + * * @default true */ handlesVisible?: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogram) */ histogram?: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogramVisible) - * + * * @default true */ histogramVisible?: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth?: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics), but may not be smaller than the upper value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue) */ maxValue?: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics), but may not be greater than the lower value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) */ minValue?: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) */ statistics?: SizeSliderStatistics; /** * Indicates whether to show the average value of features in the dataset in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible?: boolean; /** * The symbol on the slider representing the features in the view. This symbol type should match the symbol type of the appropriate features. This can be an instance of [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), which is the default value, or [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#symbol) */ symbol?: SimpleMarkerSymbolProperties | SimpleLineSymbolProperties; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#ticksVisible) - * + * * @default true */ ticksVisible?: boolean; /** * The size visual variable represented by the slider. This must be set initially on the slider for it to render in the view. This may be created manually (see snippet below) or generated from the sizeRendererCreator helper methods. A new size visual variable is created each time the user slides handles or changes the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#minValue) or the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#visualVariable) */ visualVariable?: SizeVisualVariable; @@ -55602,19 +55602,19 @@ declare namespace __esri { export interface SizeSliderStatistics extends Object { /** * The average of all data values represented in the size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) */ avg?: number; /** * The maximum of all data values represented in the size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) */ max: number; /** * The minimum of all data values represented in the size visual variable. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-SizeSlider.html#statistics) */ min: number; @@ -55623,13 +55623,13 @@ declare namespace __esri { interface SketchViewModel extends Accessor, Evented { /** * Graphic representing the sketch that is being drawn or updated on the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#graphic) */ readonly graphic: Graphic; /** * GraphicsLayer associated with the SketchViewModel. It allows you to organize where temporary graphics are placed when the drawing is completed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#layer) */ layer: GraphicsLayer; @@ -55647,7 +55647,7 @@ declare namespace __esri { * } * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol) */ pointSymbol: SimpleMarkerSymbol; @@ -55663,7 +55663,7 @@ declare namespace __esri { * } * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol) */ polygonSymbol: SimpleFillSymbol; @@ -55676,80 +55676,80 @@ declare namespace __esri { * width: 2 * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol) */ polylineSymbol: SimpleLineSymbol; /** * The sketch view model's state. **Possible Values:** ready | disabled | creating | updating - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#state) */ readonly state: string; /** * The view in which geometries will be sketched by the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#view) */ view: MapView; /** * Completes the active drawing and fires the [create-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event:create-complete) or [update-complete](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event:update-complete) event depending on the draw operation. If called mid-drawing, `complete()` finishes the active drawing and keeps the valid geometry. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#complete) - * - * + * + * */ complete(): void; /** * Creates the requested draw action. **Note:** Creating a circle geometry does not work in all spatial references. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) - * + * * @param drawAction Name of the draw action tool. **Possible Values:** point | multipoint | polyline | polygon | rectangle | circle * @param drawOptions Object of the drawing options for the geometry to be created. - * @param drawOptions.mode - * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `rectangle` and `circle` geometries. **Possible Values:** - * + * @param drawOptions.mode + * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `rectangle` and `circle` geometries. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. Applies to and is the default for `polygon` and `polyline`. * freehand | Vertices are added while the pointer is dragged. Applies to `polygon`, `polyline` `rectangle` and `circle`. Default for `rectangle` and `circle`. * click | Vertices are added when the pointer is clicked. - * + * */ create(drawAction: string, drawOptions?: SketchViewModelCreateDrawOptions): void; /** * Incrementally redo actions recorded in the stack. Calling this method will fire the [redo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event:redo) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#redo) - * - * + * + * */ redo(): void; /** * Resets SketchViewModel to prepare for another create operation. Reset discards the current drawing, if called mid drawing. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#reset) - * - * + * + * */ reset(): void; /** * Incrementally undo actions recorded in the stack. Calling this method will fire the [undo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event:undo) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#undo) - * - * + * + * */ undo(): void; /** * Initializes an update operation for the selected geometry and fires [update-init](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#event:update-init) event. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#update) - * + * * @param graphic The graphic to be updated. - * + * */ update(graphic: Graphic): void; } @@ -55757,7 +55757,7 @@ declare namespace __esri { interface SketchViewModelConstructor { /** * SketchViewModel simplifies the process of adding and updating graphics on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). SketchViewModel is intended to be used with [Graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Its [events](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#events-summary) allow control of a graphic's geometry. Use the [DrawAction](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-draw-DrawAction.html) class if more fine-grained control is needed with vertices when creating graphics. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html) */ @@ -55769,7 +55769,7 @@ declare namespace __esri { interface SketchViewModelProperties { /** * GraphicsLayer associated with the SketchViewModel. It allows you to organize where temporary graphics are placed when the drawing is completed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#layer) */ layer?: GraphicsLayerProperties; @@ -55787,7 +55787,7 @@ declare namespace __esri { * } * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol) */ pointSymbol?: SimpleMarkerSymbolProperties; @@ -55803,7 +55803,7 @@ declare namespace __esri { * } * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol) */ polygonSymbol?: SimpleFillSymbolProperties; @@ -55816,13 +55816,13 @@ declare namespace __esri { * width: 2 * } * ``` - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol) */ polylineSymbol?: SimpleLineSymbolProperties; /** * The view in which geometries will be sketched by the user. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#view) */ view?: MapViewProperties; @@ -55831,15 +55831,15 @@ declare namespace __esri { export interface SketchViewModelCreateDrawOptions extends Object { /** - * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `rectangle` and `circle` geometries. **Possible Values:** - * + * The drawing mode. The drawing mode applies only when creating `polygon`, `polyline`, `rectangle` and `circle` geometries. **Possible Values:** + * * Value | Description | * ----- | ----------- | * hybrid | Vertices are added while the pointer is clicked or dragged. Applies to and is the default for `polygon` and `polyline`. * freehand | Vertices are added while the pointer is dragged. Applies to `polygon`, `polyline` `rectangle` and `circle`. Default for `rectangle` and `circle`. * click | Vertices are added when the pointer is clicked. - * - * + * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#create) */ mode?: string; @@ -55848,37 +55848,37 @@ declare namespace __esri { interface GeolocationPositioning { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions: any; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#graphic) */ graphic: Graphic; /** * The scale to set on the view when navigating to the position of the geolocated result. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#scale) - * + * * @default null */ scale: number; /** * The view associated with the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#view) */ view: MapView | SceneView; @@ -55895,37 +55895,37 @@ declare namespace __esri { interface GeolocationPositioningProperties { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions?: any; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location on the map. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#graphic) */ graphic?: GraphicProperties; /** * The scale to set on the view when navigating to the position of the geolocated result. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#scale) - * + * * @default null */ scale?: number; /** * The view associated with the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GeolocationPositioning.html#view) */ view?: MapViewProperties | SceneViewProperties; @@ -55934,7 +55934,7 @@ declare namespace __esri { interface GoTo { /** * This function provides the ability to override either the [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GoTo.html#goToOverride) */ goToOverride: GoToOverride; @@ -55951,7 +55951,7 @@ declare namespace __esri { interface GoToProperties { /** * This function provides the ability to override either the [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-GoTo.html#goToOverride) */ goToOverride?: GoToOverride; @@ -55961,67 +55961,67 @@ declare namespace __esri { interface widget { /** * This convenience decorator is used to help simplify accessibility within the widget keyboard events. For example, it can be used to execute a method when the `space` or `enter` keys are pressed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#accessibleHandler) - * - * + * + * */ accessibleHandler(): Function; /** * Utility method used for creating CSS animation/transition functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#cssTransition) - * + * * @param type The animation/transition type. **Possible Values:** enter | exit * @param className The animation/transition class name. - * + * */ cssTransition(type: string, className: string): Function; /** * Utility method used for joining CSS classes. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#join) - * + * * @param classNames The class names to join. - * + * */ join(...classNames: string[]): string; /** * This convenience decorator marks a property for automatic rendering. It is useful when you want rendering to be scheduled whenever the decorated property changes. Many times this decorator is used in conjunction with the [@property](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-accessorSupport-decorators.html) decorator. Rendering on deep properties is also supported by providing a path to a property deeper in the instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#renderable) - * + * * @param propertyName Names of nested renderable properties. - * + * */ renderable(propertyName?: string | string[]): Function; /** * This convenience method is used to assign an [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) DOM node reference to a variable. It does this by taking a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) passed from either the [afterUpdate](https://developers.arcgis.com/javascript/latest/guide/custom-widget/index.html#widget-rendering) or [afterCreate](https://developers.arcgis.com/javascript/latest/guide/custom-widget/index.html#widget-rendering) callbacks. In order to use this, the element must have a set [data-node-ref](https://developers.arcgis.com/javascript/latest/guide/custom-widget/index.html#widget-rendering) attribute. In addition, it must also be bound to the widget instance, e.g. `bind={this}`. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#storeNode) - * + * * @param node The referenced DOM node. - * + * */ storeNode(node: HTMLElement): void; /** * This convenience method is used to render the JSX in the [widget.render()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#render) method. It is required to import `tsx` even though it is not explicitly called. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#tsx) - * + * * @param selector The element to create. * @param properties The element's properties. * @param children The element's children. - * + * */ tsx(selector: string, properties?: any, children?: any): any; /** * This convenience decorator helps dispatch view model events on the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#vmEvent) - * + * * @param eventNames The event names to re-dispatch. - * + * */ vmEvent(eventNames: string | string[]): Function; } @@ -56032,19 +56032,19 @@ declare namespace __esri { /** * The following parameters passed to either the [MapView's goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView's goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) functions. For additional information on what can be passed to its `target` or `options`, please refer to documentation for either the [MapView's goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or [SceneView's goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) functions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters) */ export interface GoToParameters extends Object { /** * The target location/viewpoint to animate to. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters) */ target: any; /** * Animation options. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-widget.html#GoToParameters) */ options?: any; @@ -56053,97 +56053,97 @@ declare namespace __esri { interface Track extends Widget, GoTo { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions: any; /** * Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. Set to `false` to disable this behavior, leaving full control to the developer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled: boolean; /** * The graphic used to show the user's location in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#graphic) */ graphic: Graphic; /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#label) */ readonly label: string; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#event:track) event. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. For 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) and [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#scale) - * + * * @default null */ scale: number; /** * Indicates whether the widget is watching for new positions. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#tracking) - * + * * @default false */ readonly tracking: boolean; /** * Indicates whether the widget will automatically [rotate to user's direction](https://www.w3.org/TR/geolocation-API/#coordinates_interface). Set to `false` to disable this behavior. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#useHeadingEnabled) - * + * * @default true */ useHeadingEnabled: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [TrackViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#viewModel) */ viewModel: TrackViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#render) - * - * + * + * */ render(): any; /** * When executed, the widget will start [tracking](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#tracking) the user's location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#start) - * - * + * + * */ start(): void; /** * Stops tracking the user's location when executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#stop) - * - * + * + * */ stop(): void; } @@ -56151,7 +56151,7 @@ declare namespace __esri { interface TrackConstructor { /** * Provides a simple button that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's location when clicked. The view rotates according to the direction where the tracked device is heading towards. While tracking, the default button looks like the following: - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html) */ @@ -56163,51 +56163,51 @@ declare namespace __esri { interface TrackProperties extends WidgetProperties, GoToProperties { /** * The HTML5 Geolocation Position options for locating. Refer to [Geolocation API Specification](http://www.w3.org/TR/geolocation-API/#position-options) for details. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#geolocationOptions) - * + * * @default { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } */ geolocationOptions?: any; /** * Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. Set to `false` to disable this behavior, leaving full control to the developer. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#goToLocationEnabled) - * + * * @default true */ goToLocationEnabled?: boolean; /** * The graphic used to show the user's location in the view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#graphic) */ graphic?: GraphicProperties; /** * Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#event:track) event. If a scale value is not explicitly set, then the view will navigate to a default scale of `2500`. For 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints) and [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#scale) - * + * * @default null */ scale?: number; /** * Indicates whether the widget will automatically [rotate to user's direction](https://www.w3.org/TR/geolocation-API/#coordinates_interface). Set to `false` to disable this behavior. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#useHeadingEnabled) - * + * * @default true */ useHeadingEnabled?: boolean; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [TrackViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html#viewModel) */ viewModel?: TrackViewModelProperties; @@ -56216,35 +56216,35 @@ declare namespace __esri { interface TrackViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { /** * The current state of the widget. **Possible Values:** disabled | ready | tracking | waiting - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * Indicates whether new positions are being watched. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#tracking) - * + * * @default false */ readonly tracking: boolean; /** * When executed, [tracking](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#tracking) starts at the user's location. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#start) - * - * + * + * */ start(): void; /** * Stops tracking the user's location when executed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#stop) - * - * + * + * */ stop(): void; } @@ -56252,7 +56252,7 @@ declare namespace __esri { interface TrackViewModelConstructor { /** * Provides the logic for the [Track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track.html) widget, which animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's location when clicked and tracks it as the location is updated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html) */ @@ -56268,97 +56268,97 @@ declare namespace __esri { interface UnivariateColorSizeSlider extends Accessor, Widgette { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#handlesVisible) - * + * * @default true */ handlesVisible: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogram) */ histogram: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogramVisible) - * + * * @default true */ histogramVisible: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#labelsVisible) - * + * * @default true */ labelsVisible: boolean; /** * The size in points or pixels with which features will be represented at or above the [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxSize) */ readonly maxSize: number; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics), but may not be smaller than the upper value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxValue) */ maxValue: number; /** * The size in points or pixels with which features will be represented at or below the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minValue). - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minSize) */ readonly minSize: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics), but may not be greater than the lower value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minValue) */ minValue: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ statistics: UnivariateColorSizeSliderStatistics; /** * Indicates whether to show the average of the dataset in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible: boolean; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#ticksVisible) - * + * * @default true */ ticksVisible: boolean; /** * Represents the data values corresponding to the handles on the slider. It is an array of numbers indicating the `minDataValue` and the `maxDataValue` of the visual variables represented by the slider. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#values) */ readonly values: number[]; /** * The size and color visual variables represented by the slider. Since this slider represents univariate visualizations, both color and size visual variables must represent data from the same field or expression and be conicident. In other words, the lower stop or bound of the color visual variable must match the lower bound (or `minDataValue`) of the size visual variable. The same is true of the upper bounds of both visual variables. These must be set initially on the slider for it to render in the view. Both visual variables may be created manually (see snippet below) or generated from the [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html) helper methods. New coincident color and size visual variables are created each time the user slides the handles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#visualVariables) */ visualVariables: any[]; @@ -56367,7 +56367,7 @@ declare namespace __esri { interface UnivariateColorSizeSliderConstructor { /** * The UnivariateColorSizeSlider is a widget intended for authoring and exploring data-driven univariate visualizations in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) using color and size. To display properly, this slider requires [color and size visual variables](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#visualVariables) and a [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) object. Other optional properties may be used including adding a [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogram). Most of the various options that affect the UI of the slider are labeled in the image below. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html) */ @@ -56379,79 +56379,79 @@ declare namespace __esri { interface UnivariateColorSizeSliderProperties extends WidgetteProperties { /** * Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the [class description](#) to see where handles are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#handlesVisible) - * + * * @default true */ handlesVisible?: boolean; /** * The histogram associated with the data represented on the slider. This may be generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-histogram.html) statistics function. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogram) */ histogram?: HistogramResult; /** * Indicates whether to show the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogram) in the slider UI. See the image in the [class description](#) to see where the histogram is typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogramVisible) - * + * * @default true */ histogramVisible?: boolean; /** * The width of the histogram in pixels. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#histogramWidth) - * + * * @default 100 */ histogramWidth?: number; /** * Indicates whether to show labels in the slider UI. See the image in the [class description](#) to see where labels are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#labelsVisible) - * + * * @default true */ labelsVisible?: boolean; /** * The maximum value or upper bound of the slider. This value overrides the `max` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics), but may not be smaller than the upper value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxValue) */ maxValue?: number; /** * The minimum value or lower bound of the slider. This value overrides the `min` property of the [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics), but may not be greater than the lower value of the [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#values) array. This property may be set programmatically or by the user in the widget's UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minValue) */ minValue?: number; /** * The summary statistics of the data represented in the slider. This is an object that may be generated from the [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-statistics-summaryStatistics.html) statistics function. The `min` and `max` values in this object determine the [minValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#minValue) and [maxValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#maxValue) of the slider if values for those properties are not already provided. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ statistics?: UnivariateColorSizeSliderStatistics; /** * Indicates whether to show the average of the dataset in the slider UI. See the image in the [class description](#) to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statisticsVisible) - * + * * @default true */ statisticsVisible?: boolean; /** * Indicates whether to show tick marks next to the slider handles. See the image in the [class description](#) to see where ticks are typically placed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#ticksVisible) - * + * * @default true */ ticksVisible?: boolean; /** * The size and color visual variables represented by the slider. Since this slider represents univariate visualizations, both color and size visual variables must represent data from the same field or expression and be conicident. In other words, the lower stop or bound of the color visual variable must match the lower bound (or `minDataValue`) of the size visual variable. The same is true of the upper bounds of both visual variables. These must be set initially on the slider for it to render in the view. Both visual variables may be created manually (see snippet below) or generated from the [univariateColorSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-smartMapping-creators-univariateColorSize.html) helper methods. New coincident color and size visual variables are created each time the user slides the handles. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#visualVariables) */ visualVariables?: any[]; @@ -56461,25 +56461,25 @@ declare namespace __esri { export interface UnivariateColorSizeSliderStatistics extends Object { /** * The average of all data values represented in the size and color visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ avg: number; /** * The maximum of all data values represented in the size and color visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ max: number; /** * The minimum of all data values represented in the size and color visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ min: number; /** * The standard deviation calculated from all data values represented in the size and color visual variables. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UnivariateColorSizeSlider.html#statistics) */ stddev: number; @@ -56488,86 +56488,86 @@ declare namespace __esri { interface Widget extends Accessor, Evented { /** * The ID or node representing the DOM element containing the widget. This property can only be set once. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#container) */ container: string | HTMLElement; /** * When `true`, this property indicates whether the widget has been destroyed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#destroyed) */ destroyed: boolean; /** * The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#id) */ id: string; /** - * A utility method used for building the value for a widget's `class` property. This aids in simplifying CSS class setup. + * A utility method used for building the value for a widget's `class` property. This aids in simplifying CSS class setup. * > Prior to version 4.7, there were various approaches towards setting CSS classes. These were dependent upon variables, such as whether the classes were: * * a single static class, * * multiple static classes, or * * dynamic classes. - * - * + * + * * This helper method takes all of these approaches into account and simplifies it to use one single pattern to accommodate these multiple approaches. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#classes) - * + * * @param classNames The class names. - * + * */ classes(...classNames: (string | string[] | any)[]): string; /** * Destroys the widget instance. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#destroy) - * - * + * + * */ destroy(): void; /** * Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#own) - * + * * @param handles Handles marked for removal once the widget is destroyed. - * + * */ own(handles: WatchHandle | WatchHandle[]): void; /** * *This method is primarily used by developers when implementing custom widgets.* Executes after widget is ready for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#postInitialize) - * - * + * + * */ postInitialize(): void; /** * Renders widget to the DOM immediately. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#renderNow) - * - * + * + * */ renderNow(): void; /** * *This method is primarily used by developers when implementing custom widgets.* Schedules widget rendering. This method is useful for changes affecting the UI. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#scheduleRender) - * - * + * + * */ scheduleRender(): void; /** * **Deprecated.** Finalizes the creation of the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#startup) - * - * + * + * */ startup(): void; } @@ -56575,7 +56575,7 @@ declare namespace __esri { interface WidgetConstructor { /** * The base class for widgets. Each widget's presentation is separate from its properties, methods, and data. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html) */ @@ -56587,19 +56587,19 @@ declare namespace __esri { interface WidgetProperties { /** * The ID or node representing the DOM element containing the widget. This property can only be set once. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#container) */ container?: string | HTMLElement; /** * When `true`, this property indicates whether the widget has been destroyed. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#destroyed) */ destroyed?: boolean; /** * The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#id) */ id?: string; @@ -56608,35 +56608,35 @@ declare namespace __esri { interface Widgette { /** * The ID or node representing the DOM element containing the widget. Note that once set, this property cannot be modified afterwards. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#container) */ container: string | HTMLElement; /** * Indicates whether the widget is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#visible) - * + * * @default true */ visible: boolean; /** * Destroys the widget instance. Call this method when the widget is no longer needed by the application. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#destroy) - * - * + * + * */ destroy(): void; /** * Registers an event handler on the widget instance. Call this method to hook an event with a listener. See the [Events summary table](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#events-summary) for a list of supported events. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#on) - * + * * @param type The name of the event. * @param listener The function to call when the event is fired. - * + * */ on(type: string, listener: Function): any; } @@ -56652,15 +56652,15 @@ declare namespace __esri { interface WidgetteProperties { /** * The ID or node representing the DOM element containing the widget. Note that once set, this property cannot be modified afterwards. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#container) */ container?: string | HTMLElement; /** * Indicates whether the widget is visible. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widgette.html#visible) - * + * * @default true */ visible?: boolean; @@ -56669,59 +56669,59 @@ declare namespace __esri { interface Zoom extends Widget { /** * The widget's default CSS icon class. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#iconClass) */ readonly iconClass: string; /** * The widget's default label. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#label) */ readonly label: string; /** * Determines the layout/orientation of the Zoom widget. **Possible Values:** vertical | horizontal - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#layout) - * + * * @default vertical */ layout: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#view) */ view: MapView | SceneView; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ZoomViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#viewModel) */ viewModel: ZoomViewModel; /** * *This method is primarily used by developers when implementing custom widgets.* It must be implemented by subclasses for rendering. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#render) - * - * + * + * */ render(): any; /** * Zooms the view in by an LOD factor of 0.5. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#zoomIn) - * - * + * + * */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#zoomOut) - * - * + * + * */ zoomOut(): void; } @@ -56729,7 +56729,7 @@ declare namespace __esri { interface ZoomConstructor { /** * The Zoom widget allows users to zoom in/out within a view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html) */ @@ -56741,21 +56741,21 @@ declare namespace __esri { interface ZoomProperties extends WidgetProperties { /** * Determines the layout/orientation of the Zoom widget. **Possible Values:** vertical | horizontal - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#layout) - * + * * @default vertical */ layout?: string; /** * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Set this to link the widget to a specific view. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#view) */ view?: MapViewProperties | SceneViewProperties; /** * The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the [ZoomViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html) class to access all properties and methods on the widget. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom.html#viewModel) */ viewModel?: ZoomViewModelProperties; @@ -56764,45 +56764,45 @@ declare namespace __esri { interface ZoomViewModel extends Accessor { /** * Indicates if the view can zoom in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomIn) */ canZoomIn: boolean; /** * Indicates if the view can zoom out. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomOut) */ canZoomOut: boolean; /** * The current state of the widget. **Possible Values:** disabled | ready - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#state) - * + * * @default disabled */ readonly state: string; /** * The view from which to operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#view) */ view: MapView | SceneView; /** * Zooms the view in by an LOD factor of 0.5. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#zoomIn) - * - * + * + * */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#zoomOut) - * - * + * + * */ zoomOut(): void; } @@ -56818,19 +56818,19 @@ declare namespace __esri { interface ZoomViewModelProperties { /** * Indicates if the view can zoom in. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomIn) */ canZoomIn?: boolean; /** * Indicates if the view can zoom out. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#canZoomOut) */ canZoomOut?: boolean; /** * The view from which to operate. - * + * * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#view) */ view?: MapViewProperties | SceneViewProperties; diff --git a/types/chrome-apps/index.d.ts b/types/chrome-apps/index.d.ts index 33b760ce82..bb7be06311 100644 --- a/types/chrome-apps/index.d.ts +++ b/types/chrome-apps/index.d.ts @@ -9416,7 +9416,7 @@ declare namespace chrome { * If set, updates the display's rotation. * Legal values are [0, 90, 180, 270]. * The rotation is set clockwise, relative to the display's vertical position. - * It's applied after overscan paramter. + * It's applied after overscan parameter. */ rotation?: 0 | 90 | 180 | 270; diff --git a/types/commangular/commangular-mock.d.ts b/types/commangular/commangular-mock.d.ts index 134e4d0d1e..a31563bc9e 100644 --- a/types/commangular/commangular-mock.d.ts +++ b/types/commangular/commangular-mock.d.ts @@ -4,33 +4,33 @@ // Definitions: https://github.com/borisyankov/DefinitelyTyped declare module commangular { - + /////////////////////////////////////////////////////////////////////////// // Commangular Static // see http://commangular.org/docs/#commangular-namespace /////////////////////////////////////////////////////////////////////////// interface ICommAngularStatic { - + /** * Mock dispatch function for testing commands. */ dispatch( ec: ICommandCall, callback: Function ): void; } - + interface ICommandCall { /** * Name of the command that needs to * execute */ command: string; - + /** * Data that needs to be passed to the command */ data?: any; } - - + + /** * Object type expected to be passed into the callback function * of the dispatch() function @@ -41,25 +41,25 @@ declare module commangular { * @param key The property name that is in the object that was passed */ dataPassed( key : string ) : any; - + /** * The data that was returned by the command * @param key The result key that was defined in the command. If no result * was defined use 'lastResult' as the key */ resultKey( key: string ): any; - + /** * Indicates if the command execution was cancelled. */ canceled( ): boolean; - + /** * Indicates if the command was executed???? */ commandExecuted( ): boolean; } - + } @@ -67,7 +67,6 @@ declare module commangular { * Mock dispatch function for testing commands. * @param ec an ICommandCall object * @param callback The function that will be called upon the completion of the command -* function should expecte an ICommandInfo paramter. +* function should expecte an ICommandInfo parameter. */ -declare function dispatch( ec: commangular.ICommandCall, callback: Function ): void; - +declare function dispatch( ec: commangular.ICommandCall, callback: Function ): void; diff --git a/types/dojo/dijit.d.ts b/types/dojo/dijit.d.ts index b22742b85d..e476d66edd 100644 --- a/types/dojo/dijit.d.ts +++ b/types/dojo/dijit.d.ts @@ -11,7 +11,7 @@ declare module dijit { * * Deprecated module for enabling textdir support in the dijit widgets. New code should just define * has("dojo-bidi") to return true, rather than manually requiring this module. - * + * */ interface _BidiSupport{(): void} /** @@ -19,24 +19,24 @@ declare module dijit { * * For IE/FF z-index shenanigans. id attribute is required. * new dijit.BackgroundIframe(node). - * + * * Makes a background iframe as a child of node, that fills * area (and position) of node - * - * @param node + * + * @param node */ interface BackgroundIframe{(node: HTMLElement): void} module BackgroundIframe { /** * destroy the iframe - * + * */ interface destroy{(): void} /** * Resize the iframe so it's the same size as node. * Needed on IE6 and IE/quirks because height:100% doesn't work right. - * - * @param node + * + * @param node */ interface resize{(node: any): void} } @@ -46,7 +46,7 @@ declare module dijit { * * Test if computer is in high contrast mode, and sets dijit_a11y flag on if it is. * Deprecated, use dojo/hccss instead. - * + * */ interface hccss{(): void} /** @@ -54,39 +54,39 @@ declare module dijit { * * Mixin for widgets to attach to dom nodes and setup events via * convenient data-dojo-attach-point and data-dojo-attach-event DOM attributes. - * + * * Superclass of _TemplatedMixin, and can also be used standalone when templates are pre-rendered on the * server. - * + * * Does not [yet] handle widgets like ContentPane with this.containerNode set. It should skip * scanning for data-dojo-attach-point and data-dojo-attach-event inside this.containerNode, but it * doesn't. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _AttachMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * Search descendants of this.containerNode for data-dojo-attach-point and data-dojo-attach-event. * Should generally be left false (the default value) both for performance and to avoid failures when * this.containerNode holds other _AttachMixin instances with their own attach points and events. - * + * */ "searchContainerNode": boolean; /** * Attach to DOM nodes marked with special attributes. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; } @@ -94,7 +94,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_Container.html * * Mixin for widgets that contain HTML and/or a set of widget children. - * + * */ class _Container { constructor(); @@ -102,40 +102,40 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** - * + * */ buildRendering(): void; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; @@ -144,7 +144,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_Contained.html * * Mixin for widgets that are children of a container widget - * + * */ class _Contained { constructor(); @@ -152,19 +152,19 @@ declare module dijit { * Returns the index of this widget within its container parent. * It returns -1 if the parent does not exist, or if the parent * is not a dijit/_Container - * + * */ getIndexInParent(): any; /** * Returns null if this is the last child of the parent, * otherwise returns the next element sibling to the "right". - * + * */ getNextSibling(): any; /** * Returns null if this is the first child of the parent, * otherwise returns the next element sibling to the "left". - * + * */ getPreviousSibling(): any; } @@ -172,7 +172,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_DialogMixin.html * * This provides functions useful to Dialog and TooltipDialog - * + * */ class _DialogMixin { constructor(); @@ -182,10 +182,10 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** @@ -193,7 +193,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** @@ -201,7 +201,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; } @@ -214,40 +214,40 @@ declare module dijit { * maintain CSS classes on the widget root node (this.domNode) depending on hover, * active, focus, etc. state. Ex: with a baseClass of dijitButton, it will apply the classes * dijitButtonHovered and dijitButtonActive, as the user moves the mouse over the widget and clicks it. - * + * * It also sets CSS like dijitButtonDisabled based on widget semantic state. - * + * * By setting the cssStateNodes attribute, a widget can also track events on subnodes (like buttons * within the widget). - * + * */ class _CssStateMixin { constructor(); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; /** * True if cursor is over this widget - * + * */ "hovering": boolean; } @@ -256,7 +256,7 @@ declare module dijit { * * Mixin to widget to provide _onFocus() and _onBlur() methods that * fire when a widget or its descendants get/lose focus - * + * */ class _FocusMixin { constructor(); @@ -265,7 +265,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_HasDropDown.html * * Mixin for widgets that need drop down ability. - * + * */ class _HasDropDown extends dijit._FocusMixin { constructor(); @@ -273,19 +273,19 @@ declare module dijit { * Set to true to make the drop down at least as wide as this * widget. Set to false if the drop down should just be its * default width. - * + * */ "autoWidth": boolean; /** * The widget to display as a popup. This widget must be * defined before the startup function is called. - * + * */ "dropDown": Object; /** * This variable controls the position of the drop down. * It's an array of strings with the following values: - * + * * before: places drop down to the left of the target node/widget, or to the right in * the case of RTL scripts like Hebrew and Arabic * after: places drop down to the right of the target node/widget, or to the left in @@ -294,40 +294,40 @@ declare module dijit { * below: drop down goes below target node * The list is positions is tried, in order, until a position is found where the drop down fits * within the viewport. - * + * */ "dropDownPosition": Object; /** * Set to true to make the drop down exactly as wide as this * widget. Overrides autoWidth. - * + * */ "forceWidth": boolean; /** * The max height for our dropdown. * Any dropdown taller than this will have scrollbars. * Set to 0 for no max height, or -1 to limit height to available space in viewport - * + * */ "maxHeight": number; /** - * + * */ buildRendering(): void; /** * Closes the drop down on this widget - * - * @param focus If true, refocuses the button widget + * + * @param focus If true, refocuses the button widget */ closeDropDown(focus: boolean): void; /** - * + * */ destroy(): void; /** * Returns true if the dropdown exists and it's data is loaded. This can * be overridden in order to force a call to loadDropDown(). - * + * */ isLoaded(): boolean; /** @@ -335,33 +335,33 @@ declare module dijit { * if there's an href and it hasn't been loaded yet, and * then opens the drop down. This is basically a callback when the * user presses the down arrow button to open the drop down. - * + * */ loadAndOpenDropDown(): any; /** * Creates the drop down if it doesn't exist, loads the data * if there's an href and it hasn't been loaded yet, and then calls * the given callback. - * - * @param loadCallback + * + * @param loadCallback */ loadDropDown(loadCallback: Function): void; /** * Opens the dropdown for this widget. To be called only when this.dropDown * has been created and is ready to display (ie, it's data is loaded). - * + * */ openDropDown(): any; /** * set up nodes and connect our mouse and keyboard events - * + * */ postCreate(): void; /** * Callback when the user presses the down arrow button or presses * the down arrow key to open/close the drop down. * Toggle the drop-down widget; if it is up, close it, if not, open it - * + * */ toggleDropDown(): void; } @@ -371,9 +371,9 @@ declare module dijit { * A mixin to allow arrow key and letter key navigation of child or descendant widgets. * It can be used by dijit/_Container based widgets with a flat list of children, * or more complex widgets like dijit/Tree. - * + * * To use this mixin, the subclass must: - * + * * - Implement _getNext(), _getFirst(), _getLast(), _onLeftArrow(), _onRightArrow() * _onDownArrow(), _onUpArrow() methods to handle home/end/left/right/up/down keystrokes. * Next and previous in this context refer to a linear ordering of the descendants used @@ -382,7 +382,7 @@ declare module dijit { * descendants added later, by for example addChild() * - Define childSelector to a function or string that identifies focusable descendant widgets * Also, child widgets must implement a focus() method. - * + * */ class _KeyNavMixin extends dijit._FocusMixin { constructor(); @@ -390,65 +390,65 @@ declare module dijit { * Selector (passed to on.selector()) used to identify what to treat as a child widget. Used to monitor * focus events and set this.focusedChild. Must be set by implementing class. If this is a string * (ex: "> *") then the implementing class must require dojo/query. - * + * */ "childSelector": any; /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; /** * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; /** * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** - * + * */ postCreate(): void; /** * When a key is pressed that matches a child item, * this method is called so that a widget can take appropriate action is necessary. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit._WidgetBase, evt: Event, searchString: String, numMatches: number): void; } @@ -459,136 +459,136 @@ declare module dijit { * Provides normalized keyboard and focusing code for Container widgets. * To use this mixin, call connectKeyNavHandlers() in postCreate(). * Also, child widgets must implement a focus() method. - * + * */ class _KeyNavContainer extends dijit._FocusMixin implements dijit._KeyNavMixin, dijit._Container { constructor(); /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; /** * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; /** * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** - * + * */ buildRendering(): void; /** - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** - * + * */ postCreate(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * When a key is pressed that matches a child item, * this method is called so that a widget can take appropriate action is necessary. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit._WidgetBase, evt: Event, searchString: String, numMatches: number): void; } @@ -596,26 +596,26 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_OnDijitClickMixin.html * * Deprecated. New code should access the dijit/a11yclick event directly, ex: - * + * * this.own(on(node, a11yclick, function(){ ... })); * Mixing in this class will make _WidgetBase.connect(node, "ondijitclick", ...) work. * It also used to be necessary to make templates with ondijitclick work, but now you can just require * dijit/a11yclick. - * + * */ class _OnDijitClickMixin { constructor(); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: any, method: any): any; } @@ -625,35 +625,35 @@ declare module dijit { * * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ interface a11yclick { /** * Logical click operation for mouse, touch, or keyboard (space/enter key) - * - * @param node - * @param listener + * + * @param node + * @param listener */ click(node: any, listener: any): void; /** * Mouse cursor or a finger is dragged over the given node. - * - * @param node - * @param listener + * + * @param node + * @param listener */ move(node: any, listener: any): void; /** * Mousedown (left button), touchstart, or keydown (space or enter) corresponding to logical click operation. - * - * @param node - * @param listener + * + * @param node + * @param listener */ press(node: any, listener: any): void; /** * Mouseup (left button), touchend, or keyup (space or enter) corresponding to logical click operation. - * - * @param node - * @param listener + * + * @param node + * @param listener */ release(node: any, listener: any): void; } @@ -664,83 +664,83 @@ declare module dijit { * * A keyboard accessible palette, for picking a color/emoticon/etc. * A mixin for a grid showing various entities, so the user can pick a certain entity. - * + * */ class _PaletteMixin extends dijit._CssStateMixin { constructor(); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * CSS class applied to each cell in the palette - * + * */ "cellClass": string; /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; /** * Number of milliseconds before a held key or button becomes typematic - * + * */ "defaultTimeout": number; /** * Constructor for Object created for each cell of the palette. * dyeClass should implement the dijit/_PaletteMixin.__Dye interface. - * + * */ "dyeClass": Object; /** * True if cursor is over this widget - * + * */ "hovering": boolean; /** * Widget tab index. - * + * */ "tabIndex": string; /** * Fraction of time used to change the typematic timer between events * 1.0 means that each typematic event fires at defaultTimeout intervals * Less than 1.0 means that each typematic event fires at an increasing faster rate - * + * */ "timeoutChangeRate": number; /** * Currently selected color/emoticon/etc. - * + * */ "value": string; /** * Focus this widget. Puts focus on the most recently focused cell. - * + * */ focus(): void; /** - * + * */ postCreate(): void; /** * Callback when a cell is selected. - * - * @param value Value corresponding to cell. + * + * @param value Value corresponding to cell. */ onChange(value: String): void; } @@ -749,24 +749,24 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_PaletteMixin.__Dye.html * * Interface for the JS Object associated with a palette cell (i.e. DOMNode) - * - * @param alias - * @param row - * @param col + * + * @param alias + * @param row + * @param col */ class __Dye { constructor(alias: String, row: any, col: any); /** * Add cell DOMNode inner structure - * - * @param cell The surrounding cell - * @param blankGif URL for blank cell image + * + * @param cell The surrounding cell + * @param blankGif URL for blank cell image */ fillCell(cell: HTMLElement, blankGif: String): void; /** * Return "value" of cell; meaning of "value" varies by subclass. * For example color hex value, emoticon ascii value etc, entity hex value. - * + * */ getValue(): void; } @@ -776,50 +776,50 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TemplatedMixin.html * * Mixin for widgets that are instantiated from a template - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _TemplatedMixin extends dijit._AttachMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** - * + * */ "searchContainerNode": boolean; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; /** * Static method to get a template based on the templatePath or * templateString key - * - * @param templateString The template - * @param alwaysUseString Don't cache the DOM tree for this template, even if it doesn't have any variables - * @param doc OptionalThe target document. Defaults to document global if unspecified. + * + * @param templateString The template + * @param alwaysUseString Don't cache the DOM tree for this template, even if it doesn't have any variables + * @param doc OptionalThe target document. Defaults to document global if unspecified. */ getCachedTemplate(templateString: String, alwaysUseString: boolean, doc?: HTMLDocument): any; } @@ -827,7 +827,7 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TemplatedMixin._templateCache.html * - * + * */ interface _templateCache { } @@ -838,55 +838,55 @@ declare module dijit { * * Deprecated mixin for widgets that are instantiated from a template. * Widgets should use _TemplatedMixin plus if necessary _WidgetsInTemplateMixin instead. - * + * */ class _Templated extends dijit._TemplatedMixin implements dijit._WidgetsInTemplateMixin { constructor(); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** - * + * */ "searchContainerNode": boolean; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; /** * Should we parse the template to find widgets that might be * declared in markup inside it? False by default. - * + * */ "widgetsInTemplate": boolean; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; /** - * + * */ startup(): void; /** @@ -900,9 +900,9 @@ declare module dijit { * * Abstract base class for Menu and MenuBar. * Subclass should implement _onUpArrow(), _onDownArrow(), _onLeftArrow(), and _onRightArrow(). - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MenuBase extends dijit._Widget implements dijit._TemplatedMixin, dijit._KeyNavContainer, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); @@ -912,7 +912,7 @@ declare module dijit { * since TAB is a navigation operation and not a selection one. * For Windows apps, pressing the ALT key focuses the menubar menus (similar to TAB navigation) but the * menu is not active (ie no dropdown) until an item is clicked. - * + * */ "activated": boolean; set(property:"activated", value: boolean): void; @@ -920,7 +920,7 @@ declare module dijit { watch(property:"activated", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -929,7 +929,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -938,44 +938,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -984,7 +984,7 @@ declare module dijit { /** * A toggle to control whether or not a Menu gets focused when opened as a drop down from a MenuBar * or DropDownButton/ComboButton. Note though that it always get focused when opened via the keyboard. - * + * */ "autoFocus": boolean; set(property:"autoFocus", value: boolean): void; @@ -993,14 +993,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -1010,24 +1010,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -1036,18 +1036,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -1057,7 +1057,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -1068,7 +1068,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -1077,7 +1077,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -1085,7 +1085,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; set(property:"focusedChild", value: Object): void; @@ -1093,7 +1093,7 @@ declare module dijit { watch(property:"focusedChild", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -1104,7 +1104,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -1115,7 +1115,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -1125,10 +1125,10 @@ declare module dijit { * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; set(property:"multiCharSearchDuration", value: number): void; @@ -1137,7 +1137,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -1145,7 +1145,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to menu that displayed me - * + * */ "parentMenu": Object; set(property:"parentMenu", value: Object): void; @@ -1154,7 +1154,7 @@ declare module dijit { /** * For a passive (unclicked) Menu, number of milliseconds before hovering (without clicking) will cause * the popup to open. Default is Infinity, meaning you need to click the menu to open it. - * + * */ "passivePopupDelay": number; set(property:"passivePopupDelay", value: number): void; @@ -1163,14 +1163,14 @@ declare module dijit { /** * After a menu has been activated (by clicking on it etc.), number of milliseconds before hovering * (without clicking) another MenuItem causes that MenuItem's popup to automatically open. - * + * */ "popupDelay": number; set(property:"popupDelay", value: number): void; get(property:"popupDelay"): number; watch(property:"popupDelay", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -1181,7 +1181,7 @@ declare module dijit { * If a submenu is open, will be set to MenuItem that displayed the submenu. OTOH, if * this Menu is in passive mode (i.e. hasn't been clicked yet), will be null, because * "selected" is not merely "hovered". - * + * */ "selected": Object; set(property:"selected", value: Object): void; @@ -1189,7 +1189,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -1197,7 +1197,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -1207,7 +1207,7 @@ declare module dijit { * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -1216,7 +1216,7 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; @@ -1225,7 +1225,7 @@ declare module dijit { /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -1233,14 +1233,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -1249,210 +1249,210 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; get(property:"tooltip"): string; watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Selector (passed to on.selector()) used to identify MenuItem child widgets, but exclude inert children * like MenuSeparator. If subclass overrides to a string (ex: "> *"), the subclass must require dojo/query. - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -1460,69 +1460,69 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** @@ -1530,15 +1530,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -1546,65 +1546,65 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(...args: any[]): any[]; /** @@ -1613,9 +1613,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -1624,9 +1624,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -1635,9 +1635,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -1646,9 +1646,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -1657,9 +1657,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -1668,13 +1668,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -1682,82 +1682,82 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -1765,29 +1765,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -1800,27 +1800,27 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Attach point for notification about when the user cancels the current menu * This is an internal mechanism used for Menus to signal to their parent to * close them. In general developers should not attach to or override this method. - * - * @param closeAll + * + * @param closeAll */ onCancel(closeAll: boolean): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** @@ -1828,114 +1828,114 @@ declare module dijit { * This is an internal mechanism used for Menus to signal to their parent to * close them, because they are about to execute the onClick handler. In * general developers should not attach to or override this method. - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Called when cursor is over a MenuItem. - * - * @param item + * + * @param item */ onItemHover(item: dijit.MenuItem): void; /** * Callback fires when mouse exits a MenuItem - * - * @param item + * + * @param item */ onItemUnhover(item: dijit.MenuItem): void; /** * Attach point for notification about when a menu item has been searched for * via the keyboard search mechanism. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit.MenuItem, evt: Event, searchString: String, numMatches: number): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -1943,24 +1943,24 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_WidgetsInTemplateMixin.html * * Mixin to supplement _TemplatedMixin when template contains widgets - * + * */ class _WidgetsInTemplateMixin { constructor(); /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; /** - * + * */ startup(): void; } @@ -1970,90 +1970,90 @@ declare module dijit { * Future base class for all Dijit widgets. * Future base class for all Dijit widgets. * _Widget extends this class adding support for various features needed by desktop. - * + * * Provides stubs for widget lifecycle methods for subclasses to extend, like postMixInProperties(), buildRendering(), * postCreate(), startup(), and destroy(), and also public API methods like set(), get(), and watch(). - * + * * Widgets can provide custom setters/getters for widget attributes, which are called automatically by set(name, value). * For an attribute XXX, define methods _setXXXAttr() and/or _getXXXAttr(). - * + * * _setXXXAttr can also be a string/hash/array mapping from a widget attribute XXX to the widget's DOMNodes: - * + * * DOM node attribute * _setFocusAttr: {node: "focusNode", type: "attribute"} * _setFocusAttr: "focusNode" (shorthand) * _setFocusAttr: "" (shorthand, maps to this.domNode) * Maps this.focus to this.focusNode.focus, or (last example) this.domNode.focus - * + * * DOM node innerHTML * _setTitleAttr: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * _setTitleAttr: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * _setMyClassAttr: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value of _setXXXAttr is an array, then each element in the array matches one of the * formats of the above list. - * + * * If the custom setter is null, no action is performed other than saving the new value * in the widget (in this). - * + * * If no custom setter is defined for an attribute, then it will be copied * to this.focusNode (if the widget defines a focusNode), or this.domNode otherwise. * That's only done though for attributes that match DOMNode attributes (title, * alt, aria-labelledby, etc.) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _WidgetBase extends dojo.Stateful implements dijit.Destroyable { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -2062,14 +2062,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -2079,24 +2079,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -2106,7 +2106,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -2117,7 +2117,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -2126,7 +2126,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -2137,7 +2137,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -2148,7 +2148,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -2157,7 +2157,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -2165,7 +2165,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -2173,7 +2173,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": Object; set(property:"style", value: Object): void; @@ -2181,14 +2181,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -2197,7 +2197,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -2206,165 +2206,165 @@ declare module dijit { /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -2372,36 +2372,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -2409,15 +2409,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -2425,33 +2425,33 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * + * */ isValid: any; /** @@ -2459,9 +2459,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): {remove:{():void}}; /** @@ -2469,15 +2469,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): {remove:{():void}}; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(handle:any): any; /** @@ -2486,9 +2486,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -2497,9 +2497,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -2508,9 +2508,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -2519,9 +2519,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -2530,9 +2530,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -2541,9 +2541,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -2551,7 +2551,7 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** @@ -2559,55 +2559,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -2615,29 +2615,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -2645,14 +2645,14 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; } @@ -2661,9 +2661,9 @@ declare module dijit { * * Old base class for widgets. New widgets should extend dijit/_WidgetBase instead * Old Base class for Dijit widgets. - * + * * Extends _WidgetBase, adding support for: - * + * * declaratively/programatically specifying widget initialization parameters like * onMouseMove="foo" that call foo when this.domNode gets a mousemove event * ondijitclick: @@ -2674,62 +2674,62 @@ declare module dijit { * deprecated methods * onShow(), onHide(), onClose() * Also, by loading code in dijit/_base, turns on: - * + * * browser sniffing (putting browser class like dj_ie on node) * high contrast mode sniffing (add dijit_a11y class to if machine is in high contrast mode) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _Widget extends dijit._WidgetBase implements dijit._OnDijitClickMixin, dijit._FocusMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -2738,14 +2738,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -2755,24 +2755,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -2782,7 +2782,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -2790,7 +2790,7 @@ declare module dijit { watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Defines a type of widget. - * + * */ "dndType": string; set(property:"dndType", value: string): void; @@ -2801,7 +2801,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -2810,7 +2810,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -2821,7 +2821,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -2832,14 +2832,14 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; get(property:"lang"): string; watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "observer": string; set(property:"observer", value: string): void; @@ -2848,18 +2848,18 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * A parameter needed by RadioGroupSlide only. An optional paramter to force + * A parameter needed by RadioGroupSlide only. An optional parameter to force * the ContentPane to slide in from a set direction. Defaults * to "random", or specify one of "top", "left", "right", "bottom" * to slideFrom top, left, right, or bottom. - * + * */ "slideFrom": string; set(property:"slideFrom", value: string): void; @@ -2867,7 +2867,7 @@ declare module dijit { watch(property:"slideFrom", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -2875,7 +2875,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": Object; set(property:"style", value: Object): void; @@ -2883,14 +2883,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -2899,7 +2899,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -2907,180 +2907,180 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -3088,36 +3088,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -3125,15 +3125,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -3141,54 +3141,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -3197,9 +3197,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -3208,9 +3208,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -3219,9 +3219,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -3230,9 +3230,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -3241,9 +3241,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -3252,13 +3252,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -3266,62 +3266,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -3329,29 +3329,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -3359,114 +3359,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -3475,53 +3475,53 @@ declare module dijit { * * A time picker dropdown, used by dijit/form/TimeTextBox. * This widget is not available as a standalone widget due to lack of accessibility support. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class _TimePicker extends dijit._WidgetBase implements dijit.form._ListMouseMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -3529,14 +3529,14 @@ declare module dijit { watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * The root className to use for the various states of this widget - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -3548,7 +3548,7 @@ declare module dijit { * Set in local time, without a time zone. * Example: T00:15:00 creates 15 minute increments * Must divide dijit/_TimePicker.visibleIncrement evenly - * + * */ "clickableIncrement": string; set(property:"clickableIncrement", value: string): void; @@ -3556,7 +3556,7 @@ declare module dijit { watch(property:"clickableIncrement", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Specifies valid range of times (start time, end time) - * + * */ "constraints": Object; set(property:"constraints", value: Object): void; @@ -3566,24 +3566,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -3593,7 +3593,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -3604,7 +3604,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -3612,7 +3612,7 @@ declare module dijit { watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * The string to filter by - * + * */ "filterString": string; set(property:"filterString", value: string): void; @@ -3621,7 +3621,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -3632,7 +3632,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -3643,7 +3643,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -3652,7 +3652,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -3660,7 +3660,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * currently selected node - * + * */ "selected": HTMLElement; set(property:"selected", value: HTMLElement): void; @@ -3668,7 +3668,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -3676,7 +3676,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -3684,14 +3684,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -3700,7 +3700,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -3720,7 +3720,7 @@ declare module dijit { * T10:00:00Z becomes T05:00:00-05:00 (5 hour difference between Zulu and local time) * yyyy-mm-ddThh:mm:ss is the format to set the date and time * Example: 2007-06-01T09:00:00 - * + * */ "value": string; set(property:"value", value: string): void; @@ -3731,172 +3731,172 @@ declare module dijit { * every element with a visible time in the time picker increases. * Set in local time, without a time zone. * Example: T01:00:00 creates text in every 1 hour increment - * + * */ "visibleIncrement": string; set(property:"visibleIncrement", value: string): void; get(property:"visibleIncrement"): string; watch(property:"visibleIncrement", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -3904,36 +3904,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -3941,15 +3941,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -3957,43 +3957,43 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Called from dijit/form/_DateTimeTextBox to pass a keypress event * from the dijit/form/TimeTextBox to be handled in this widget - * - * @param e + * + * @param e */ handleKey(e: Event): any; /** * May be overridden to disable certain dates in the TimePicker e.g. isDisabledDate=locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -4001,9 +4001,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -4011,15 +4011,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -4028,9 +4028,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -4039,9 +4039,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -4050,9 +4050,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -4061,9 +4061,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -4072,9 +4072,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -4083,9 +4083,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -4093,34 +4093,34 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** * Select the first displayed item in the list. - * + * */ selectFirstNode(): void; /** * Select the last displayed item in the list - * + * */ selectLastNode(): void; /** * Select the item just below the current selection. * If nothing selected, select first node. - * + * */ selectNextNode(): void; /** * Select the item just above the current selection. * If nothing selected, select last node (if * you select Previous and try to keep scrolling up the list). - * + * */ selectPreviousNode(): void; /** @@ -4128,63 +4128,63 @@ declare module dijit { * When options.selector is omitted, output follows RFC3339 * The local time zone is included as an offset from GMT, except when selector=='time' (time without a date) * Does not check bounds. Only years between 100 and 9999 are supported. - * - * @param dateObject A Date object - * @param options OptionalAn object with the following properties:selector (String): "date" or "time" for partial formatting of the Date object.Both date and time will be formatted by default.zulu (Boolean): if true, UTC/GMT is used for a timezonemilliseconds (Boolean): if true, output milliseconds + * + * @param dateObject A Date object + * @param options OptionalAn object with the following properties:selector (String): "date" or "time" for partial formatting of the Date object.Both date and time will be formatted by default.zulu (Boolean): if true, UTC/GMT is used for a timezonemilliseconds (Boolean): if true, output milliseconds */ serialize(dateObject: Date, options?: Object): any; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Used set('value') instead. - * - * @param value + * + * @param value */ setValue(value: Date): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -4192,29 +4192,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -4222,49 +4222,49 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Notification that a time was selected. It may be the same as the previous value. - * - * @param time + * + * @param time */ onChange(time: Date): void; /** - * - * @param node + * + * @param node */ onClick(node: HTMLElement): void; /** - * - * @param node + * + * @param node */ onDeselect(node: HTMLElement): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** - * - * @param node + * + * @param node */ onHover(node: HTMLElement): void; /** - * + * */ onOpen(): void; /** - * - * @param node + * + * @param node */ onSelect(node: HTMLElement): void; /** - * - * @param node + * + * @param node */ onUnhover(node: HTMLElement): void; } @@ -4272,58 +4272,58 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TimePicker.__Constraints.html * - * + * */ class __Constraints { constructor(); /** * override strings for am in times - * + * */ "am": string; /** * See dijit/_TimePicker.clickableIncrement - * + * */ "clickableIncrement": string; /** * override pattern with this string - * + * */ "datePattern": string; /** * choice of long, short, medium or full (plus any custom additions). Defaults to 'short' - * + * */ "formatLength": string; /** * (format only) use 4 digit years whenever 2 digit years are called for - * + * */ "fullYear": boolean; /** * override the locale used to determine formatting rules - * + * */ "locale": string; /** * override strings for pm in times - * + * */ "pm": string; /** * choice of 'time','date' (default: date and time) - * + * */ "selector": string; /** * (parse only) strict parsing, off by default - * + * */ "strict": boolean; /** * override pattern with this string - * + * */ "timePattern": string; } @@ -4336,20 +4336,20 @@ declare module dijit { * Call this.own(...) on list of handles (returned from dojo/aspect, dojo/on, * dojo/Stateful::watch, or any class (including widgets) with a destroyRecursive() or destroy() method. * Then call destroy() later to destroy this instance and release the resources. - * + * */ class Destroyable { constructor(); /** * Destroy this class, releasing any resources registered via own(). - * - * @param preserveDom + * + * @param preserveDom */ destroy(preserveDom?: boolean): void; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(handle:any): any; } @@ -4360,22 +4360,22 @@ declare module dijit { * A simple GUI for choosing a date in the context of a monthly calendar. * This widget can't be used in a form because it doesn't serialize the date to an * field. For a form element, use dijit/form/DateTextBox instead. - * + * * Note that the parser takes all dates attributes passed in the * RFC 3339 format, e.g. 2005-06-30T08:05:00-07:00 * so that they are serializable and locale-independent. - * + * * Also note that this widget isn't keyboard accessible; use dijit.Calendar for that - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class CalendarLite extends dijit._WidgetBase implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -4384,58 +4384,58 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -4445,24 +4445,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -4472,7 +4472,7 @@ declare module dijit { * Date object containing the currently focused date, or the date which would be focused * if the calendar itself was focused. Also indicates which year and month to display, * i.e. the current "page" the calendar is on. - * + * */ "currentFocus": Date; set(property:"currentFocus", value: Date): void; @@ -4481,14 +4481,14 @@ declare module dijit { /** * JavaScript namespace to find calendar routines. If unspecified, uses Gregorian calendar routines * at dojo/date and dojo/date/locale. - * + * */ "datePackage": string; set(property:"datePackage", value: string): void; get(property:"datePackage"): string; watch(property:"datePackage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "dateTemplateString": string; set(property:"dateTemplateString", value: string): void; @@ -4496,7 +4496,7 @@ declare module dijit { watch(property:"dateTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * How to represent the days of the week in the calendar header. See locale - * + * */ "dayWidth": string; set(property:"dayWidth", value: string): void; @@ -4506,7 +4506,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -4517,14 +4517,14 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; get(property:"domNode"): HTMLElement; watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "dowTemplateString": string; set(property:"dowTemplateString", value: string): void; @@ -4535,7 +4535,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -4546,7 +4546,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -4555,14 +4555,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -4570,7 +4570,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -4578,7 +4578,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -4586,7 +4586,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -4595,14 +4595,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -4610,14 +4610,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -4626,7 +4626,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -4634,179 +4634,179 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The currently selected Date, initially set to invalid date to indicate no selection. - * + * */ "value": Date; set(property:"value", value: Date): void; get(property:"value"): Date; watch(property:"value", callback:{(property?:string, oldValue?:Date, newValue?: Date):void}) :{unwatch():void} /** - * + * */ "weekTemplateString": string; set(property:"weekTemplateString", value: string): void; get(property:"weekTemplateString"): string; watch(property:"weekTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -4814,41 +4814,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus the calendar by focusing one of the calendar cells - * + * */ focus(): void; /** @@ -4856,15 +4856,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -4872,49 +4872,49 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * May be overridden to return CSS classes to associate with the date entry for the given dateObject, * for example to indicate a holiday in specified locale. - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ getClassForDate(dateObject: Date, locale?: String): String; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Sets calendar's value to today's date - * + * */ goToToday(): void; /** * May be overridden to disable certain dates in the calendar e.g. isDisabledDate=dojo.date.locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -4922,9 +4922,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -4932,15 +4932,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -4949,9 +4949,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -4960,9 +4960,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -4971,9 +4971,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -4982,9 +4982,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -4993,9 +4993,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -5004,13 +5004,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -5018,55 +5018,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -5074,29 +5074,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -5106,8 +5106,8 @@ declare module dijit { getCachedTemplate(): any; /** * Called only when the selected date has changed - * - * @param date + * + * @param date */ onChange(date: Date): void; } @@ -5117,60 +5117,60 @@ declare module dijit { * * Displays name of current month padded to the width of the month * w/the longest name, so that changing months doesn't change width. - * + * * Create as: - * + * * new Calendar._MonthWidget({ * lang: ..., * dateLocaleModule: ... * }) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthWidget extends dijit._WidgetBase { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -5179,14 +5179,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -5196,24 +5196,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -5223,7 +5223,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -5234,7 +5234,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -5245,7 +5245,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -5256,7 +5256,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -5265,7 +5265,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -5273,7 +5273,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -5281,7 +5281,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -5289,14 +5289,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -5305,7 +5305,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -5314,165 +5314,165 @@ declare module dijit { /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -5480,36 +5480,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -5517,15 +5517,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -5533,29 +5533,29 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -5563,9 +5563,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -5573,15 +5573,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -5590,9 +5590,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -5601,9 +5601,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -5612,9 +5612,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -5623,9 +5623,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -5634,9 +5634,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -5645,9 +5645,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -5655,7 +5655,7 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** @@ -5663,55 +5663,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -5719,29 +5719,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; } @@ -5752,53 +5752,53 @@ declare module dijit { * * The Declaration widget allows a developer to declare new widget * classes directly from a snippet of markup. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Declaration extends dijit._Widget { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -5807,14 +5807,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -5824,31 +5824,31 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "defaults": Object; set(property:"defaults", value: Object): void; @@ -5858,7 +5858,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -5869,7 +5869,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -5878,7 +5878,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -5889,7 +5889,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -5900,7 +5900,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -5909,7 +5909,7 @@ declare module dijit { /** * List containing the prototype for this widget, and also any mixins, * ex: ["dijit._Widget", "dijit._Container"] - * + * */ "mixins": Object; set(property:"mixins", value: Object): void; @@ -5918,7 +5918,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -5926,7 +5926,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -5934,7 +5934,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -5942,14 +5942,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -5958,7 +5958,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -5966,7 +5966,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Name of class being declared, ex: "acme.myWidget" - * + * */ "widgetClass": string; set(property:"widgetClass", value: string): void; @@ -5974,178 +5974,178 @@ declare module dijit { watch(property:"widgetClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -6153,36 +6153,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -6190,15 +6190,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -6206,54 +6206,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -6262,9 +6262,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -6273,9 +6273,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -6284,9 +6284,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -6295,9 +6295,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -6306,9 +6306,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -6317,13 +6317,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -6331,62 +6331,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -6394,29 +6394,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -6424,114 +6424,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -6540,26 +6540,26 @@ declare module dijit { * * A simple GUI for choosing a date in the context of a monthly calendar. * See CalendarLite for general description. Calendar extends CalendarLite, adding: - * + * * month drop down list * keyboard navigation * CSS classes for hover/mousepress on date, month, and year nodes * support of deprecated methods (will be removed in 2.0) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class Calendar extends dijit.CalendarLite implements dijit._Widget, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -6568,7 +6568,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -6577,58 +6577,58 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -6638,31 +6638,31 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -6672,7 +6672,7 @@ declare module dijit { * Date object containing the currently focused date, or the date which would be focused * if the calendar itself was focused. Also indicates which year and month to display, * i.e. the current "page" the calendar is on. - * + * */ "currentFocus": Date; set(property:"currentFocus", value: Date): void; @@ -6681,14 +6681,14 @@ declare module dijit { /** * JavaScript namespace to find calendar routines. If unspecified, uses Gregorian calendar routines * at dojo/date and dojo/date/locale. - * + * */ "datePackage": string; set(property:"datePackage", value: string): void; get(property:"datePackage"): string; watch(property:"datePackage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "dateTemplateString": string; set(property:"dateTemplateString", value: string): void; @@ -6696,7 +6696,7 @@ declare module dijit { watch(property:"dateTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * How to represent the days of the week in the calendar header. See locale - * + * */ "dayWidth": string; set(property:"dayWidth", value: string): void; @@ -6706,7 +6706,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -6717,14 +6717,14 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; get(property:"domNode"): HTMLElement; watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "dowTemplateString": string; set(property:"dowTemplateString", value: string): void; @@ -6732,7 +6732,7 @@ declare module dijit { watch(property:"dowTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Defines a type of widget. - * + * */ "dndType": string; set(property:"dndType", value: string): void; @@ -6741,7 +6741,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -6749,7 +6749,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -6760,7 +6760,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -6771,14 +6771,14 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; get(property:"lang"): string; watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "observer": string; set(property:"observer", value: string): void; @@ -6787,25 +6787,25 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; get(property:"searchContainerNode"): boolean; watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * A parameter needed by RadioGroupSlide only. An optional paramter to force + * A parameter needed by RadioGroupSlide only. An optional parameter to force * the ContentPane to slide in from a set direction. Defaults * to "random", or specify one of "top", "left", "right", "bottom" * to slideFrom top, left, right, or bottom. - * + * */ "slideFrom": string; set(property:"slideFrom", value: string): void; @@ -6813,7 +6813,7 @@ declare module dijit { watch(property:"slideFrom", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -6821,7 +6821,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -6829,7 +6829,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -6838,14 +6838,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -6853,14 +6853,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -6869,7 +6869,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -6877,14 +6877,14 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The currently selected Date, initially set to invalid date to indicate no selection. - * + * */ "value": Date; set(property:"value", value: Date): void; get(property:"value"): Date; watch(property:"value", callback:{(property?:string, oldValue?:Date, newValue?: Date):void}) :{unwatch():void} /** - * + * */ "weekTemplateString": string; set(property:"weekTemplateString", value: string): void; @@ -6892,178 +6892,178 @@ declare module dijit { watch(property:"weekTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -7071,41 +7071,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus the calendar by focusing one of the calendar cells - * + * */ focus(): void; /** @@ -7113,15 +7113,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -7129,38 +7129,38 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * May be overridden to return CSS classes to associate with the date entry for the given dateObject, * for example to indicate a holiday in specified locale. - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ getClassForDate(dateObject: Date, locale: String): String; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Sets calendar's value to today's date - * + * */ goToToday(): void; /** @@ -7168,26 +7168,26 @@ declare module dijit { * Called from _onKeyDown() to handle keydown on a stand alone Calendar, * and also from dijit/form/_DateTimeTextBox to pass a keydown event * from the dijit/form/DateTextBox to be handled in this widget - * - * @param evt + * + * @param evt */ handleKey(evt: Event): any; /** * May be overridden to disable certain dates in the calendar e.g. isDisabledDate=dojo.date.locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -7195,9 +7195,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -7205,15 +7205,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -7222,9 +7222,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -7233,9 +7233,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -7244,9 +7244,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -7255,9 +7255,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -7266,9 +7266,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -7277,13 +7277,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -7291,68 +7291,68 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('value', ...) instead. - * - * @param value + * + * @param value */ setValue(value: Date): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -7360,29 +7360,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -7395,127 +7395,127 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** - * - * @param value + * + * @param value */ onChange(value: any): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Deprecated. Notification that a date cell was selected. It may be the same as the previous value. * Formerly used by dijit/form/_DateTimeTextBox (and thus dijit/form/DateTextBox) * to get notification when the user has clicked a date. Now onExecute() (above) is used. - * - * @param date + * + * @param date */ onValueSelected(date: Date): void; } @@ -7524,16 +7524,16 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/Calendar._MonthDropDown.html * * The list-of-months drop down from the MonthDropDownButton - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthDropDown extends dijit._Widget implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -7542,44 +7542,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -7588,14 +7588,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -7605,24 +7605,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -7632,7 +7632,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -7643,7 +7643,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -7652,7 +7652,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -7663,7 +7663,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -7674,7 +7674,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -7683,7 +7683,7 @@ declare module dijit { /** * List of names of months, possibly w/some undefined entries for Hebrew leap months * (ex: ["January", "February", undefined, "April", ...]) - * + * */ "months": Object; set(property:"months", value: Object): void; @@ -7692,14 +7692,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -7707,7 +7707,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -7715,7 +7715,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -7724,14 +7724,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -7739,14 +7739,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -7755,7 +7755,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -7763,180 +7763,180 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -7944,36 +7944,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -7981,15 +7981,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -7997,54 +7997,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -8053,9 +8053,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -8064,9 +8064,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -8075,9 +8075,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -8086,9 +8086,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -8097,9 +8097,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -8108,13 +8108,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -8122,62 +8122,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -8185,29 +8185,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -8220,120 +8220,120 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when month is selected from drop down - * - * @param month + * + * @param month */ onChange(month: number): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -8342,15 +8342,15 @@ declare module dijit { * * DropDownButton for the current month. Displays name of current month * and a list of month names in the drop down - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthDropDownButton extends dijit.form.DropDownButton { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -8358,14 +8358,14 @@ declare module dijit { watch(property:"active", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "alt": string; set(property:"alt", value: string): void; get(property:"alt"): string; watch(property:"alt", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "aria-label": string; set(property:"aria-label", value: string): void; @@ -8374,7 +8374,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -8383,44 +8383,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -8430,21 +8430,21 @@ declare module dijit { * Set to true to make the drop down at least as wide as this * widget. Set to false if the drop down should just be its * default width. - * + * */ "autoWidth": boolean; set(property:"autoWidth", value: boolean): void; get(property:"autoWidth"): boolean; watch(property:"autoWidth", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -8454,24 +8454,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -8480,18 +8480,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -8501,7 +8501,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -8510,7 +8510,7 @@ declare module dijit { /** * Should this widget respond to user input? * In markup, this is specified as "disabled='disabled'", or just "disabled". - * + * */ "disabled": boolean; set(property:"disabled", value: boolean): void; @@ -8521,7 +8521,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -8530,7 +8530,7 @@ declare module dijit { /** * The widget to display as a popup. This widget must be * defined before the startup function is called. - * + * */ "dropDown": Object; set(property:"dropDown", value: Object): void; @@ -8539,7 +8539,7 @@ declare module dijit { /** * This variable controls the position of the drop down. * It's an array of strings with the following values: - * + * * before: places drop down to the left of the target node/widget, or to the right in * the case of RTL scripts like Hebrew and Arabic * after: places drop down to the right of the target node/widget, or to the left in @@ -8548,7 +8548,7 @@ declare module dijit { * below: drop down goes below target node * The list is positions is tried, in order, until a position is found where the drop down fits * within the viewport. - * + * */ "dropDownPosition": Object; set(property:"dropDownPosition", value: Object): void; @@ -8557,7 +8557,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -8566,7 +8566,7 @@ declare module dijit { /** * Set to true to make the drop down exactly as wide as this * widget. Overrides autoWidth. - * + * */ "forceWidth": boolean; set(property:"forceWidth", value: boolean): void; @@ -8574,7 +8574,7 @@ declare module dijit { watch(property:"forceWidth", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -8582,7 +8582,7 @@ declare module dijit { watch(property:"hovering", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Class to apply to DOMNode in button to make it display an icon - * + * */ "iconClass": string; set(property:"iconClass", value: string): void; @@ -8593,7 +8593,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -8601,7 +8601,7 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Fires onChange for each value change or only on demand - * + * */ "intermediateChanges": boolean; set(property:"intermediateChanges", value: boolean): void; @@ -8609,7 +8609,7 @@ declare module dijit { watch(property:"intermediateChanges", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Content to display in button. - * + * */ "label": string; set(property:"label", value: string): void; @@ -8620,7 +8620,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -8630,7 +8630,7 @@ declare module dijit { * The max height for our dropdown. * Any dropdown taller than this will have scrollbars. * Set to 0 for no max height, or -1 to limit height to available space in viewport - * + * */ "maxHeight": number; set(property:"maxHeight", value: number): void; @@ -8638,7 +8638,7 @@ declare module dijit { watch(property:"maxHeight", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Name used when submitting form; same as "name" attribute or plain HTML elements - * + * */ "name": string; set(property:"name", value: string): void; @@ -8647,7 +8647,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -8655,14 +8655,14 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * On focus, should this widget scroll into view? - * + * */ "scrollOnFocus": boolean; set(property:"scrollOnFocus", value: boolean): void; get(property:"scrollOnFocus"): boolean; watch(property:"scrollOnFocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -8673,10 +8673,10 @@ declare module dijit { * (If showLabel=false then iconClass must be specified.) * Especially useful for toolbars. * If showLabel=true, the label will become the title (a.k.a. tooltip/hint) of the icon. - * + * * The exception case is for computers in high-contrast mode, where the label * will still be displayed, since the icon doesn't appear. - * + * */ "showLabel": boolean; set(property:"showLabel", value: boolean): void; @@ -8684,7 +8684,7 @@ declare module dijit { watch(property:"showLabel", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -8692,7 +8692,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -8700,7 +8700,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -8709,14 +8709,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -8724,14 +8724,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -8740,7 +8740,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -8748,7 +8748,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "type": string; set(property:"type", value: string): void; @@ -8756,7 +8756,7 @@ declare module dijit { watch(property:"type", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "value": string; set(property:"value", value: string): void; @@ -8766,200 +8766,200 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Closes the drop down on this widget - * - * @param focus If true, refocuses the button widget + * + * @param focus If true, refocuses the button widget */ closeDropDown(focus: boolean): void; /** * Compare 2 values (as returned by get('value') for this widget). - * - * @param val1 - * @param val2 + * + * @param val1 + * @param val2 */ compare(val1: any, val2: any): number; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -8967,41 +8967,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Put focus on this widget - * + * */ focus(): void; /** @@ -9009,15 +9009,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -9025,54 +9025,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Deprecated. Use get('value') instead. - * + * */ getValue(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * + * */ isLoaded(): boolean; /** @@ -9080,36 +9080,36 @@ declare module dijit { * if there's an href and it hasn't been loaded yet, and * then opens the drop down. This is basically a callback when the * user presses the down arrow button to open the drop down. - * + * */ loadAndOpenDropDown(): any; /** - * - * @param callback + * + * @param callback */ loadDropDown(callback: Function): void; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Opens the dropdown for this widget. To be called only when this.dropDown * has been created and is ready to display (ie, it's data is loaded). - * + * */ openDropDown(): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -9118,9 +9118,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -9129,9 +9129,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -9140,9 +9140,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -9151,9 +9151,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -9162,9 +9162,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -9173,105 +9173,105 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('disabled', ...) instead. - * - * @param disabled + * + * @param disabled */ setDisabled(disabled: boolean): void; /** * Deprecated. Use set('label', ...) instead. - * - * @param content + * + * @param content */ setLabel(content: String): void; /** * Deprecated. Use set('value', ...) instead. - * - * @param value + * + * @param value */ setValue(value: String): void; /** - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** * Callback when the user presses the down arrow button or presses * the down arrow key to open/close the drop down. * Toggle the drop-down widget; if it is up, close it, if not, open it - * + * */ toggleDropDown(): void; /** @@ -9279,29 +9279,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -9314,124 +9314,124 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when this widget's value is changed. - * - * @param newValue + * + * @param newValue */ onChange(newValue: any): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): boolean; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** - * + * */ onMonthSelect(): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -9441,19 +9441,19 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/CheckedMenuItem.html * * A checkbox-like menu item for toggling on and off - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class CheckedMenuItem extends dijit.MenuItem { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Text for the accelerator (shortcut) key combination, a control, alt, etc. modified keystroke meant to * execute the menu item regardless of where the focus is on the page. - * + * * Note that although Menu can display accelerator keys, there is no infrastructure to actually catch and * execute those accelerators. - * + * */ "accelKey": string; set(property:"accelKey", value: string): void; @@ -9461,7 +9461,7 @@ declare module dijit { watch(property:"accelKey", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -9470,7 +9470,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -9479,51 +9479,51 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -9531,7 +9531,7 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Our checked state - * + * */ "checked": boolean; set(property:"checked", value: boolean): void; @@ -9539,14 +9539,14 @@ declare module dijit { watch(property:"checked", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Character (or string) used in place of checkbox icon when display in high contrast mode - * + * */ "checkedChar": string; set(property:"checkedChar", value: string): void; get(property:"checkedChar"): string; watch(property:"checkedChar", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -9556,24 +9556,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -9582,18 +9582,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -9603,7 +9603,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -9612,7 +9612,7 @@ declare module dijit { /** * If true, the menu item is disabled. * If false, the menu item is enabled. - * + * */ "disabled": boolean; set(property:"disabled", value: boolean): void; @@ -9623,7 +9623,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -9632,7 +9632,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -9640,14 +9640,14 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; get(property:"hovering"): boolean; watch(property:"hovering", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "iconClass": string; set(property:"iconClass", value: string): void; @@ -9658,7 +9658,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -9666,7 +9666,7 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Menu text as HTML - * + * */ "label": string; set(property:"label", value: string): void; @@ -9677,7 +9677,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -9686,21 +9686,21 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "role": string; set(property:"role", value: string): void; get(property:"role"): string; watch(property:"role", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -9711,7 +9711,7 @@ declare module dijit { * also known as a mnemonic. * This is denoted in the label by surrounding the single character with {}. * For example, if label="{F}ile", then shortcutKey="F". - * + * */ "shortcutKey": string; set(property:"shortcutKey", value: string): void; @@ -9719,7 +9719,7 @@ declare module dijit { watch(property:"shortcutKey", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -9727,7 +9727,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -9736,14 +9736,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -9751,14 +9751,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -9767,7 +9767,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -9775,178 +9775,178 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -9954,41 +9954,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus on this MenuItem - * + * */ focus(): void; /** @@ -9996,15 +9996,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -10012,73 +10012,73 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the index of this widget within its container parent. * It returns -1 if the parent does not exist, or if the parent * is not a dijit/_Container - * + * */ getIndexInParent(): any; /** * Returns null if this is the last child of the parent, * otherwise returns the next element sibling to the "right". - * + * */ getNextSibling(): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns null if this is the first child of the parent, * otherwise returns the next element sibling to the "left". - * + * */ getPreviousSibling(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -10087,9 +10087,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -10098,9 +10098,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -10109,9 +10109,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -10120,9 +10120,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -10131,9 +10131,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -10142,13 +10142,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -10156,74 +10156,74 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('disabled', bool) instead. - * - * @param disabled + * + * @param disabled */ setDisabled(disabled: boolean): void; /** * Deprecated. Use set('label', ...) instead. - * - * @param content + * + * @param content */ setLabel(content: String): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -10231,29 +10231,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -10266,119 +10266,119 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * User defined function to handle check/uncheck events - * - * @param checked + * + * @param checked */ onChange(checked: boolean): void; /** * User defined function to handle clicks - * + * */ onClick(): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -10386,26 +10386,26 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/DialogUnderlay.html * * A component used to block input behind a dijit/Dialog. - * + * * Normally this class should not be instantiated directly, but rather shown and hidden via * DialogUnderlay.show() and DialogUnderlay.hide(). And usually the module is not accessed directly * at all, since the underlay is shown and hidden by Dialog.DialogLevelManager. - * + * * The underlay itself can be styled based on and id: - * + * * #myDialog_underlay { background-color:red; } * In the case of dijit.Dialog, this id is based on the id of the Dialog, * suffixed with _underlay. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class DialogUnderlay extends dijit._Widget implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -10414,44 +10414,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -10460,14 +10460,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -10477,24 +10477,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -10502,7 +10502,7 @@ declare module dijit { watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * Id of the dialog.... DialogUnderlay's id is based on this id - * + * */ "dialogId": string; set(property:"dialogId", value: string): void; @@ -10512,7 +10512,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -10523,7 +10523,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -10532,7 +10532,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -10543,7 +10543,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -10554,7 +10554,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -10563,14 +10563,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -10578,7 +10578,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -10586,7 +10586,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -10595,14 +10595,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -10610,14 +10610,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -10626,7 +10626,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -10634,170 +10634,170 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -10805,36 +10805,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -10842,15 +10842,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -10858,59 +10858,59 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Hide the underlay. - * + * */ hide(): void; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -10919,9 +10919,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -10930,9 +10930,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -10941,9 +10941,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -10952,9 +10952,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -10963,9 +10963,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -10974,13 +10974,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -10988,75 +10988,75 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Show the dialog underlay - * + * */ show(): void; /** * Display the underlay with the given attributes set. If the underlay is already displayed, * then adjust it's attributes as specified. - * - * @param attrs The parameters to create DialogUnderlay with. - * @param zIndex zIndex of the underlay + * + * @param attrs The parameters to create DialogUnderlay with. + * @param zIndex zIndex of the underlay */ show(attrs: Object, zIndex: number): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -11064,29 +11064,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -11099,114 +11099,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -11214,38 +11214,38 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.10/dijit/_ConfirmDialogMixin.html * * Mixin for Dialog/TooltipDialog with OK/Cancel buttons. - * + * */ class _ConfirmDialogMixin extends dijit._WidgetsInTemplateMixin { constructor(); /** - * + * */ "actionBarTemplate": Object; /** * Label of cancel button - * + * */ "buttonCancel": string; /** * Label of OK button - * + * */ "buttonOk": string; /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; /** - * + * */ startup(): void; } @@ -11253,9 +11253,9 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.10/dijit/ConfirmDialog.html * * A Dialog with OK/Cancel buttons. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class ConfirmDialog extends dijit.Dialog implements dijit._ConfirmDialogMixin { constructor(params: Object, srcNodeRef?: HTMLElement); @@ -11265,7 +11265,7 @@ declare module dijit { /** * HTML snippet to show the action bar (gray bar with OK/cancel buttons). * Blank by default, but used by ConfirmDialog/ConfirmTooltipDialog subclasses. - * + * */ "actionBarTemplate": string; set(property:"actionBarTemplate", value: string): void; @@ -11273,7 +11273,7 @@ declare module dijit { watch(property:"actionBarTemplate", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -11282,7 +11282,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -11291,44 +11291,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -11338,14 +11338,14 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; set(property:"autofocus", value: boolean): void; get(property:"autofocus"): boolean; watch(property:"autofocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -11353,7 +11353,7 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Label of cancel button - * + * */ "buttonCancel": string; set(property:"buttonCancel", value: string): void; @@ -11361,14 +11361,14 @@ declare module dijit { watch(property:"buttonCancel", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Label of OK button - * + * */ "buttonOk": string; set(property:"buttonOk", value: string): void; get(property:"buttonOk"): string; watch(property:"buttonOk", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -11376,7 +11376,7 @@ declare module dijit { watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; set(property:"closable", value: boolean): void; @@ -11386,24 +11386,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -11413,7 +11413,7 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; @@ -11422,14 +11422,14 @@ declare module dijit { /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; set(property:"contextRequire", value: Function): void; get(property:"contextRequire"): Function; watch(property:"contextRequire", callback:{(property?:string, oldValue?:Function, newValue?: Function):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -11439,17 +11439,17 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; get(property:"dir"): string; watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * * false - don't adjust size of children * true - if there is a single visible child widget, set it's size to however big the ContentPane is - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -11460,7 +11460,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -11470,7 +11470,7 @@ declare module dijit { * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; set(property:"draggable", value: boolean): void; @@ -11478,7 +11478,7 @@ declare module dijit { watch(property:"draggable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -11486,7 +11486,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -11495,7 +11495,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -11504,7 +11504,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -11512,7 +11512,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -11523,7 +11523,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -11534,7 +11534,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -11542,9 +11542,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -11553,7 +11553,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -11563,10 +11563,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -11577,7 +11577,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -11585,7 +11585,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -11593,7 +11593,7 @@ declare module dijit { watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; set(property:"maxRatio", value: number): void; @@ -11604,10 +11604,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -11615,7 +11615,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -11624,7 +11624,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -11632,7 +11632,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -11643,7 +11643,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -11651,7 +11651,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -11659,7 +11659,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -11669,7 +11669,7 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; set(property:"refocus", value: boolean): void; @@ -11677,14 +11677,14 @@ declare module dijit { watch(property:"refocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -11692,7 +11692,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -11702,14 +11702,14 @@ declare module dijit { * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; set(property:"state", value: string): void; get(property:"state"): string; watch(property:"state", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -11717,7 +11717,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -11726,14 +11726,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -11741,14 +11741,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -11757,7 +11757,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -11766,7 +11766,7 @@ declare module dijit { /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; set(property:"widgetsInTemplate", value: boolean): void; @@ -11776,232 +11776,232 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -12010,14 +12010,14 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** @@ -12025,15 +12025,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -12041,93 +12041,93 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** - * + * */ getValues(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Hide the dialog - * + * */ hide(): any; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -12136,9 +12136,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -12147,9 +12147,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -12158,9 +12158,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position: String): any; /** @@ -12169,9 +12169,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -12180,9 +12180,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -12191,17 +12191,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -12209,124 +12209,124 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ reset(): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -12334,38 +12334,38 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -12378,7 +12378,7 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** @@ -12386,58 +12386,58 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -12445,7 +12445,7 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** @@ -12453,113 +12453,113 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -12571,15 +12571,15 @@ declare module dijit { * Pops up a modal dialog window, blocking access to the screen * and also graying out the screen Dialog is extended from * ContentPane so it supports all the same parameters (href, etc.). - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Dialog extends dijit.layout.ContentPane implements dijit._TemplatedMixin, dijit.form._FormMixin, dijit._DialogMixin, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -12588,7 +12588,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -12597,44 +12597,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -12644,21 +12644,21 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; set(property:"autofocus", value: boolean): void; get(property:"autofocus"): boolean; watch(property:"autofocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -12666,7 +12666,7 @@ declare module dijit { watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; set(property:"closable", value: boolean): void; @@ -12676,24 +12676,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -12703,14 +12703,14 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; get(property:"content"): string; watch(property:"content", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -12720,17 +12720,17 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; get(property:"dir"): string; watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * * false - don't adjust size of children * true - if there is a single visible child widget, set it's size to however big the ContentPane is - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -12741,7 +12741,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -12751,7 +12751,7 @@ declare module dijit { * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; set(property:"draggable", value: boolean): void; @@ -12759,7 +12759,7 @@ declare module dijit { watch(property:"draggable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -12767,7 +12767,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -12776,7 +12776,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -12785,7 +12785,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -12793,7 +12793,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -12804,7 +12804,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -12815,7 +12815,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -12823,9 +12823,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -12834,7 +12834,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -12844,10 +12844,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -12858,7 +12858,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -12866,7 +12866,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -12874,7 +12874,7 @@ declare module dijit { watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; set(property:"maxRatio", value: number): void; @@ -12885,10 +12885,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -12896,7 +12896,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -12905,7 +12905,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -12913,7 +12913,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -12924,7 +12924,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -12932,7 +12932,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -12940,7 +12940,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -12950,7 +12950,7 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; set(property:"refocus", value: boolean): void; @@ -12958,14 +12958,14 @@ declare module dijit { watch(property:"refocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -12973,7 +12973,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -12983,14 +12983,14 @@ declare module dijit { * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; set(property:"state", value: string): void; get(property:"state"): string; watch(property:"state", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -12998,7 +12998,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -13007,14 +13007,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -13022,14 +13022,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -13038,7 +13038,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -13048,232 +13048,232 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom?: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -13282,14 +13282,14 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** @@ -13297,15 +13297,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -13313,93 +13313,93 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** - * + * */ getValues(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Hide the dialog - * + * */ hide(): any; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -13408,9 +13408,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -13419,9 +13419,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -13430,9 +13430,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -13441,9 +13441,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -13452,9 +13452,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -13463,17 +13463,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -13481,124 +13481,124 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ reset(): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -13606,38 +13606,38 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -13650,7 +13650,7 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** @@ -13658,58 +13658,58 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -13717,7 +13717,7 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** @@ -13725,113 +13725,113 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -13839,41 +13839,41 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/Dialog._DialogBase.html * - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _DialogBase extends dijit._TemplatedMixin implements dijit.form._FormMixin, dijit._DialogMixin, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; /** - * + * */ "baseClass": string; /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; /** - * + * */ "cssStateNodes": Object; /** @@ -13881,88 +13881,88 @@ declare module dijit { * This ContentPane parameter doesn't make sense for Dialog, since Dialog * is never a child of a layout container, nor can you specify the size of * Dialog in order to control the size of an inner widget. - * + * */ "doLayout": boolean; /** * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; /** * True if cursor is over this widget - * + * */ "hovering": boolean; /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; /** * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; /** - * + * */ "searchContainerNode": boolean; /** * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** - * + * */ "templateString": string; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * + * */ destroy(): void; /** - * + * */ destroyRendering(): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** @@ -13971,64 +13971,64 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** - * + * */ getValues(): any; /** * Hide the dialog - * + * */ hide(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** - * + * */ reset(): void; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** - * + * */ startup(): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** @@ -14041,7 +14041,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** @@ -14049,24 +14049,24 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when data has been loaded from an href. * Unlike most other callbacks, this function can be connected to (via dojo.connect) * but should not be overridden. - * + * */ onLoad(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -14076,38 +14076,38 @@ declare module dijit { * Controls the various active "levels" on the page, starting with the * stuff initially visible on the page (at z-index 0), and then having an entry for * each Dialog shown. - * + * */ interface _DialogLevelManager { /** * Called when the specified dialog is hidden/destroyed, after the fade-out * animation ends, in order to reset page focus, fix the underlay, etc. * If the specified dialog isn't open then does nothing. - * + * * Caller is responsible for either setting display:none on the dialog domNode, * or calling dijit/popup.hide(), or removing it from the page DOM. - * - * @param dialog + * + * @param dialog */ hide(dialog: dijit._WidgetBase): void; /** * Returns true if specified Dialog is the top in the task - * - * @param dialog + * + * @param dialog */ isTop(dialog: dijit._WidgetBase): boolean; /** * Call right before fade-in animation for new dialog. * Saves current focus, displays/adjusts underlay for new dialog, * and sets the z-index of the dialog itself. - * + * * New dialog will be displayed on top of all currently displayed dialogs. - * + * * Caller is responsible for setting focus in new dialog after the fade-in * animation completes. - * - * @param dialog - * @param underlayAttrs + * + * @param dialog + * @param underlayAttrs */ show(dialog: dijit._WidgetBase, underlayAttrs: Object): void; } @@ -14119,15 +14119,15 @@ declare module dijit { * A keyboard accessible color-picking widget * Grid showing various colors, so the user can pick a certain color. * Can be used standalone, or as a popup. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class ColorPalette extends dijit._Widget implements dijit._TemplatedMixin, dijit._PaletteMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -14136,7 +14136,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -14145,51 +14145,51 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -14197,14 +14197,14 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * CSS class applied to each cell in the palette - * + * */ "cellClass": string; set(property:"cellClass", value: string): void; get(property:"cellClass"): string; watch(property:"cellClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -14214,24 +14214,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -14240,18 +14240,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -14259,7 +14259,7 @@ declare module dijit { watch(property:"cssStateNodes", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Number of milliseconds before a held key or button becomes typematic - * + * */ "defaultTimeout": number; set(property:"defaultTimeout", value: number): void; @@ -14269,7 +14269,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -14280,7 +14280,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -14289,7 +14289,7 @@ declare module dijit { /** * Constructor for Object created for each cell of the palette. * dyeClass should implement the dijit/_PaletteMixin.__Dye interface. - * + * */ "dyeClass": Function; set(property:"dyeClass", value: Function): void; @@ -14298,7 +14298,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -14306,7 +14306,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -14317,7 +14317,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -14328,7 +14328,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -14337,7 +14337,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -14345,14 +14345,14 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Size of grid, either "7x10" or "3x4". - * + * */ "palette": string; set(property:"palette", value: string): void; get(property:"palette"): string; watch(property:"palette", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -14360,7 +14360,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -14368,7 +14368,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -14376,7 +14376,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Widget tab index. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -14385,7 +14385,7 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; @@ -14393,7 +14393,7 @@ declare module dijit { watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The template of this widget. - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -14403,7 +14403,7 @@ declare module dijit { * Fraction of time used to change the typematic timer between events * 1.0 means that each typematic event fires at defaultTimeout intervals * Less than 1.0 means that each typematic event fires at an increasing faster rate - * + * */ "timeoutChangeRate": number; set(property:"timeoutChangeRate", value: number): void; @@ -14411,14 +14411,14 @@ declare module dijit { watch(property:"timeoutChangeRate", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -14427,7 +14427,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -14435,7 +14435,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Currently selected color/emoticon/etc. - * + * */ "value": string; set(property:"value", value: string): void; @@ -14443,178 +14443,178 @@ declare module dijit { watch(property:"value", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -14622,41 +14622,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus this widget. Puts focus on the most recently focused cell. - * + * */ focus(): void; /** @@ -14664,15 +14664,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -14680,54 +14680,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -14736,9 +14736,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -14747,9 +14747,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -14758,9 +14758,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -14769,9 +14769,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -14780,9 +14780,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -14791,13 +14791,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -14805,62 +14805,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -14868,29 +14868,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -14903,120 +14903,120 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when a cell is selected. - * - * @param value Value corresponding to cell. + * + * @param value Value corresponding to cell. */ onChange(value: String): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -15026,104 +15026,104 @@ declare module dijit { * * Object associated with each cell in a ColorPalette palette. * Implements dijit/Dye. - * - * @param alias English name of the color. - * @param row Vertical position in grid. - * @param col - * @param title Localized name of the color. + * + * @param alias English name of the color. + * @param row Vertical position in grid. + * @param col + * @param title Localized name of the color. */ class _Color extends dojo._base.Color { constructor(alias: String, row: number, col: any, title: String); /** - * + * */ "a": number; /** - * + * */ "b": number; /** - * + * */ "g": number; /** - * + * */ "hcTemplate": string; /** - * + * */ "r": number; /** - * + * */ "template": string; /** - * - * @param cell - * @param blankGif + * + * @param cell + * @param blankGif */ fillCell(cell: HTMLElement, blankGif: String): void; /** * Note that although dijit._Color is initialized with a value like "white" getValue() always * returns a hex value - * + * */ getValue(): any; /** * makes sure that the object has correct attributes - * + * */ sanitize(): void; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: any[]): Function; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: String): Function; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: Object): Function; /** * Returns a css color string in rgb(a) representation - * - * @param includeAlpha Optional + * + * @param includeAlpha Optional */ toCss(includeAlpha: boolean): String; /** * Returns a CSS color string in hexadecimal representation - * + * */ toHex(): String; /** * Returns 3 component array of rgb values - * + * */ toRgb(): any[]; /** * Returns a 4 component array of rgba values from the color * represented by this object. - * + * */ toRgba(): any[]; /** * Returns a visual representation of the color - * + * */ toString(): any; } @@ -15134,15 +15134,15 @@ declare module dijit { * * An accessible fieldset that can be expanded or collapsed via * its legend. Fieldset extends dijit.TitlePane. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Fieldset extends dijit.TitlePane { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -15151,7 +15151,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -15160,44 +15160,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -15205,14 +15205,14 @@ declare module dijit { watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * The root className to use for the various states of this widget - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -15222,24 +15222,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -15249,7 +15249,7 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; @@ -15258,18 +15258,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -15279,7 +15279,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -15290,7 +15290,7 @@ declare module dijit { * This ContentPane parameter doesn't make sense for TitlePane, since TitlePane * is never a child of a layout container, nor should TitlePane try to control * the size of an inner widget. - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -15301,7 +15301,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -15309,7 +15309,7 @@ declare module dijit { watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * Time in milliseconds to fade in/fade out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -15317,7 +15317,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -15326,7 +15326,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -15335,7 +15335,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -15343,7 +15343,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -15354,7 +15354,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -15365,7 +15365,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -15373,9 +15373,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -15384,7 +15384,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -15394,10 +15394,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -15408,7 +15408,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -15416,7 +15416,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -15427,10 +15427,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -15438,7 +15438,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Whether fieldset is opened or closed. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -15447,7 +15447,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -15455,7 +15455,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -15466,7 +15466,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -15474,7 +15474,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -15482,7 +15482,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -15490,14 +15490,14 @@ declare module dijit { watch(property:"preventCache", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -15505,14 +15505,14 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; get(property:"srcNodeRef"): HTMLElement; watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -15520,7 +15520,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -15529,7 +15529,7 @@ declare module dijit { /** * Tabindex setting for the title (so users can tab to the title then * use space/enter to open/close the title pane) - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -15538,14 +15538,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -15553,7 +15553,7 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Content of the legend tag. Overrides tag if not empty. - * + * */ "title": string; set(property:"title", value: string): void; @@ -15561,7 +15561,7 @@ declare module dijit { watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Whether pane can be opened or closed by clicking the title bar. - * + * */ "toggleable": boolean; set(property:"toggleable", value: boolean): void; @@ -15570,7 +15570,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -15580,219 +15580,219 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom?: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -15800,15 +15800,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -15816,78 +15816,78 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -15896,9 +15896,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -15907,9 +15907,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -15918,9 +15918,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -15929,9 +15929,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -15940,9 +15940,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -15951,17 +15951,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -15969,116 +15969,116 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** * Deprecated. Use set('title', ...) instead. - * - * @param title + * + * @param title */ setTitle(title: String): void; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -16086,29 +16086,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -16121,58 +16121,58 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -16180,103 +16180,103 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; } @@ -16284,9 +16284,9 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/DropDownMenu.html * * A menu, without features for context menu (Meaning, drop down menu) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class DropDownMenu extends dijit._MenuBase implements dijit._OnDijitClickMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); @@ -16296,7 +16296,7 @@ declare module dijit { * since TAB is a navigation operation and not a selection one. * For Windows apps, pressing the ALT key focuses the menubar menus (similar to TAB navigation) but the * menu is not active (ie no dropdown) until an item is clicked. - * + * */ "activated": boolean; set(property:"activated", value: boolean): void; @@ -16304,7 +16304,7 @@ declare module dijit { watch(property:"activated", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -16313,7 +16313,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -16322,44 +16322,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -16368,21 +16368,21 @@ declare module dijit { /** * A toggle to control whether or not a Menu gets focused when opened as a drop down from a MenuBar * or DropDownButton/ComboButton. Note though that it always get focused when opened via the keyboard. - * + * */ "autoFocus": boolean; set(property:"autoFocus", value: boolean): void; get(property:"autoFocus"): boolean; watch(property:"autoFocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -16392,24 +16392,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -16418,18 +16418,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -16439,7 +16439,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -16450,7 +16450,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -16459,7 +16459,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -16467,7 +16467,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; set(property:"focusedChild", value: Object): void; @@ -16475,7 +16475,7 @@ declare module dijit { watch(property:"focusedChild", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -16486,7 +16486,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -16497,7 +16497,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -16507,10 +16507,10 @@ declare module dijit { * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; set(property:"multiCharSearchDuration", value: number): void; @@ -16519,7 +16519,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -16527,7 +16527,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to menu that displayed me - * + * */ "parentMenu": Object; set(property:"parentMenu", value: Object): void; @@ -16536,7 +16536,7 @@ declare module dijit { /** * For a passive (unclicked) Menu, number of milliseconds before hovering (without clicking) will cause * the popup to open. Default is Infinity, meaning you need to click the menu to open it. - * + * */ "passivePopupDelay": number; set(property:"passivePopupDelay", value: number): void; @@ -16545,14 +16545,14 @@ declare module dijit { /** * After a menu has been activated (by clicking on it etc.), number of milliseconds before hovering * (without clicking) another MenuItem causes that MenuItem's popup to automatically open. - * + * */ "popupDelay": number; set(property:"popupDelay", value: number): void; get(property:"popupDelay"): number; watch(property:"popupDelay", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -16563,7 +16563,7 @@ declare module dijit { * If a submenu is open, will be set to MenuItem that displayed the submenu. OTOH, if * this Menu is in passive mode (i.e. hasn't been clicked yet), will be null, because * "selected" is not merely "hovered". - * + * */ "selected": Object; set(property:"selected", value: Object): void; @@ -16571,7 +16571,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -16579,7 +16579,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -16589,7 +16589,7 @@ declare module dijit { * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -16598,14 +16598,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -16613,14 +16613,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -16629,210 +16629,210 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; get(property:"tooltip"): string; watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Selector (passed to on.selector()) used to identify MenuItem child widgets, but exclude inert children * like MenuSeparator. If subclass overrides to a string (ex: "> *"), the subclass must require dojo/query. - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -16840,69 +16840,69 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** @@ -16910,15 +16910,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -16926,65 +16926,65 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -16993,9 +16993,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -17004,9 +17004,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -17015,9 +17015,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -17026,9 +17026,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -17037,9 +17037,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -17048,13 +17048,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -17062,82 +17062,82 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -17145,29 +17145,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -17180,27 +17180,27 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Attach point for notification about when the user cancels the current menu * This is an internal mechanism used for Menus to signal to their parent to * close them. In general developers should not attach to or override this method. - * - * @param closeAll + * + * @param closeAll */ onCancel(closeAll: boolean): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** @@ -17208,114 +17208,114 @@ declare module dijit { * This is an internal mechanism used for Menus to signal to their parent to * close them, because they are about to execute the onClick handler. In * general developers should not attach to or override this method. - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Called when cursor is over a MenuItem. - * - * @param item + * + * @param item */ onItemHover(item: dijit.MenuItem): void; /** * Callback fires when mouse exits a MenuItem - * - * @param item + * + * @param item */ onItemUnhover(item: dijit.MenuItem): void; /** * Attach point for notification about when a menu item has been searched for * via the keyboard search mechanism. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit.MenuItem, evt: Event, searchString: String, numMatches: number): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -17330,15 +17330,15 @@ declare module dijit { * browsers, and clipboard operations may have different results, to name * a few limitations. Note: this widget should not be used with the HTML *