diff --git a/arcgis-js-api/arcgis-js-api.d.ts b/arcgis-js-api/arcgis-js-api.d.ts index 88d68cb19..1df24b79f 100644 --- a/arcgis-js-api/arcgis-js-api.d.ts +++ b/arcgis-js-api/arcgis-js-api.d.ts @@ -1,4 +1,4 @@ -// Type definitions for ArcGIS API for JavaScript v3.15 +// Type definitions for ArcGIS API for JavaScript v3.16 // Project: http://js.arcgis.com // Definitions by: Esri // Definitions: https://github.com/borisyankov/DefinitelyTyped @@ -284,6 +284,68 @@ declare module "esri" { /** An array of strings which correspond to fields to include in the CSVLayer. */ outFields?: string[]; } + export interface ChooseBestFacilitiesOptions { + /** The URL to the analysis service, for example "http://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer". */ + analysisGpServer?: string; + /** The number of facilities to choose when allocating demand locations. */ + candidateCount?: number; + /** Specify how much demand every facility in the candidateFacilitiesLayer is capable of supplying. */ + candidateFacilitiesCapacity?: string; + /** String value indicating the field name on the candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. */ + candidateFacilitiesCapacityField?: string; + /** A point layer specifying one or more locations that act as facilities by providing some kind of service. */ + candidateFacilitiesLayer?: FeatureLayer; + /** The amount of demand available at every demand locations. */ + demand?: number; + /** String value indicating the field name on the demandLocationLayer representing the amount of demand available at each demand location. */ + demandField?: string; + /** A point layer specifying the locations that have demand for facilities. */ + demandLocationLayer?: FeatureLayer; + /** Array of point layers to be used for choosing the demandLocationLayer. */ + demandLocationLayers: FeatureLayer[]; + /** When true, Travel Modes (Driving Time) is enabled for the inputLayer with the point geometries (esriGeometryPoint). */ + enableTravelModes?: boolean; + /** Array of point layers used for setting the required facilities layer and candidate facilities layer. */ + featureLayers: FeatureLayer[]; + /** Sets the selected folder of the select folder dropdown. */ + folderId?: string; + /** Sets the selected folder of the select folder dropdown. */ + folderName?: string; + /** Reference to the map. */ + map?: Map; + /** The maximum travel time or distance allowed between a demand location and its allocated facility. */ + maxTravelRange?: number; + /** String value indicating the field name on the demandLocationLayer specifying the maximum travel time or distance allowed between a demand location and its allocated facility. */ + maxTravelRangeField?: string; + /** The name of the output layer to be displayed in the result layer nameinputbox. */ + outputLayerName?: string; + /** The percentage of the total demand that you want the chosen and required facilities to capture. */ + percentDemandCoverage?: number; + /** The URL to the ArcGIS organization or Portal site where the GP server is hosted. */ + portalUrl?: string; + /** Specify how much demand every facility in the requiredFacilitiesLayer is capable of supplying. */ + requiredFacilitiesCapacity?: number; + /** A field on the requiredFacilitiesLayer representing how much demand each facility in this layer is capable of supplying. */ + requiredFacilitiesCapacityField?: string; + /** A point layer specifying one or more locations that act as facilities by providing some kind of service. */ + requiredFacilitiesLayer?: FeatureLayer; + /** Indicates whether to return the result of analysis as a client-side feature collection. */ + returnFeatureCollection?: boolean; + /** Indicates whether the "choose extent checkbox" is displayed. */ + showChooseExtent?: boolean; + /** Indicates whether to show the credit options. */ + showCredits ?: boolean; + /** Indicates whether the help links are displayed. */ + showHelp?: boolean; + /** Indicates whether to add an option to the UI that allows users to choose ready-to-use analysis layers from the Living Atlas Analysis Layers. */ + showReadyToUseLayers?: boolean; + /** Indicates whether to display a dropdown menu listing valid input analysis layers. */ + showSelectAnalysisLayer?: boolean; + /** Indicates whether the select folder dropdown will be displayed. */ + showSelectFolder?: boolean; + /** The default widget title with a custom title. */ + title?: string; + } export interface CircleOptions1 { /** Applicable when the spatial reference of the center point is either set to Web Mercator or geographic/geodesic as true would apply. */ geodesic?: boolean; @@ -525,12 +587,20 @@ declare module "esri" { locationProvider: LocationProviderBase; } export interface DataBrowserOptions { + /** Whether or not to display the hierarchy dropdown for countries with multiple hierarchies (e.g. */ + allowHierarchies?: boolean; /** Show/hide country drop down. */ countryBox?: boolean; /** Two-digit country code selected in the country drop down. */ countryID?: string; + /** The hierarchy to load for a country (e.g. */ + hierarchyID?: string; + /** Text string to display on the back button on the second and third pages of the Data Browser. */ + pageBackButton?: string; /** Selected variables array. */ selection?: string[]; + /** Whether to display the "Shopping Cart" of selected variables. */ + shoppingCart?: boolean; /** Title to show in the top left hand corner. */ title?: string; } @@ -841,28 +911,36 @@ declare module "esri" { layer: FeatureLayer; } export interface FeatureTableOptions { - /** A dGrid property. */ - allowSelectAll?: boolean; - /** A dGrid property. */ - cellNavigation?: boolean; /** Object defining the date options specifically for formatting date and time editors. */ dateOptions?: any; - /** Allows selection of a table's row via clicking a feature on the map. */ - enableLayerClick?: boolean; - /** Allows selection of a feature on a map via clicking row in the table. */ - enableLayerSelection?: boolean; + /** Sets the editing state for the FeatureTable. */ + editable?: boolean; /** The featureLayer that the table is associated with. */ featureLayer: FeatureLayer; + /** An array of objects representing field information. */ + fieldInfos?: any[]; /** Reference to the 'Options' drop-down menu. */ gridMenu?: any; + /** Object that can be used to set properties used by the underlying dgrid. */ + gridOptions?: any; /** Columns to hide by default using the dGrid ColumnHider extension. */ hiddenFields?: string[]; /** A reference to the Map. */ map?: Map; - /** A dGrid property. */ - noDataMessage?: string; - /** A dGrid property. */ - selectionMode?: string; + /** Adds additional functional menu items for the 'Options' drop-down menu. */ + menuFunctions?: any[]; + /** Attribute fields to include in the FeatureTable. */ + outFields?: string[]; + /** Displays the data type of the field right under the field label. */ + showDataTypes?: boolean; + /** Displays or hides the FeatureTable header. */ + showGridHeader?: boolean; + /** Displays or hides 'Options' drop-down menu of the FeatureTable. */ + showGridMenu?: boolean; + /** Enables an interaction between the map and the feature table. */ + syncSelection?: boolean; + /** Enables pan/zoom to selected features on the map when the table in 'sync selection' mode. */ + zoomToSelection?: boolean; } export interface FindHotSpotsOptions { /** An array of feature layer candidates to be selected as the aggregation polygon layer. */ @@ -1419,6 +1497,8 @@ declare module "esri" { popupWindowFeatures?: string; /** The ArcGIS for Portal URL. */ portalUrl?: string; + /** Indicates whether to display social logins such as Google/Facebook. */ + showSocialLogins?: boolean; } export interface ObliqueViewerOptions { /** Azimuth angle value for which to display oblique images. */ @@ -2076,7 +2156,7 @@ declare module "esri" { } export interface VisibleScaleRangeSliderOptions { /** Layer used to determine the suggested scale range and set the minScale, maxScale values. */ - layer: FeatureLayer; + layer?: Layer; /** Reference to the map. */ map: Map; /** Region of preview scale thumbnails. */ @@ -2693,6 +2773,8 @@ declare module "esri/arcgis/OAuthInfo" { popupWindowFeatures: string; /** The ArcGIS for Portal URL. */ portalUrl: string; + /** Indicates whether to display social logins like Google/Facebook. */ + showSocialLogins: boolean; /** * Creates a new OAuthInfo given the specified parameters. * @param params Various options to configure the OAuthInfo object. @@ -3815,43 +3897,56 @@ declare module "esri/dijit/FeatureTable" { import esri = require("esri"); import FeatureLayer = require("esri/layers/FeatureLayer"); import Map = require("esri/map"); + import FeatureEditResult = require("esri/layers/FeatureEditResult"); /** Creates an instance of the FeatureTable widget within the provided DOM node. */ class FeatureTable { - /** An optional dGrid property. */ - allowSelectAll: boolean; - /** An optional dGrid property. */ - cellNavigation: boolean; - /** A reference to the column objects and their parameters. */ + /** Read-only: A reference to the column objects and their parameters. */ columns: any[]; - /** Reference to the dataStore used by the dGrid. */ + /** Read-only: Reference to the dataStore used by the dGrid. */ dataStore: any; /** Object defining the date options specifically for formatting date and time editors. */ dateOptions: any; - /** Allows selection of a table's row via clicking a feature on the map. */ - enableLayerClick: boolean; - /** Allows selection of a feature on a map via clicking row in the table. */ - enableLayerSelection: boolean; + /** Sets the editing state for the FeatureTable. */ + editable: boolean; + /** Read-only: Number of records displayed in FeatureTable. */ + featureCount: number; /** The featureLayer that the table is associated with. */ featureLayer: FeatureLayer; + /** An array of objects representing field information. */ + fieldInfos: any[]; /** Reference to the dGrid. */ grid: any; /** Reference to the 'Options' drop-down menu. */ gridMenu: any; + /** Object that can be used to set properties used by the underlying dgrid. */ + gridOptions: any; /** Optional columns to hide by default using the dGrid ColumnHider extension. */ hiddenFields: string[]; - /** A reference to the primary key used by the dataStore to differentiate columns. */ + /** Read-only: A reference to the primary key used by the dataStore to differentiate columns. */ idProperty: string; /** When true, the FeatureTable widget has successfully loaded. */ loaded: boolean; /** Reference to the map. */ map: Map; - /** A dGrid property. */ - noDataMessage: string; + /** Adds additional functional menu items for the 'Options' drop-down menu. */ + menuFunctions: any[]; /** Attribute fields to include in the FeatureTable. */ outFields: string[]; - /** A dGrid property. */ - selectionMode: string; + /** Read-only: A comma delimited array of ObjectIds for the features selected in the FeatureTable. */ + selectedRowIds: number[]; + /** Read-only: Each element in the array is an object that contains name-value pair of fields and field values associated with the selected rows. */ + selectedRows: any[]; + /** Displays the data type of the field right under the field label in the column header. */ + showDataTypes: boolean; + /** Displays or hides the FeatureTable header. */ + showGridHeader: boolean; + /** Displays or hides 'Options' drop-down menu of the FeatureTable. */ + showGridMenu: boolean; + /** Enables an interaction between the map and the feature table. */ + syncSelection: boolean; + /** Enables pans to selected features on the map when the table in 'sync selection' mode. */ + zoomToSelection: boolean; /** * Creates an instance of the FeatureTable widget within the provided DOM node. * @param params Various options to configure this dijit. @@ -3860,14 +3955,34 @@ declare module "esri/dijit/FeatureTable" { constructor(params: esri.FeatureTableOptions, srcNodeRef: Node | string); /** Finalizes the creation of the widget. */ startup(): void; - /** Fired when a row is deselected. */ - on(type: "dgrid-deselect", listener: (event: { target: FeatureTable }) => void): esri.Handle; - /** Fired when the grid is refreshed. */ - on(type: "dgrid-refresh-complete", listener: (event: { target: FeatureTable }) => void): esri.Handle; - /** Fired when a row is selected. */ - on(type: "dgrid-select", listener: (event: { target: FeatureTable }) => void): esri.Handle; - /** Fired when the FeatureTable is loaded. */ + /** Fires when the grid column is resized. */ + on(type: "column-resize", listener: (event: { 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; + /** 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. */ + on(type: "editor-hide", listener: (event: { target: FeatureTable }) => void): esri.Handle; + /** Fires when grid editor is shown. */ + on(type: "editor-show", listener: (event: { target: FeatureTable }) => void): esri.Handle; + /** Fires when editing is complete. */ + on(type: "edits-complete", listener: (event: { adds: FeatureEditResult[]; deletes: FeatureEditResult[]; updates: FeatureEditResult[]; target: FeatureTable }) => void): esri.Handle; + /** 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; + /** 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; + /** Fires when a row is selected. */ + on(type: "row-select", listener: (event: { 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: string, listener: (event: any) => void): esri.Handle; } export = FeatureTable; @@ -4549,14 +4664,14 @@ declare module "esri/dijit/Measurement" { showTool(toolName: string): void; /** Finalizes the creation of the measurement widget . */ startup(): void; - /** Fires when a measurement is made but the measurement is not complete (single-click). */ - on(type: "measure", listener: (event: { geometry: Geometry; toolName: string; unitName: string; values: number; target: Measurement }) => void): esri.Handle; + /** Fires any time the mouse pointer moves while doing a distance measurement. */ + on(type: "measure", listener: (event: { geometry: Geometry; segmentLength: number; toolName: string; unitName: string; values: number; target: Measurement }) => void): esri.Handle; /** Fired when the measurement is complete. */ on(type: "measure-end", listener: (event: { geometry: Geometry; toolName: string; unitName: string; values: number[] | number; target: Measurement }) => void): esri.Handle; /** Fires when a measurement operation begins (single-click). */ on(type: "measure-start", listener: (event: { toolName: string; unitName: string; target: Measurement }) => void): esri.Handle; /** Fires when the primary tool is changed. */ - on(type: "tool-change", listener: (event: { toolName: string; unitName: string; target: Measurement }) => void): esri.Handle; + on(type: "tool-change", listener: (event: { previousToolName: string; toolName: string; unitName: string; target: Measurement }) => void): esri.Handle; /** Fires when the units currently being used by the Measurement widget changes. */ on(type: "unit-change", listener: (event: { toolName: string; unitName: string; target: Measurement }) => void): esri.Handle; on(type: string, listener: (event: any) => void): esri.Handle; @@ -4611,6 +4726,11 @@ declare module "esri/dijit/ObliqueViewer" { * @param params Constructor options. */ constructor(params: esri.ObliqueViewerOptions); + /** + * Queries and displays the best image in a specific direction. + * @param geometry The specified input geometry needed for querying for the best image in a given azimuth direction. + */ + locate(geometry: Geometry): void; /** * Projects the input geometry to the specified spatial reference. * @param geometry The geometry to project. @@ -4720,7 +4840,7 @@ declare module "esri/dijit/OverviewMap" { * @param params Parameters that define the functionality of the OverviewMap widget. * @param srcNodeRef HTML element where the widget should be rendered. */ - constructor(params: esri.OverviewMapOptions, srcNodeRef: Node | string); + constructor(params: esri.OverviewMapOptions, srcNodeRef?: Node | string); /** Releases the resources used by the dijit. */ destroy(): void; /** Hide the overview map. */ @@ -5399,6 +5519,14 @@ declare module "esri/dijit/TimeSlider" { singleThumbAsTimeInstant(createTimeInstants: boolean): void; /** Finalizes the creation of the widget. */ startup(): void; + /** Fires when the next button is clicked or TimeSlider.next() method is invoked. */ + on(type: "next", listener: (event: { timeExtent: TimeExtent; target: TimeSlider }) => void): esri.Handle; + /** Fires when the pause button is clicked or TImeSlider.pause() method is invoked. */ + on(type: "pause", listener: (event: { timeExtent: TimeExtent; target: TimeSlider }) => void): esri.Handle; + /** Fires once when the play button is clicked or Timeslider.play() method is invoked. */ + on(type: "play", listener: (event: { timeExtent: TimeExtent; target: TimeSlider }) => void): esri.Handle; + /** Fires when the previous button is clicked or TimeSlider.previous() is invoked. */ + on(type: "previous", listener: (event: { timeExtent: TimeExtent; target: TimeSlider }) => void): esri.Handle; /** Fires when the timeExtent of the TimeSlider is changed. */ on(type: "time-extent-change", listener: (event: { timeExtent: TimeExtent; target: TimeSlider }) => void): esri.Handle; on(type: string, listener: (event: any) => void): esri.Handle; @@ -5408,13 +5536,13 @@ declare module "esri/dijit/TimeSlider" { declare module "esri/dijit/VisibleScaleRangeSlider" { import esri = require("esri"); - import FeatureLayer = require("esri/layers/FeatureLayer"); + import Layer = require("esri/layers/layer"); import Map = require("esri/map"); - /** A widget that helps set the visible scale range for a layer. */ + /** A widget that sets the displayed visible scale values. */ class VisibleScaleRangeSlider { /** Setting the layer will update the suggested scale range, minScale and maxScale. */ - layer: FeatureLayer; + layer: Layer; /** Setting this property will update the slider's minimum/maximum values and current scale indicator. */ map: Map; /** Read-only: The maxScale bound in the slider range */ @@ -5434,7 +5562,7 @@ declare module "esri/dijit/VisibleScaleRangeSlider" { /** Finalizes the creation of the widget. */ startup(): void; /** Dispatched whenever minScale or maxScale changes. */ - on(type: "scale-range-change", listener: (event: { target: VisibleScaleRangeSlider }) => void): esri.Handle; + on(type: "scale-range-change", listener: (event: { maxScale: number; minScale: number; target: VisibleScaleRangeSlider }) => void): esri.Handle; on(type: string, listener: (event: any) => void): esri.Handle; } export = VisibleScaleRangeSlider; @@ -5609,6 +5737,84 @@ declare module "esri/dijit/analysis/CalculateDensity" { export = CalculateDensity; } +declare module "esri/dijit/analysis/ChooseBestFacilities" { + import esri = require("esri"); + import AnalysisBase = require("esri/dijit/analysis/AnalysisBase"); + import FeatureLayer = require("esri/layers/FeatureLayer"); + import Map = require("esri/map"); + + /** Choose Best Facilities allows you to choose the best locations for facilities. */ + class ChooseBestFacilities extends AnalysisBase { + /** The URL to the analysis service, for example "http://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer". */ + analysisGpServer: string; + /** The number of facilities to choose when allocating demand locations. */ + candidateCount: number; + /** This specifies how much demand every facility in the candidateFacilitiesLayer is capable of supplying. */ + candidateFacilitiesCapacity: string; + /** String value indicating the field name on the candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. */ + candidateFacilitiesCapacityField: string; + /** A point layer specifying one or more locations that act as facilities by providing some kind of service. */ + candidateFacilitiesLayer: FeatureLayer; + /** The amount of demand available at every demand locations. */ + demand: number; + /** String value indicating the field name on the demandLocationLayer representing the amount of demand available at each demand location. */ + demandField: string; + /** A point layer specifying the locations that have demand for facilities. */ + demandLocationLayer: FeatureLayer; + /** Array of point layers to be used for choosing the demandLocationLayer. */ + demandLocationLayers: FeatureLayer[]; + /** When true, Travel Modes (Driving Time) is enabled for the inputLayer with the point geometries (esriGeometryPoint). */ + enableTravelModes: boolean; + /** Array of point layers used for setting the required facilities layer and candidate facilities layer. */ + featureLayers: FeatureLayer[]; + /** Sets the selected folder of the select folder dropdown. */ + folderId: string; + /** Sets the selected folder of the select folder dropdown. */ + folderName: string; + /** Reference to the map. */ + map: Map; + /** The maximum travel time or distance allowed between a demand location and its allocated facility. */ + maxTravelRange: number; + /** String value indicating the field name on the demandLocationLayer specifying the maximum travel time or distance allowed between a demand location and its allocated facility. */ + maxTravelRangeField: string; + /** The name of the output layer to be displayed in the result layer nameinputbox. */ + outputLayerName: string; + /** The percentage of the total demand that you want the chosen and required facilities to capture. */ + percentDemandCoverage: number; + /** The URL to the ArcGIS organization or Portal site where the GP server is hosted. */ + portalUrl: string; + /** Specify how much demand every facility in the requiredFacilitiesLayer is capable of supplying. */ + requiredFacilitiesCapacity: number; + /** A field on the requiredFacilitiesLayer representing how much demand each facility in this layer is capable of supplying. */ + requiredFacilitiesCapacityField: string; + /** A point layer specifying one or more locations that act as facilities by providing some kind of service. */ + requiredFacilitiesLayer: FeatureLayer; + /** Indicates whether to return the result of analysis as a client-side feature collection. */ + returnFeatureCollection: boolean; + /** Indicates whether the "choose extent checkbox" is displayed. */ + showChooseExtent: boolean; + /** Indicates whether to show the credit options. */ + showCredits: boolean; + /** Indicates whether the help links are displayed. */ + showHelp: boolean; + /** Indicates whether to add an option to the UI that allows users to choose ready-to-use analysis layers from the Living Atlas Analysis Layers. */ + showReadyToUseLayers: boolean; + /** Indicates whether to display a dropdown menu listing valid input analysis layers. */ + showSelectAnalysisLayer: boolean; + /** Indicates whether the select folder dropdown will be displayed. */ + showSelectFolder: boolean; + /** The default widget title with a custom title. */ + title: string; + /** + * Creates a new ChooseBestFacilities dijit using the given DOM node. + * @param params Various options to configure this dijit. + * @param srcNodeRef Reference or id of a HTML element that this dijit is rendered into. + */ + constructor(params: esri.ChooseBestFacilitiesOptions, srcNodeRef: Node | string); + } + export = ChooseBestFacilities; +} + declare module "esri/dijit/analysis/ConnectOriginsToDestinations" { import esri = require("esri"); import AnalysisBase = require("esri/dijit/analysis/AnalysisBase"); @@ -6762,6 +6968,8 @@ declare module "esri/dijit/geoenrichment/DataBrowser" { /** The DataBrowser widget allows users to search or browse for geoenrichment variables. */ class DataBrowser { + /** An array of the variables currently loaded in the Data Browser. */ + variables: any[]; /** * Creates a new DataBrowser dijit using the given DOM node. * @param options Optional parameters used to create the layer. @@ -10322,7 +10530,7 @@ declare module "esri/layers/RasterLayer" { /** The RasterLayer is used to display image services. */ class RasterLayer extends Layer { - /** A function that takes a pixelData object as input, processes it, and returns it. */ + /** A function that takes a pixelData object as input and processes it. */ pixelFilter: Function; /** * Creates a new RasterLayer object. @@ -11897,6 +12105,11 @@ declare module "esri/plugins/FeatureLayerStatistics" { * @param options See the Object Specifications table below for the structure of the options object. */ getSampleFeatures(options?: any): any; + /** + * Returns a promise that resolves to an object containing spatial statistics for an array of input features. + * @param params See the Object Specifications table below for the structure of the params object. + */ + getSpatialStatistics(params: any): any; /** * Find optimal scale range for viewing this layer. * @param options See the Object Specifications table below for the structure of the options object. @@ -12268,23 +12481,27 @@ declare module "esri/renderers/Renderer" { /** * Gets the color for the Graphic. * @param graphic Graphic to get color from. + * @param options This optional parameter supports colorInfo. */ - getColor(graphic: Graphic): Color; + getColor(graphic: Graphic, options?: any): Color; /** * Returns the opacity value for the specified graphic. * @param graphic Returns the opacity value appropriate for the given graphic. + * @param options This optional parameter supports opacityInfo. */ - getOpacity(graphic: Graphic): number; + getOpacity(graphic: Graphic, options?: any): number; /** * Returns the angle of rotation (in degrees) for the graphic calculated using rotationInfo. * @param graphic An input graphic for which you want to get the angle of rotation. + * @param options This optional parameter supports rotationInfo. */ - getRotationAngle(graphic: Graphic): number; + getRotationAngle(graphic: Graphic, options?: any): number; /** * Return the symbol size (in pixels) for the graphic, calculated using sizeInfo. * @param graphic The graphic for which you want to calculate the symbol size. + * @param options This optional parameter supports sizeInfo. */ - getSize(graphic: Graphic): number; + getSize(graphic: Graphic, options?: any): number; /** * Gets the symbol for the Graphic. * @param graphic Graphic to symbolize. @@ -12670,6 +12887,11 @@ declare module "esri/renderers/smartMapping" { * @param params See the object specifications table below for the structure of the params object. */ createTypeRenderer(params: any): any; + /** + * Searches the fields of an input layer or array of field objects for field names commonly used in rendering based on usage (e.g. + * @param params See the object specifications table below for details about the params object. + */ + getSuggestedField(params: any): any; }; export = smartMapping; } @@ -15155,7 +15377,7 @@ declare module "esri/tasks/RouteTask" { import esri = require("esri"); import RouteParameters = require("esri/tasks/RouteParameters"); - /** The ArcGIS JavaScript API's routeTask allows you to find routes between two or more locations and optionally get driving directions. */ + /** The ArcGIS JavaScript API's RouteTask allows you to find routes between two or more locations and optionally get driving directions. */ class RouteTask { /** URL to the ArcGIS Server REST resource that represents a network analysis service. */ url: string; @@ -15317,7 +15539,7 @@ declare module "esri/tasks/ServiceAreaTask" { declare module "esri/tasks/StatisticDefinition" { /** The StatisticDefinition class defines the type of statistics, the field used to calculate the statistics and the resulting output field name. */ class StatisticDefinition { - /** Define the field on which statistics will be calculated. */ + /** The field name or standard SQL expression on which statistics will be calculated. */ onStatisticField: string; /** Specify the output field name. */ outStatisticFieldName: string; @@ -16389,8 +16611,6 @@ declare module "esri/tasks/locator" { /** Represents a geocode service resource exposed by the ArcGIS Server REST API. */ class Locator { - /** Limit the results to one or more categories. */ - categories: string[]; /** The country to limit results to for example "US" for United States or "SE" for Sweden. */ countryCode: string; /** The spatial reference of the output geometries. */ @@ -16703,9 +16923,9 @@ declare module "esri/toolbars/draw" { * @param set When set to false, the geometry is modified to be topologically correct. */ setRespectDrawingVertexOrder(set: boolean): void; - /** Fired when the user has ended drawing. */ + /** Fired when the user has completed drawing. */ on(type: "draw-complete", listener: (event: { geographicGeometry: Geometry; geometry: Geometry; target: Draw }) => void): esri.Handle; - /** Fires when drawing is complete. */ + /** This event is deprecated. */ on(type: "draw-end", listener: (event: { geometry: Geometry; target: Draw }) => void): esri.Handle; on(type: string, listener: (event: any) => void): esri.Handle; }