Add @deprecated tags

This commit is contained in:
Dasa Paddock
2017-12-23 10:46:39 -08:00
parent 8b93073673
commit e3f52cd4ce

View File

@@ -110,7 +110,10 @@ declare module "esri" {
resourceInfo?: any;
/** When true, the layer's attribution is displayed on the map. */
showAttribution?: boolean;
/** By default, images are exported in MIME format, and the image is streamed to the client. */
/**
* By default, images are exported in MIME format, and the image is streamed to the client.
* @deprecated
*/
useMapImage?: boolean;
/** When true, the layer will update its content based on the map's time extent. */
useMapTime?: boolean;
@@ -2156,9 +2159,15 @@ declare module "esri" {
export interface SymbolStylerOptions {
/** Added at v. */
portal?: string | any;
/** Self response of Portal used as symbol provider. */
/**
* Self response of Portal used as symbol provider.
* @deprecated
*/
portalSelf?: any;
/** URL to Portal used as symbol provider. */
/**
* URL to Portal used as symbol provider.
* @deprecated
*/
portalUrl?: string;
}
export interface TemplatePickerOptions {
@@ -3931,7 +3940,10 @@ declare module "esri/dijit/Directions" {
* @param srcNodeRef Reference or id of a HTML element that this dijit is rendered into.
*/
constructor(options: esri.DirectionsOptions, srcNodeRef: Node | string);
/** Deprecated at v3.13. */
/**
* Deprecated at v3.13.
* @deprecated
*/
activate(): void;
/**
* Add a stop to the directions widget at the specified index location.
@@ -3952,7 +3964,10 @@ declare module "esri/dijit/Directions" {
centerAtSegmentStart(index: number): void;
/** Remove the route directions from the directions list. */
clearDirections(): void;
/** Deprecated at v3.13. */
/**
* Deprecated at v3.13.
* @deprecated
*/
deactivate(): void;
/** Destroy the Directions widget. */
destroy(): void;
@@ -4116,7 +4131,10 @@ declare module "esri/dijit/FeatureTable" {
featureLayer: FeatureLayer;
/** An array of objects representing field information. */
fieldInfos: any[];
/** Reference to the dGrid. */
/**
* Reference to the dGrid.
* @deprecated
*/
grid: any;
/** Reference to the 'Options' drop-down menu. */
gridMenu: any;
@@ -8593,6 +8611,7 @@ declare module "esri/geometry/screenUtils" {
* @param width The current width of the map in screen units.
* @param height The current height of the map in screen units.
* @param screenPoint The screenPoint to convert from screen to map units.
* @deprecated
*/
toMapPoint(extent: Extent, width: number, height: number, screenPoint: ScreenPoint): Point;
/**
@@ -8609,6 +8628,7 @@ declare module "esri/geometry/screenUtils" {
* @param width The current width of the map in screen units.
* @param height The current height of the map in screen units.
* @param mapPoint The point to convert from map to screen units.
* @deprecated
*/
toScreenPoint(extent: Extent, width: number, height: number, mapPoint: Point): ScreenPoint;
};
@@ -8705,7 +8725,10 @@ declare module "esri/graphic" {
getChildGraphics(): Graphic[];
/** Returns the content string based on attributes and infoTemplate values. */
getContent(): string;
/** Returns the dojo/gfx/shape.Shape of the Esri graphic. */
/**
* Returns the dojo/gfx/shape.Shape of the Esri graphic.
* @deprecated
*/
getDojoShape(): any;
/** Returns the info template associated with the graphic. */
getInfoTemplate(): InfoTemplate;
@@ -8887,7 +8910,10 @@ declare module "esri/layers/ArcGISDynamicMapServiceLayer" {
timeInfo: TimeInfo;
/** Default units of the layer as defined by the service. */
units: string;
/** When true, the image is saved to the server, and a JSON formatted response is sent to the client with the URL location of the image. */
/**
* When true, the image is saved to the server, and a JSON formatted response is sent to the client with the URL location of the image.
* @deprecated
*/
useMapImage: boolean;
/** The version of ArcGIS Server where the map service is published. */
version: number;
@@ -10843,7 +10869,10 @@ declare module "esri/layers/RasterDataSource" {
declare module "esri/layers/RasterFunction" {
/** Specifies the processing to be done to the image service. */
class RasterFunction {
/** Deprecated at v3.10, use functionArguments instead. */
/**
* Deprecated at v3.10, use functionArguments instead.
* @deprecated
*/
arguments: any;
/** The arguments for the raster function. */
functionArguments: any;
@@ -12333,7 +12362,10 @@ declare module "esri/opsdashboard/ExtensionBase" {
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. */
/**
* Get the collection of data sources from the host application.
* @deprecated
*/
getDataSourceProxies(): any;
/**
* Get the data source corresponding to the data source id from the host application.
@@ -12961,7 +12993,10 @@ declare module "esri/renderers/ClassBreaksRenderer" {
attributeField: string;
/** To symbolize polygon features with graduated symbols, use backgroundFillSymbol to specify a simple fill symbol to represent polygon features, and use marker symbols of varying sizes in class breaks to indicate the quantity. */
backgroundFillSymbol: FillSymbol;
/** Deprecated at v2.0, use infos instead. */
/**
* Deprecated at v2.0, use infos instead.
* @deprecated
*/
breaks: any[];
/** The classification method used to generate class breaks. */
classificationMethod: string;
@@ -13143,13 +13178,25 @@ declare module "esri/renderers/Renderer" {
/** The base class for the renderers - SimpleRenderer, ClassBreaksRenderer, UniqueValueRenderer, DotDensityRenderer, ScaleDependentRenderer, TemporalRenderer, HeatmapRenderer, and VectorFieldRenderer used with a GraphicsLayer and FeatureLayer. */
class Renderer {
/** Deprecated. */
/**
* Deprecated.
* @deprecated
*/
colorInfo: any;
/** Deprecated. */
/**
* Deprecated.
* @deprecated
*/
opacityInfo: any;
/** Deprecated. */
/**
* Deprecated.
* @deprecated
*/
rotationInfo: any;
/** Deprecated. */
/**
* Deprecated.
* @deprecated
*/
sizeInfo: any;
/** This property allows you to define how to render values in a layer. */
visualVariables: any[];
@@ -13192,21 +13239,25 @@ declare module "esri/renderers/Renderer" {
/**
* Deprecated.
* @param info An info object that defines the color.
* @deprecated
*/
setColorInfo(info: any): Renderer;
/**
* Deprecated.
* @param info The info parameter is an object with the same properties as opacityInfo.
* @deprecated
*/
setOpacityInfo(info: any): Renderer;
/**
* Deprecated.
* @param info An object with the same properties as rotationInfo.
* @deprecated
*/
setRotationInfo(info: any): Renderer;
/**
* Deprecated.
* @param info An object with the same properties as sizeInfo.
* @deprecated
*/
setSizeInfo(info: any): Renderer;
/**
@@ -13424,7 +13475,10 @@ declare module "esri/renderers/UniqueValueRenderer" {
valueExpression: string;
/** The title identifying and describing the associated Arcade expression as defined in the valueExpression property. */
valueExpressionTitle: string;
/** Deprecated at v2.0, use infos instead. */
/**
* Deprecated at v2.0, use infos instead.
* @deprecated
*/
values: string[];
/**
* Creates a new UniqueValueRenderer object.
@@ -13739,7 +13793,10 @@ declare module "esri/symbols/Font" {
size: number;
/** Text style. */
style: string;
/** Text variant (deprecated). */
/**
* Text variant (deprecated).
* @deprecated
*/
variant: string;
/** Text weight. */
weight: string;
@@ -13782,6 +13839,7 @@ declare module "esri/symbols/Font" {
/**
* Sets the font variant (deprecated).
* @param variant Font variant.
* @deprecated
*/
setVariant(variant: string): Font;
/**
@@ -14171,11 +14229,17 @@ declare module "esri/symbols/TextSymbol" {
static DECORATION_OVERLINE: any;
/** Text is underlined. */
static DECORATION_UNDERLINE: any;
/** The text alignment in relation to the point. */
/**
* The text alignment in relation to the point.
* @deprecated
*/
align: string;
/** Text angle. */
angle: number;
/** The decoration on the text. */
/**
* The decoration on the text.
* @deprecated
*/
decoration: string;
/** Font for displaying text. */
font: Font;
@@ -14217,6 +14281,7 @@ declare module "esri/symbols/TextSymbol" {
/**
* Sets the alignment of the text.
* @param align The text alignment.
* @deprecated
*/
setAlign(align: string): TextSymbol;
/**
@@ -14227,6 +14292,7 @@ declare module "esri/symbols/TextSymbol" {
/**
* Sets the decoration for the text.
* @param decoration The decoration on the text.
* @deprecated
*/
setDecoration(decoration: string): TextSymbol;
/**
@@ -15178,7 +15244,10 @@ declare module "esri/tasks/Geoprocessor" {
/** Represents a GP Task resource exposed by the ArcGIS Server REST API. */
class Geoprocessor {
/** Deprecated at v2.0, use outSpatialReference instead. */
/**
* Deprecated at v2.0, use outSpatialReference instead.
* @deprecated
*/
outputSpatialReference: SpatialReference;
/** The spatial reference of the output geometries. */
outSpatialReference: SpatialReference;
@@ -15247,6 +15316,7 @@ declare module "esri/tasks/Geoprocessor" {
/**
* Deprecated at v2.0, use setOutSpatialReference instead.
* @param spatialReference The well-known ID of a spatial reference.
* @deprecated
*/
setOutputSpatialReference(spatialReference: SpatialReference): void;
/**