Merge pull request #11454 from dasa/arcgis-js-api

Update for ArcGIS API for JavaScript version 3.18
This commit is contained in:
Andy
2016-09-23 14:24:50 -07:00
committed by GitHub
+435 -45
View File
@@ -1,4 +1,4 @@
// Type definitions for ArcGIS API for JavaScript v3.17
// Type definitions for ArcGIS API for JavaScript v3.18
// Project: http://js.arcgis.com
// Definitions by: Esri <http://www.esri.com>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -44,6 +44,7 @@ declare module "esri" {
import QueryTask = require("esri/tasks/QueryTask");
import TextSymbol = require("esri/symbols/TextSymbol");
import StandardGeographyQueryTask = require("esri/tasks/geoenrichment/StandardGeographyQueryTask");
import WCSConnection = require("esri/layers/WCSConnection");
import WMSLayerInfo = require("esri/layers/WMSLayerInfo");
import WMTSLayerInfo = require("esri/layers/WMTSLayerInfo");
@@ -483,12 +484,14 @@ declare module "esri" {
featureLayers: FeatureLayer[];
/** Reference to the map object. */
map?: Map;
/** The point feature layer containing the origin points. */
originsLayer: FeatureLayer;
/** The point feature layers containing the origin points. */
originsLayers: FeatureLayer[];
/** The name of the output layer to be shown in the Result layer name input box. */
outputLayerName?: string;
/** The url to the ArcGIS.com site or in-house portal where the GP server is hosted. */
portalUrl?: string;
/** Indicates whether to display a drop down menu listing valid input analysis layers. */
showSelectAnalysisLayer?: boolean;
}
export interface CoordinatesLocationProviderOptions {
/** The attribute field in the graphic object that contains the longitude (X) values. */
@@ -563,12 +566,14 @@ declare module "esri" {
export interface CreateWatershedsOptions {
/** The URL to the GPServer used to execute an analysis job. */
analysisGpServer?: string;
/** The feature layer containing input points used for calculating watersheds. */
inputLayer: FeatureLayer;
/** The feature layers containing input points used for calculating watersheds. */
inputLayers: FeatureLayer[];
/** Reference to the map object. */
map?: Map;
/** The url to the ArcGIS.com site or in-house portal where the GP server is hosted. */
portalUrl?: string;
/** Indicates whether to display a drop down menu listing valid input analysis layers. */
showSelectAnalysisLayer?: boolean;
}
export interface CutOptions {
/** The feature(s) added to the feature layer by the cut operation. */
@@ -939,6 +944,10 @@ declare module "esri" {
outFields?: string[];
/** Displays or hides the attachment column. */
showAttachments?: boolean;
/** Displays or hides tooltips for column headers. */
showColumnHeaderTooltips?: boolean;
/** Shows or hides cyclical relationship. */
showCyclicalRelationships?: boolean;
/** Displays the data type of the field right under the field label. */
showDataTypes?: boolean;
/** Displays or hides total number of features and selected number of features in the grid header. */
@@ -947,6 +956,8 @@ declare module "esri" {
showGridHeader?: boolean;
/** Displays or hides 'Options' drop-down menu of the FeatureTable. */
showGridMenu?: boolean;
/** Displays or hides the option to show related records in a table if the layer has pre-established relationship. */
showRelatedRecords?: boolean;
/** Displays or hides the 'Statistics' option in column menus for numeric fields. */
showStatistics?: boolean;
/** Enables an interaction between the map and the feature table. */
@@ -1996,6 +2007,30 @@ declare module "esri" {
/** The URL to use for connecting to a socket. */
socketUrl?: string;
}
export interface StretchFilterOptions {
/** Indicates whether to perform dynamic range adjustment using the current pixel data. */
dra?: boolean;
/** An array of gamma values, for example [0.8, 0.8, 0.8]. */
gamma?: number[];
/** The maximum value of stretched pixels. */
max?: number;
/** Percent of pixels clipped on the right histogram tail, for example 0.25. */
maxPercent?: number;
/** The minimum value of stretched pixels. */
min?: number;
/** Percent of pixels clipped on the left histogram tail, for example 1.5. */
minPercent?: number;
/** The number of standard deviations for StandardDeviation stretch, for example 2.5. */
numberOfStandardDeviations?: number;
/** The output pixel type. */
outputPixelType?: string;
/** An array of arrays containing custom statistics objects. */
statistics?: any[][];
/** See the constants table for a list of possible stretchType values. */
stretchType?: number;
/** Indicates whether to perform non-linear gamma stretch. */
useGamma?: boolean;
}
export interface SummarizeNearbyOptions {
/** The URL to the GPServer used to execute an analysis job. */
analysisGpServer?: string;
@@ -2023,6 +2058,8 @@ declare module "esri" {
showCredits?: boolean;
/** When true, the help links will be shown. */
showHelp?: boolean;
/** Indicates whether to display a drop down menu listing valid input analysis layers. */
showSelectAnalysisLayer?: boolean;
/** When true, the select folder dropdown will be shown. */
showSelectFolder?: boolean;
/** An array of possible statistics attribute field names and summary types that you wish to calculate for all nearby features. */
@@ -2031,8 +2068,8 @@ declare module "esri" {
summaryLayer?: FeatureLayer;
/** An array of possible feature layers summarizing toward. */
summaryLayers: FeatureLayer[];
/** The point, line, or polygon feature layer from which distances will be measured to features in summarizeLayer. */
sumNearbyLayer: FeatureLayer;
/** The point, line, or polygon feature layers from which distances will be measured to features in summarizeLayer. */
sumNearbyLayers: FeatureLayer[];
/** If true. */
sumShape?: boolean;
/** Type of units shown as the defeault value in the Find nearest features using a option. */
@@ -2184,27 +2221,37 @@ declare module "esri" {
/** Region of preview scale thumbnails. */
region?: string;
}
export interface WCSConnectionOptions {
/** The coverage identifier, defaults to the first coverage. */
coverageId?: string;
/** The version of WCSLayer, can be: 1.0.01.1.01.1.11.1.22.0.1 */
version?: string;
}
export interface WCSLayerOptions {
/** The coverage identifier, defaults to the first coverage. */
coverageId?: string;
/** Sets the layer's draw mode. */
drawMode?: boolean;
/** Sets the context of the Canvas. */
drawType?: string;
/** A function that takes a pixelData object as input and processes it. */
pixelFilter?: Function;
/** The version of WCSLayer, can be: 1.0.01.1.01.1.11.1.22.0.1 */
version?: string;
/** A WCS Connection object. */
wcsConnection?: WCSConnection;
}
export interface WFSLayerOptions {
/** Full WFS body request sent to WFS server via POST method. */
getFeatureRequest?: string;
/** URL used when executing getFeature request. */
getFeatureUrl?: string;
/** Use this to append custom parameters to WFS requests. */
customParameters?: any;
/** The template that defines the content to display in the map info window when the user clicks on a feature. */
infoTemplate?: InfoTemplate;
/** For "ondemand" mode only. */
inverseFilter?: boolean;
/** When true, the XY coordinates should be swapped (this is required for some WFS vendors, versions, and WKIDS). */
inverseResponse?: boolean;
/** Specifies the maximum number of features to return in one response. */
maxFeatures?: number;
/** The query mode for the WFS layer. */
mode?: string;
/** For "ondemand" mode only. */
nsGeometryFieldName?: string;
/** The full layer name including the namespace as a prefix. */
nsLayerName?: string;
/** When true, more details will be printed to console when the first connection to a WFS server is established. */
showDetails?: boolean;
/** The simple layer name (excluding the namespace). */
name?: string;
/** URL to the WFS server. */
url: string;
/** OGC WFS version number. */
@@ -2235,6 +2282,10 @@ declare module "esri" {
title?: string;
}
export interface WMSLayerOptions {
/** The customLayerParameters object used for the WMS Layer. */
customLayerParameters?: any;
/** The customParameters object used for the WMS Layer. */
customParameters?: any;
/** Specify the map image format, valid options are png,jpg,bmp,gif,svg. */
format?: string;
/** An optional resourceInfo object. */
@@ -2267,6 +2318,10 @@ declare module "esri" {
title?: string;
}
export interface WMTSLayerOptions {
/** The customLayerParameters object used for the WMTS Layer. */
customLayerParameters?: any;
/** The customParameters object used for the WMTS Layer. */
customParameters?: any;
/** A WMTSLayerInfo object that when ResourceInfo options are not specified the map will display the first layer in the WMTS capabilities that matches the properties specified by WMTSLayerInfo. */
layerInfo?: WMTSLayerInfo;
/** When true, tile resampling is enabled. */
@@ -2783,7 +2838,7 @@ declare module "esri/TimeExtent" {
* Returns a new time extent indicating the intersection between "this" and the argument time extent.
* @param timeExtent The input time extent.
*/
intersection(timeExtent: number): TimeExtent;
intersection(timeExtent: TimeExtent): TimeExtent;
/**
* Returns a new time extent with the given offset from "this' time extent.
* @param offsetValue The length of time to offset from "this" time extent.
@@ -2946,7 +3001,7 @@ declare module "esri/arcgis/Portal" {
/** The prefix selected by the organization's administrator to be used with the customBaseURL. */
urlKey: string;
/** User information for the accessing user is returned only when a token is passed in. */
user: any;
user: PortalUser;
/** If true, only simple where clauses that are complaint with SQL92 can be used when querying layers and tables. */
useStandardizedQuery: boolean;
/**
@@ -3951,6 +4006,8 @@ declare module "esri/dijit/ElevationProfile" {
startup(): void;
/** Fires when the elevation profile is cleared. */
on(type: "clear-profile", listener: (event: { target: ElevationProfile }) => void): esri.Handle;
/** Fires after the profile is generated. */
on(type: "elevation-values", listener: (event: { data: any; target: ElevationProfile }) => void): esri.Handle;
/** Fires when the widget has fully loaded. */
on(type: "load", listener: (event: { target: ElevationProfile }) => void): esri.Handle;
/** Fires when the title of the elevation profile is changed */
@@ -3967,6 +4024,7 @@ declare module "esri/dijit/FeatureTable" {
import FeatureLayer = require("esri/layers/FeatureLayer");
import Map = require("esri/map");
import FeatureEditResult = require("esri/layers/FeatureEditResult");
import Graphic = require("esri/graphic");
/** Creates an instance of the FeatureTable widget within the provided DOM node. */
class FeatureTable {
@@ -4012,6 +4070,10 @@ declare module "esri/dijit/FeatureTable" {
selectedRows: any[];
/** Displays or hides the attachment column. */
showAttachments: boolean;
/** Displays or hides tooltips for column headers. */
showColumnHeaderTooltips: boolean;
/** Relies on showRelatedRecords property. */
showCyclicalRelationships: boolean;
/** Displays or hides the data type of the field right under the field label in the column header. */
showDataTypes: boolean;
/** Displays or hides total number of features and selected number of features in the grid header. */
@@ -4020,6 +4082,8 @@ declare module "esri/dijit/FeatureTable" {
showGridHeader: boolean;
/** Displays or hides 'Options' drop-down menu of the FeatureTable. */
showGridMenu: boolean;
/** Displays or hides the option to show related records in a table if the layer has pre-established relationship. */
showRelatedRecords: boolean;
/** Displays or hides the 'Statistics' option in column menus for numeric fields. */
showStatistics: boolean;
/** Enables an interaction between the map and the feature table. */
@@ -4032,35 +4096,55 @@ declare module "esri/dijit/FeatureTable" {
* @param srcNodeRef Reference or id of a HTML element that this dijit is rendered into.
*/
constructor(params: esri.FeatureTableOptions, srcNodeRef: Node | string);
/** Removes all current selections including subsets from filterSelectedRecords(). */
/** Centers the map on combined extent of selected rows. */
centerOnSelection(): void;
/** Removes all filters and selections in the table. */
clearFilter(): void;
/** Removes all selections. */
clearSelection(): void;
/** Destroys the FeatureTable widget. */
destroy(): void;
/**
* Allows users to see the sub-set of currently selected records (uses dGrid.query).
* @param toggle When true only a subset of currently selected features will be displayed in the FeatureTable.
* Filters the table based on the provided row ids.
* @param ids Array of row ids.
*/
filterSelectedRecords(toggle: boolean): void;
filterRecordsByIds(ids: number[]): void;
/** Allows users to see the sub-set of records. */
filterSelectedRecords(): void;
/**
* Queries and gets selected features from the FeatureLayer instead of the store.
* @param id Array of row ids
* @param id Row id or an array of row ids
*/
getFeatureDataById(id: number[]): any;
getFeatureDataById(id: number | number[]): any;
/**
* Gets row object by the row ID.
* @param id row ID
*/
getRowDataById(id: number): any;
/** Refreshes the data in the grid. */
/** Refreshes the data in the table. */
refresh(): void;
/** Resizes the grid's container. */
resize(): void;
/**
* Allows users to select rows(s) based on row id(s).
* @param ids Row id or an array of row ids
* @param scrollToRow Indicates whether the table should scroll to selected rows.
*/
selectRows(ids: number | number[], scrollToRow?: boolean): void;
/**
* Sorts a given field in ascending or descending order.
* @param field Name of the field
* @param descending Defines whether the specified field will be sorted in ascending or descending order.
*/
sort(field: string, descending?: boolean): void;
/** Finalizes the creation of the widget. */
startup(): void;
/** This event fires in response to clearSelection() method. */
on(type: "clear-selection", listener: (event: { target: FeatureTable }) => void): esri.Handle;
/** Fires when the grid column is resized. */
on(type: "column-resize", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "column-resize", listener: (event: { resizeEvent: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when a column is hidden or shown via 'Options' drop-down menu. */
on(type: "column-state-change", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "column-state-change", listener: (event: { stateChangeEvent: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when grid editor field loses focus after being changed. */
on(type: "data-change", listener: (event: { target: FeatureTable }) => void): esri.Handle;
/** Fires when grid editor is hidden. */
@@ -4072,19 +4156,23 @@ declare module "esri/dijit/FeatureTable" {
/** Fires when an error occurs in the grid. */
on(type: "error", listener: (event: { target: FeatureTable }) => void): esri.Handle;
/** Fires when grid is filtered. */
on(type: "filter", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "filter", listener: (event: { ids: number[]; target: FeatureTable }) => void): esri.Handle;
/** Fires when the FeatureTable is loaded. */
on(type: "load", listener: (event: { target: FeatureTable }) => void): esri.Handle;
/** Fires when the grid is refreshed. */
on(type: "refresh", listener: (event: { target: FeatureTable }) => void): esri.Handle;
/** Fires when a row is deselected. */
on(type: "row-deselect", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "row-deselect", listener: (event: { event: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when a row is selected. */
on(type: "row-select", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "row-select", listener: (event: { event: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when attachment is displayed in the table. */
on(type: "show-attachments", listener: (event: { attachments: any; dialog: any; featureId: number; target: FeatureTable }) => void): esri.Handle;
/** Fires when related records are displayed in the table. */
on(type: "show-related-records", listener: (event: { features: Graphic[]; relationship: any; row: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when the statistics dialog box shows the calculated statistics on a column with numeric data. */
on(type: "show-statistics", listener: (event: { statistics: any; target: FeatureTable }) => void): esri.Handle;
/** Fires when a column is sorted. */
on(type: "sort", listener: (event: { target: FeatureTable }) => void): esri.Handle;
on(type: "sort", listener: (event: { sortEvent: any; target: FeatureTable }) => void): esri.Handle;
on(type: string, listener: (event: any) => void): esri.Handle;
}
export = FeatureTable;
@@ -4168,7 +4256,7 @@ declare module "esri/dijit/Geocoder" {
import GraphicsLayer = require("esri/layers/GraphicsLayer");
import Symbol = require("esri/symbols/Symbol");
/** Starting with version 3.13, the Search Widget supersedes the Geocoder Widget and is deprecated. */
/** The Geocoder widget was deprecated in version 3.13 and replaced by the Search widget. */
class Geocoder {
/** Currently selected locator object. */
activeGeocoder: any;
@@ -9403,6 +9491,8 @@ declare module "esri/layers/FeatureLayer" {
labelingInfo: LabelClass[];
/** Unique ID of the layer that the FeatureLayer was constructed against. */
layerId: number;
/** The maximum allowable offset, only applicable for layers that are not editable. */
maxAllowableOffset: number;
/** The maximum number of results that will be returned from a query. */
maxRecordCount: number;
/** Maximum visible scale for the layer. */
@@ -10914,7 +11004,7 @@ declare module "esri/layers/VectorTileLayer" {
import SpatialReference = require("esri/SpatialReference");
import TileInfo = require("esri/layers/TileInfo");
/** A VectorTileLayer accesses cached tiles of data and renders it in vector format. */
/** A VectorTileLayer renders cached tiles of data. */
class VectorTileLayer extends Layer {
/** The full extent of the layer. */
fullExtent: Extent;
@@ -10946,6 +11036,224 @@ declare module "esri/layers/VectorTileLayer" {
export = VectorTileLayer;
}
declare module "esri/layers/WCSConnection" {
import esri = require("esri");
import WCSCoverageDescription = require("esri/layers/WCSCoverageDescription");
import DimensionalDefinition = require("esri/layers/DimensionalDefinition");
/** (Currently in beta), a helper class to discover available coverages in an OGC Web Coverage Service. */
class WCSConnection {
/** Resamples pixel by bilinear interpolation. */
static INTERPOLATION_BILINEAR: any;
/** Resamples pixel by cubic convolution. */
static INTERPOLATION_CUBICCONVOLUTION: any;
/** Resamples pixel by nearest neighbor. */
static INTERPOLATION_NEARESTNEIGHBOR: any;
/** An array of coverages offered by the WCS server. */
coverages: WCSCoverageDescription[];
/** Multiple dimensional definitions are usually used to filter data. */
multidimensionalDefinition: DimensionalDefinition[];
/** The name of the WCS server. */
name: string;
/** Key-value pairs for URLs of different WCS operations: GetCapabilitiesDescribeCoverage */
onlineResources: any;
/** An array of string values indicating WCS 2.0.1 profiles. */
profiles: string[];
/** An array of supported formats by the server. */
supportedFormats: string[];
/** The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space. */
supportedInterpolations: number[];
/** An array of supported WCS versions by the server. */
supportedVersions: string[];
/** URL to a WCS Server endpoint. */
url: string;
/** The version of WCSLayer, can be: 1.0.01.1.01.1.11.1.22.0.1 */
version: string;
/**
* Creates a new WCSConnection.
* @param url URL to a WCS Server endpoint.
* @param options Optional parameters.
*/
constructor(url: string, options?: esri.WCSConnectionOptions);
/** Triggered when successfully retrieved list of coverages. */
on(type: "onConnected", listener: (event: { target: WCSConnection }) => void): esri.Handle;
/** Triggered when an error occurred. */
on(type: "onConnectionFailed", listener: (event: { error: Error; target: WCSConnection }) => void): esri.Handle;
on(type: string, listener: (event: any) => void): esri.Handle;
}
export = WCSConnection;
}
declare module "esri/layers/WCSCoverageDescription" {
import Extent = require("esri/geometry/Extent");
import Point = require("esri/geometry/Point");
import TimeInfo = require("esri/layers/TimeInfo");
/** (Currently in beta), the WCSCoverageDescription models the coverage properties offered by the WCS Server. */
class WCSCoverageDescription {
/** Resamples pixel by bilinear interpolation. */
static INTERPOLATION_BILINEAR: any;
/** Resamples pixel by cubic convolution. */
static INTERPOLATION_CUBICCONVOLUTION: any;
/** Resamples pixel by nearest neighbor. */
static INTERPOLATION_NEARESTNEIGHBOR: any;
/** An array of band names. */
bandInfo: string[];
/** Number of columns at the source resolution. */
columns: number;
/** The coverage description text. */
description: string;
/** Coverage extent in the native spatial reference. */
extent: Extent;
/** The coverage id. */
id: string;
/** Coverage extent in WGS84. */
lonLatEnvelope: Extent;
/** A parsed multidimensional object that describes variables and dimensions. */
multiDimensionalInfo: any;
/** A parsed coverage description object in a structure similar to WCS Coverage Description schema. */
nativeCoverageDescription: any;
/** Coverage's source resolution. */
resolution: Point;
/** Number of rows at the source resolution. */
rows: number;
/** Generalized from the following properties:SupportedFormats for WCS 1.0.0 and 1.1.xserviceParameters.supportedFormats for WCS 2.0.1. */
supportedFormats: string[];
/** The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space. */
supportedInterpolations: number[];
/** Temporal information for the layer, such as time extent. */
timeInfo: TimeInfo;
/** The current version of the coverage. */
version: string;
/**
* Creates a new WCSCoverageDescription.
* @param coverageDocument The coverage description XML.
* @param version The version of the coverage description document.
*/
constructor(coverageDocument: string, version: string);
}
export = WCSCoverageDescription;
}
declare module "esri/layers/WCSLayer" {
import esri = require("esri");
import WCSCoverageDescription = require("esri/layers/WCSCoverageDescription");
import Extent = require("esri/geometry/Extent");
import DimensionalDefinition = require("esri/layers/DimensionalDefinition");
import TimeInfo = require("esri/layers/TimeInfo");
import WCSConnection = require("esri/layers/WCSConnection");
import Point = require("esri/geometry/Point");
import Layer = require("esri/layers/layer");
/** (Currently in beta) The WCSLayer works with OGC Web Coverage Services. */
class WCSLayer {
/** Resamples pixel by bilinear interpolation. */
static INTERPOLATION_BILINEAR: any;
/** Resamples pixel by cubic convolution. */
static INTERPOLATION_CUBICCONVOLUTION: any;
/** Resamples pixel by nearest neighbor. */
static INTERPOLATION_NEARESTNEIGHBOR: any;
/** Zero-based array of current band selections. */
bandIds: number[];
/** A reference to a WCSCoverageDescription object. */
coverageDescription: WCSCoverageDescription;
/** The coverage identifier, defaults to the first coverage. */
coverageId: string;
/** The extent of the full coverage. */
extent: Extent;
/** Raster format of the layer. */
format: string;
/** Current interpolation method. */
interpolation: number;
/** When the layer is loaded, the value becomes "true", and layer properties can be accessed. */
loaded: boolean;
/** Multiple dimensional definitions are usually used to filter data. */
multidimensionalDefinition: DimensionalDefinition[];
/** Opacity or transparency of layer. */
opacity: number;
/** A function that takes a pixelData object as input and processes it. */
pixelFilter: Function;
/** The pixel type of the image service. */
pixelType: string;
/** The projected extent in the map's spatial reference. */
projectedFullExtent: Extent;
/** When true, the layer is suspended. */
suspended: boolean;
/** Temporal information for the layer, such as time extent. */
timeInfo: TimeInfo;
/** URL to a WCS Server endpoint. */
url: string;
/** The version of WCSLayer, can be: 1.0.01.1.01.1.11.1.22.0.1 */
version: string;
/** The visibility of the layer. */
visible: boolean;
/** A WCS Connection object. */
wcsConnection: WCSConnection;
/**
* Creates a new WCSLayer.
* @param url URL to a WCS Server endpoint.
* @param options Optional parameters.
*/
constructor(url: string, options?: esri.WCSLayerOptions);
/** Returns the context of the Canvas. */
getContext(): any;
/**
* Returns an array of graphics as a Promise.
* @param mapPoint The map point location in which to identify.
*/
identify(mapPoint: Point): any;
/** Resumes layer drawing. */
resume(): void;
/**
* Sets the opacity of the layer.
* @param opacity Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency.
*/
setOpacity(opacity: number): void;
/**
* Sets a pixelFilter on the layer.
* @param pixelFilter The function defining the PixelFilter to set on the layer.
* @param doNotRefresh When true the layer will not refresh the map image.
*/
setPixelFilter(pixelFilter: Function, doNotRefresh?: boolean): void;
/**
* Determines if the layer will update its content based on the map's current time extent.
* @param use Use true to update the layer's content based on the map's current time extent.
*/
setUseMapTime(use: boolean): void;
/**
* Sets the visibility of the layer.
* @param isVisible Indicate whether to set layer visibility.
*/
setVisibility(isVisible: boolean): void;
/** Suspends layer drawing. */
suspend(): void;
/** Fires when there is a problem retrieving a layer. */
on(type: "error", listener: (event: { error: Error; target: WCSLayer }) => void): esri.Handle;
/** Fires after layer properties for the layer are successfully populated. */
on(type: "load", listener: (event: { layer: Layer; target: WCSLayer }) => void): esri.Handle;
/** Fires when the layer opacity has been changed, and returns an object with the opacity value. */
on(type: "opacity-change", listener: (event: { opacity: number; target: WCSLayer }) => void): esri.Handle;
/** This event is fired when the layer's refreshInterval is modified. */
on(type: "refresh-interval-change", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer resumes drawing. */
on(type: "resume", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer's minScale and/or maxScale is changed. */
on(type: "scale-range-change", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer's scale visibility changes. */
on(type: "scale-visibility-change", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer suspends drawing */
on(type: "suspend", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer has finished updating its content. */
on(type: "update-end", listener: (event: { error: Error; target: WCSLayer }) => void): esri.Handle;
/** Fires when a layer begins to update its content. */
on(type: "update-start", listener: (event: { target: WCSLayer }) => void): esri.Handle;
/** Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. */
on(type: "visibility-change", listener: (event: { visible: boolean; target: WCSLayer }) => void): esri.Handle;
on(type: string, listener: (event: any) => void): esri.Handle;
}
export = WCSLayer;
}
declare module "esri/layers/WFSLayer" {
import esri = require("esri");
import GraphicsLayer = require("esri/layers/GraphicsLayer");
@@ -10957,6 +11265,8 @@ declare module "esri/layers/WFSLayer" {
/** (Currently in beta) A layer for OGC Web Feature Services (WFS). */
class WFSLayer extends GraphicsLayer {
/** Use this to append custom parameters to WFS requests. */
customParameters: any;
/** An array of fields in the layer. */
fields: Field[];
/** The full extent of the layer. */
@@ -10987,6 +11297,11 @@ declare module "esri/layers/WFSLayer" {
redraw(): void;
/** Refreshes the features in the WFS layer. */
refresh(): void;
/**
* Sets the custom parameters used on the WFS layer.
* @param customParameters The customParameters object used append WFS requests.
*/
setCustomParameters(customParameters: any): void;
/** Sets the default line symbol to be used if no renderer is specified. */
setLineSymbol(): void;
/** Sets the default point symbol to be used if no renderer is specified. */
@@ -11012,12 +11327,20 @@ declare module "esri/layers/WMSLayer" {
allExtents: Extent[];
/** Copyright of the WMS service. */
copyright: string;
/** Use this to append different custom parameters to WMS layer requests. */
customLayerParameters: any;
/** Use this to append custom parameters to all WMS requests. */
customParameters: any;
/** Description of the WMS service. */
description: string;
/** Extent of the WMS service. */
extent: Extent;
/** Feature info MIME type to request. */
featureInfoFormat: string;
/** The URL for the WMS GetFeatureInfo call. */
getFeatureInfoURL: string;
/** The URL for the WMS GetMap call. */
getMapUrl: string;
getMapURL: string;
/** The map image format. */
imageFormat: string;
/** List of layers in the WMS service. */
@@ -11034,12 +11357,22 @@ declare module "esri/layers/WMSLayer" {
title: string;
/** Version of the WMS service. */
version: string;
/** A list of layer names that represent the layers to include in the exported map. */
visibleLayers: string[];
/**
* Creates a new WMSLayer object.
* @param url URL to the OGC Web Map Service.
* @param options Optional parameters.
*/
constructor(url: string, options?: esri.WMSLayerOptions);
/** Returns the current map image format. */
getImageFormat(): string;
/**
* Sets the custom parameters used on the WMS layer.
* @param customParameters The customParameters object used append WMS requests.
* @param customLayerParameters The customLayerParameters object used append specific WMS layer requests.
*/
setCustomParameters(customParameters: any, customLayerParameters?: any): void;
/**
* Set the map image format; valid values are "png", "jpg", "pdf", "bmp", "gif" and "svg".
* @param format The image format.
@@ -11106,6 +11439,10 @@ declare module "esri/layers/WMTSLayer" {
class WMTSLayer extends TiledMapServiceLayer {
/** Copyright information for the service. */
copyright: string;
/** Use this to append different custom parameters to a WMTS tile request. */
customLayerParameters: any;
/** Use this to append custom parameters to all WMTS requests. */
customParameters: any;
/** The description of the active layer if specified in the capabilties file or the resource info. */
description: string;
/** The tile format. */
@@ -11137,6 +11474,12 @@ declare module "esri/layers/WMTSLayer" {
* @param WMTSLayerInfo The WMTSLayerInfo for the layer to make active.
*/
setActiveLayer(WMTSLayerInfo: WMTSLayerInfo): void;
/**
* Sets the custom parameters used on the WMTS layer.
* @param customParameters The customParameters object used append WMTS requests.
* @param customLayerParameters The customLayerParameters object used append specific WMTS layer requests.
*/
setCustomParameters(customParameters: any, customLayerParameters?: any): void;
}
export = WMTSLayer;
}
@@ -11315,6 +11658,47 @@ declare module "esri/layers/layer" {
export = Layer;
}
declare module "esri/layers/pixelfilters/StretchFilter" {
import esri = require("esri");
/** A stretch filter used to work with client -side pixel data to enhance raster/image appearances. */
class StretchFilter {
/** Indicates whether to perform dynamic range adjustment using the current pixel data. */
dra: boolean;
/** An array of gamma values, for example [0.8, 0.8, 0.8]. */
gamma: number[];
/** The maximum value of stretched pixels. */
max: number;
/** Percent of pixels clipped on the right histogram tail, for example 0.25. */
maxPercent: number;
/** The minimum value of stretched pixels. */
min: number;
/** Percent of pixels clipped on the left histogram tail, for example 1.5. */
minPercent: number;
/** The number of standard deviations for StandardDeviation stretch, for example 2.5. */
numberOfStandardDeviations: number;
/** The output pixel type. */
outputPixelType: string;
/** An array of arrays containing custom statistics objects. */
statistics: any[][];
/** Number indicating the various stretch types. */
stretchType: number;
/** Indicates whether to perform non-linear gamma stretch. */
useGamma: boolean;
/**
* Creates an instance of a StretchFilter.
* @param options Optional parameters.
*/
constructor(options?: esri.StretchFilterOptions);
/**
* It takes a pixelData object as input and processes it.
* @param pixelData The pixelData object used as filter input.
*/
filter(pixelData: any): void;
}
export = StretchFilter;
}
declare module "esri/map" {
import esri = require("esri");
import Attribution = require("esri/dijit/Attribution");
@@ -11779,8 +12163,8 @@ declare module "esri/opsdashboard/ExtensionBase" {
static POLYLINE: any;
/** Read-only: Indicates if the host application is the Windows Operations Dashboard. */
isNative: boolean;
/** Read Only: It will list all of the Portal helper services. */
portalHelperServices: string;
/** Read-only: It will list all of the Portal helper services. */
portalHelperServices: any;
/** Read-only: The URL to the ArcGIS.com site or in-house portal that you are currently signed in to. */
portalUrl: string;
/** Get the collection of data sources from the host application. */
@@ -11838,8 +12222,11 @@ declare module "esri/opsdashboard/ExtensionConfigurationBase" {
class ExtensionConfigurationBase extends ExtensionBase {
/** The object that will store the Widget/MapTool/FeatureAction configuration. */
config: any;
/** Indicates that the configuration is ready to be persisted or not. */
readyToPersistConfig: boolean;
/**
* Indicates if the configuration is ready to be persisted or not.
* @param ready Indicates that the configuration is ready to be persisted or not.
*/
readyToPersistConfig(ready: boolean): void;
}
export = ExtensionConfigurationBase;
}
@@ -14127,6 +14514,8 @@ declare module "esri/tasks/FeatureSet" {
features: Graphic[];
/** Set of name-value pairs for the attribute's field and alias names. */
fieldAliases: any;
/** The array of fields. */
fields: any[];
/** The geometry type of the FeatureSet. */
geometryType: string;
/** When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. */
@@ -14379,7 +14768,7 @@ declare module "esri/tasks/GeometryService" {
url: string;
/**
* Creates a new GeometryService object.
* @param url URL to the ArcGIS Server REST resource that represents a GeometryService, e.g., http://sampleserver6.arcgisonline.com/ArcGIS/rest/services/Geometry/GeometryServer.
* @param url URL to the ArcGIS Server REST resource that represents a GeometryService, https://utility.arcgisonline.com/ArcGIS/rest/services/Geometry/GeometryServer.
*/
constructor(url: string);
/**
@@ -15165,6 +15554,7 @@ declare module "esri/tasks/PrintParameters" {
declare module "esri/tasks/PrintTask" {
import esri = require("esri");
import PrintParameters = require("esri/tasks/PrintParameters");
import DataFile = require("esri/tasks/DataFile");
/** The PrintTask class generates a printer-ready version of the map using an Export Web Map Task available with ArGIS Server 10.1 and later. */
class PrintTask {
@@ -15184,7 +15574,7 @@ declare module "esri/tasks/PrintTask" {
*/
execute(printParameters: PrintParameters, callback?: Function, errback?: Function): any;
/** Fired when the print operation is complete. */
on(type: "complete", listener: (event: { url: string; target: PrintTask }) => void): esri.Handle;
on(type: "complete", listener: (event: { result: DataFile; target: PrintTask }) => void): esri.Handle;
/** Fired when an error occurs while executing the print task. */
on(type: "error", listener: (event: { error: Error; target: PrintTask }) => void): esri.Handle;
on(type: string, listener: (event: any) => void): esri.Handle;