etincidunt 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.prettierignore +2 -0
- package/.travis.yml +29 -0
- package/.vscode/launch.json +24 -0
- package/.vscode/settings.json +3 -0
- package/demos/ago-node-cli/README.md +29 -0
- package/demos/ago-node-cli/ago.js +32 -0
- package/demos/ago-node-cli/index.js +11 -0
- package/demos/ago-node-cli/lib/item-export-command.js +48 -0
- package/demos/ago-node-cli/lib/item-search-command.js +35 -0
- package/demos/ago-node-cli/package-lock.json +172 -0
- package/demos/ago-node-cli/package.json +30 -0
- package/demos/attachments/README.md +5 -0
- package/demos/attachments/index.html +164 -0
- package/demos/attachments/package-lock.json +182 -0
- package/demos/attachments/package.json +18 -0
- package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
- package/demos/batch-geocoder-node/README.md +14 -0
- package/demos/batch-geocoder-node/batch-geocode.js +112 -0
- package/demos/batch-geocoder-node/config-template.js +18 -0
- package/demos/batch-geocoder-node/package-lock.json +109 -0
- package/demos/batch-geocoder-node/package.json +37 -0
- package/demos/express/README.md +10 -0
- package/demos/express/config.json.template +3 -0
- package/demos/express/package-lock.json +388 -0
- package/demos/express/package.json +18 -0
- package/demos/express/server.js +28 -0
- package/demos/feature-service-browser/README.md +6 -0
- package/demos/feature-service-browser/index.html +122 -0
- package/demos/feature-service-browser/package-lock.json +182 -0
- package/demos/feature-service-browser/package.json +18 -0
- package/demos/geocoder-browser/README.md +10 -0
- package/demos/geocoder-browser/config.js.template +1 -0
- package/demos/geocoder-browser/index.html +131 -0
- package/demos/geocoder-browser/package-lock.json +163 -0
- package/demos/geocoder-browser/package.json +19 -0
- package/demos/geocoder-browser/post-sign-in.html +25 -0
- package/demos/jsapi-integration/README.md +8 -0
- package/demos/jsapi-integration/config.js +6 -0
- package/demos/jsapi-integration/index.html +79 -0
- package/demos/jsapi-integration/package-lock.json +184 -0
- package/demos/jsapi-integration/package.json +19 -0
- package/demos/oauth2-browser/README.md +12 -0
- package/demos/oauth2-browser/authenticate.html +32 -0
- package/demos/oauth2-browser/config.js.template +6 -0
- package/demos/oauth2-browser/index.html +202 -0
- package/demos/oauth2-browser/logo.svg +4 -0
- package/demos/oauth2-browser/package-lock.json +163 -0
- package/demos/oauth2-browser/package.json +18 -0
- package/demos/oauth2-browser/style.css +36 -0
- package/demos/vue/.babelrc +6 -0
- package/demos/vue/.env.example +8 -0
- package/demos/vue/README.md +17 -0
- package/demos/vue/index.html +21 -0
- package/demos/vue/package-lock.json +7236 -0
- package/demos/vue/package.json +39 -0
- package/demos/vue/src/assets/logo.svg +29 -0
- package/demos/vue/src/components/App.vue +302 -0
- package/demos/vue/src/components/Authenticate.vue +68 -0
- package/demos/vue/src/components/Loader.vue +216 -0
- package/demos/vue/src/main.js +75 -0
- package/demos/vue/webpack.config.js +84 -0
- package/docs/FAQ.md +28 -0
- package/docs/HISTORY.md +62 -0
- package/docs/acetate.config.js +214 -0
- package/docs/build-typedoc.js +301 -0
- package/docs/src/_layout.html +82 -0
- package/docs/src/api/_declaration.html +496 -0
- package/docs/src/api/_layout.html +127 -0
- package/docs/src/api/_package.html +13 -0
- package/docs/src/api/index.html +23 -0
- package/docs/src/guides/_layout.html +24 -0
- package/docs/src/guides/amd-requirejs-dojo.md +40 -0
- package/docs/src/guides/babel-and-rollup.md +30 -0
- package/docs/src/guides/babel-and-webpack.md +30 -0
- package/docs/src/guides/browser-authentication.md +9 -0
- package/docs/src/guides/browserify.md +9 -0
- package/docs/src/guides/cli-authentication.md +9 -0
- package/docs/src/guides/client-server-authentication.md +9 -0
- package/docs/src/guides/from-a-cdn.md +36 -0
- package/docs/src/guides/index.md +52 -0
- package/docs/src/guides/node.md +30 -0
- package/docs/src/guides/package-overview.md +8 -0
- package/docs/src/guides/server-authentication.md +9 -0
- package/docs/src/guides/typescript-and-webpack.md +9 -0
- package/docs/src/img/icons.png +0 -0
- package/docs/src/img/icons@2x.png +0 -0
- package/docs/src/index.html +12 -0
- package/docs/src/js/api-search.js +113 -0
- package/docs/src/js/index.js +1 -0
- package/docs/src/js/nav-toggle.js +41 -0
- package/docs/src/sass/_highlight.scss +96 -0
- package/docs/src/sass/_icons.scss +157 -0
- package/docs/src/sass/style.scss +169 -0
- package/jasmine.json +7 -0
- package/karma.conf.js +100 -0
- package/lerna.json +8 -0
- package/notes/README.md +88 -0
- package/package.json +91 -0
- package/packages/arcgis-rest-auth/README.md +64 -0
- package/packages/arcgis-rest-auth/package-lock.json +11 -0
- package/packages/arcgis-rest-auth/package.json +51 -0
- package/packages/arcgis-rest-auth/src/ApplicationSession.ts +91 -0
- package/packages/arcgis-rest-auth/src/UserSession.ts +829 -0
- package/packages/arcgis-rest-auth/src/authenticated-request-options.ts +21 -0
- package/packages/arcgis-rest-auth/src/fetch-token.ts +55 -0
- package/packages/arcgis-rest-auth/src/generate-token.ts +36 -0
- package/packages/arcgis-rest-auth/src/index.ts +5 -0
- package/packages/arcgis-rest-auth/test/ApplicationSession.test.ts +121 -0
- package/packages/arcgis-rest-auth/test/UserSession.test.ts +883 -0
- package/packages/arcgis-rest-auth/test/fetchToken.test.ts +76 -0
- package/packages/arcgis-rest-auth/test/generateToken.test.ts +36 -0
- package/packages/arcgis-rest-auth/test/utils.ts +11 -0
- package/packages/arcgis-rest-auth/tsconfig.json +6 -0
- package/packages/arcgis-rest-common-types/README.md +61 -0
- package/packages/arcgis-rest-common-types/package.json +38 -0
- package/packages/arcgis-rest-common-types/src/group.ts +51 -0
- package/packages/arcgis-rest-common-types/src/index.ts +467 -0
- package/packages/arcgis-rest-common-types/src/item.ts +45 -0
- package/packages/arcgis-rest-common-types/src/webmap.ts +1225 -0
- package/packages/arcgis-rest-common-types/tsconfig.json +11 -0
- package/packages/arcgis-rest-feature-service/README.md +70 -0
- package/packages/arcgis-rest-feature-service/package-lock.json +11 -0
- package/packages/arcgis-rest-feature-service/package.json +50 -0
- package/packages/arcgis-rest-feature-service/src/add.ts +82 -0
- package/packages/arcgis-rest-feature-service/src/addAttachment.ts +65 -0
- package/packages/arcgis-rest-feature-service/src/delete.ts +85 -0
- package/packages/arcgis-rest-feature-service/src/deleteAttachments.ts +68 -0
- package/packages/arcgis-rest-feature-service/src/getAttachments.ts +64 -0
- package/packages/arcgis-rest-feature-service/src/helpers.ts +77 -0
- package/packages/arcgis-rest-feature-service/src/index.ts +8 -0
- package/packages/arcgis-rest-feature-service/src/query.ts +174 -0
- package/packages/arcgis-rest-feature-service/src/update.ts +81 -0
- package/packages/arcgis-rest-feature-service/src/updateAttachment.ts +74 -0
- package/packages/arcgis-rest-feature-service/test/attachments.test.ts +179 -0
- package/packages/arcgis-rest-feature-service/test/features.test.ts +172 -0
- package/packages/arcgis-rest-feature-service/test/mocks/feature.ts +220 -0
- package/packages/arcgis-rest-feature-service/test/mocks/foo.txt +1 -0
- package/packages/arcgis-rest-feature-service/tsconfig.json +6 -0
- package/packages/arcgis-rest-geocoder/README.md +73 -0
- package/packages/arcgis-rest-geocoder/package-lock.json +11 -0
- package/packages/arcgis-rest-geocoder/package.json +52 -0
- package/packages/arcgis-rest-geocoder/src/bulk.ts +102 -0
- package/packages/arcgis-rest-geocoder/src/geocode.ts +117 -0
- package/packages/arcgis-rest-geocoder/src/helpers.ts +81 -0
- package/packages/arcgis-rest-geocoder/src/index.ts +4 -0
- package/packages/arcgis-rest-geocoder/src/reverse.ts +84 -0
- package/packages/arcgis-rest-geocoder/src/suggest.ts +72 -0
- package/packages/arcgis-rest-geocoder/test/geocoder.test.ts +510 -0
- package/packages/arcgis-rest-geocoder/test/mocks/responses.ts +588 -0
- package/packages/arcgis-rest-geocoder/tsconfig.json +6 -0
- package/packages/arcgis-rest-groups/README.md +64 -0
- package/packages/arcgis-rest-groups/package-lock.json +11 -0
- package/packages/arcgis-rest-groups/package.json +52 -0
- package/packages/arcgis-rest-groups/src/groups.ts +272 -0
- package/packages/arcgis-rest-groups/src/index.ts +1 -0
- package/packages/arcgis-rest-groups/test/groups.test.ts +280 -0
- package/packages/arcgis-rest-groups/test/mocks/responses.ts +137 -0
- package/packages/arcgis-rest-groups/tsconfig.json +6 -0
- package/packages/arcgis-rest-items/README.md +66 -0
- package/packages/arcgis-rest-items/package-lock.json +11 -0
- package/packages/arcgis-rest-items/package.json +52 -0
- package/packages/arcgis-rest-items/src/index.ts +1 -0
- package/packages/arcgis-rest-items/src/items.ts +498 -0
- package/packages/arcgis-rest-items/test/items.test.ts +1153 -0
- package/packages/arcgis-rest-items/test/mocks/foo.zip +0 -0
- package/packages/arcgis-rest-items/test/mocks/item.ts +30 -0
- package/packages/arcgis-rest-items/test/mocks/resources.ts +28 -0
- package/packages/arcgis-rest-items/test/mocks/search.ts +60 -0
- package/packages/arcgis-rest-items/tsconfig.json +6 -0
- package/packages/arcgis-rest-request/README.md +65 -0
- package/packages/arcgis-rest-request/package-lock.json +11 -0
- package/packages/arcgis-rest-request/package.json +42 -0
- package/packages/arcgis-rest-request/src/index.ts +10 -0
- package/packages/arcgis-rest-request/src/request.ts +259 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISAuthError.ts +67 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +73 -0
- package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
- package/packages/arcgis-rest-request/src/utils/check-for-errors.ts +65 -0
- package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +29 -0
- package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +23 -0
- package/packages/arcgis-rest-request/src/utils/get-portal-url.ts +25 -0
- package/packages/arcgis-rest-request/src/utils/get-portal.ts +45 -0
- package/packages/arcgis-rest-request/src/utils/process-params.ts +99 -0
- package/packages/arcgis-rest-request/test/mocks/errors.ts +59 -0
- package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +10 -0
- package/packages/arcgis-rest-request/test/mocks/portal.ts +109 -0
- package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts +38 -0
- package/packages/arcgis-rest-request/test/mocks/webmap.ts +38 -0
- package/packages/arcgis-rest-request/test/request.test.ts +296 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +167 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts +40 -0
- package/packages/arcgis-rest-request/test/utils/check-for-errors.test.ts +101 -0
- package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +112 -0
- package/packages/arcgis-rest-request/test/utils/get-portal-url.test.ts +34 -0
- package/packages/arcgis-rest-request/test/utils/portal.test.ts +94 -0
- package/packages/arcgis-rest-request/test/utils/process-params.test.ts +190 -0
- package/packages/arcgis-rest-request/tsconfig.json +6 -0
- package/packages/arcgis-rest-sharing/README.md +67 -0
- package/packages/arcgis-rest-sharing/package-lock.json +11 -0
- package/packages/arcgis-rest-sharing/package.json +55 -0
- package/packages/arcgis-rest-sharing/src/access.ts +91 -0
- package/packages/arcgis-rest-sharing/src/group-sharing.ts +212 -0
- package/packages/arcgis-rest-sharing/src/helpers.ts +92 -0
- package/packages/arcgis-rest-sharing/src/index.ts +2 -0
- package/packages/arcgis-rest-sharing/test/access.test.ts +153 -0
- package/packages/arcgis-rest-sharing/test/group-sharing.test.ts +436 -0
- package/packages/arcgis-rest-sharing/test/mocks/sharing.ts +15 -0
- package/packages/arcgis-rest-sharing/tsconfig.json +6 -0
- package/packages/arcgis-rest-users/README.md +71 -0
- package/packages/arcgis-rest-users/package-lock.json +11 -0
- package/packages/arcgis-rest-users/package.json +51 -0
- package/packages/arcgis-rest-users/src/index.ts +1 -0
- package/packages/arcgis-rest-users/src/users.ts +70 -0
- package/packages/arcgis-rest-users/test/mocks/responses.ts +170 -0
- package/packages/arcgis-rest-users/test/users.test.ts +97 -0
- package/packages/arcgis-rest-users/tsconfig.json +6 -0
- package/support/FormData.d.ts +1 -0
- package/support/changelog.js +388 -0
- package/support/commit-template.txt +19 -0
- package/support/deploy-doc-site.js +16 -0
- package/support/publish.sh +40 -0
- package/support/test-helpers.js +8 -0
- package/tsconfig.json +69 -0
- package/tslint.json +14 -0
- package/umd-base-profile.js +82 -0
- package/umd-production-profile.js +13 -0
@@ -0,0 +1,1225 @@
|
|
1
|
+
import {
|
2
|
+
IFeatureSet,
|
3
|
+
IField,
|
4
|
+
IExtent,
|
5
|
+
ISpatialReference,
|
6
|
+
esriGeometryType,
|
7
|
+
IHasZM,
|
8
|
+
IFeature,
|
9
|
+
IGeometry,
|
10
|
+
IPoint,
|
11
|
+
ISimpleLineSymbol,
|
12
|
+
IPictureMarkerSymbol,
|
13
|
+
ISimpleFillSymbol,
|
14
|
+
Color
|
15
|
+
} from "./index";
|
16
|
+
|
17
|
+
/**
|
18
|
+
* The format object can be used with numerical or date fields to provide more detail about how values should be displayed in popup windows.
|
19
|
+
*/
|
20
|
+
export interface IFieldFormat {
|
21
|
+
/** A string used with date fields to specify how the date should appear in popup windows. */
|
22
|
+
dateFormat?:
|
23
|
+
| "shortDate"
|
24
|
+
| "shortDateLE"
|
25
|
+
| "longMonthDayYear"
|
26
|
+
| "dayShortMonthYear"
|
27
|
+
| "longDate"
|
28
|
+
| "shortDateShortTime"
|
29
|
+
| "shortDateLEShortTime"
|
30
|
+
| "shortDateShortTime24"
|
31
|
+
| "shortDateLEShortTime24"
|
32
|
+
| "shortDateLongTime"
|
33
|
+
| "shortDateLELongTime"
|
34
|
+
| "shortDateLongTime24"
|
35
|
+
| "shortDateLELongTime24"
|
36
|
+
| "longMonthYear"
|
37
|
+
| "shortMonthYear"
|
38
|
+
| "year";
|
39
|
+
|
40
|
+
/**
|
41
|
+
* A Boolean used with numerical fields. A value of true allows the number to have a digit (or thousands) separator when the value appears in popup windows.
|
42
|
+
* Depending on the locale, this separator is a decimal point or a comma. A value of false means that no separator will be used.
|
43
|
+
*/
|
44
|
+
digitSeparator?: boolean;
|
45
|
+
/**
|
46
|
+
* An integer used with numerical fields to specify the number of supported decimal places that should appear in popup windows. Any places beyond this value are rounded.
|
47
|
+
*/
|
48
|
+
places?: number;
|
49
|
+
}
|
50
|
+
|
51
|
+
/**
|
52
|
+
* Defines how a field in the dataset participates (or does not participate) in a popup window.
|
53
|
+
*/
|
54
|
+
export interface IFieldInfo {
|
55
|
+
/** A string containing the field name as defined by the service. Anywhere that a fieldname is referenced as {field-name} in popupInfo, an Arcade expression can also be referenced as{expression/}`. */
|
56
|
+
fieldName?: any;
|
57
|
+
/** A format object used with numerical or date fields to provide more detail about how the value should be displayed in a web map popup window. */
|
58
|
+
format?: IFieldFormat;
|
59
|
+
/** A Boolean determining whether users can edit this field. Not applicable to Arcade expressions. */
|
60
|
+
isEditable?: boolean;
|
61
|
+
/** A string containing the field alias. This can be overridden by the web map author. Not applicable to Arcade expressions as title is used instead. */
|
62
|
+
label?: string;
|
63
|
+
/** A string determining what type of input box editors see when editing the field. Applies only to string fields. Not applicable to Arcade expressions. */
|
64
|
+
stringFieldOption?: "textbox" | "textarea" | "richtext";
|
65
|
+
|
66
|
+
/** A string providing an editing hint for editors of the field. Not applicable to Arcade expressions. */
|
67
|
+
tooltip?: string;
|
68
|
+
/** A Boolean determining whether the field is visible in the popup window. */
|
69
|
+
visible?: boolean;
|
70
|
+
}
|
71
|
+
|
72
|
+
/**
|
73
|
+
* Arcade expression added to the pop-up.
|
74
|
+
*/
|
75
|
+
export interface IPopupExpressionInfo {
|
76
|
+
/** The Arcade expression. */
|
77
|
+
expression?: string;
|
78
|
+
/** Unique identifier for the expression. */
|
79
|
+
name?: string;
|
80
|
+
/** Return type of the Arcade expression, can be number or string. Defaults to string value. Number values are assumed to be double. This can be determined by the authoring client by executing the expression using a sample feature(s), although it can be corrected by the user. Knowing the returnType allows the authoring client to present fields in relevant contexts. For example, numeric fields in numeric contexts such as charts. */
|
81
|
+
returnType?: "number" | "string";
|
82
|
+
/** Title of the expression. */
|
83
|
+
title?: string;
|
84
|
+
}
|
85
|
+
|
86
|
+
/**
|
87
|
+
* The value object contains information for popup windows about how images should be retrieved or charts constructed.
|
88
|
+
*/
|
89
|
+
export interface IMediaInfoValue {
|
90
|
+
/** Used with charts. An array of strings, with each string containing the name of a field to display in the chart. */
|
91
|
+
fields?: string[];
|
92
|
+
/** Used with images. A string containing a URL to be launched in a browser when a user clicks the image. */
|
93
|
+
linkURL?: string;
|
94
|
+
/** Used with charts. An optional string containing the name of a field. The values of all fields in the chart will be normalized (divided) by the value of this field. */
|
95
|
+
normalizeField?: string;
|
96
|
+
/** Used with images. A string containing the URL to the image. */
|
97
|
+
sourceURL?: string;
|
98
|
+
/** String value indicating the tooltip for a chart specified from another field. This field is needed when related records are not sued. It is used for showing tooltips from another field in the same layer or related layer/table. */
|
99
|
+
tooltipField?: string;
|
100
|
+
}
|
101
|
+
|
102
|
+
/**
|
103
|
+
* Defines an image or a chart to be displayed in a popup window.
|
104
|
+
*/
|
105
|
+
export interface IMediaInfo {
|
106
|
+
/** A string caption describing the media. */
|
107
|
+
caption?: any;
|
108
|
+
/** 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's equivalent to having a value of 0. Only applicable when type is set to image. */
|
109
|
+
refreshInterval?: any;
|
110
|
+
/** A string title for the media. */
|
111
|
+
title?: string | null;
|
112
|
+
/** A string defining the type of media. */
|
113
|
+
type?: "image" | "barchart" | "columnchart" | "linechart" | "piechart";
|
114
|
+
|
115
|
+
/** A value object containing information about how the image should be retrieved or how the chart should be constructed. */
|
116
|
+
value?: IMediaInfoValue | null;
|
117
|
+
}
|
118
|
+
|
119
|
+
/**
|
120
|
+
* Popup elements allow users to author popups, using multiple elements such as tabular views, string description, media (charts and images), and attachments of the attributes
|
121
|
+
* and control the order in which they appear. Specifically, popupElements do the following:
|
122
|
+
* 1) provide the ability to explicitly add a field/ value table in addition to a description,
|
123
|
+
* 2) allow adding multiple description elements, and
|
124
|
+
* 3) allow a user to author and consume elements of a popup in the order of their choosing.
|
125
|
+
*/
|
126
|
+
export interface IPopupElement {
|
127
|
+
/**
|
128
|
+
* This property applies to elements of type attachments. A string value indicating how to display the attachment.
|
129
|
+
* Possible values are, preview, and list. If list is specified, attachments show as links.
|
130
|
+
*/
|
131
|
+
displayType?: "preview" | "list";
|
132
|
+
/**
|
133
|
+
* This property applies to elements of type fields. It is an array of popupInfo.fieldInfo objects representing a field/value pair displayed as a table within the popupElement.
|
134
|
+
* If the fieldInfos property is not provided, the popupElement will display whatever is specified directly in the popupInfo.fieldInfos property.
|
135
|
+
*/
|
136
|
+
fieldInfos?: IFieldInfo[];
|
137
|
+
/**
|
138
|
+
* This property applies to elements of type media. An array of popupInfo.mediaInfo objects representing an image or chart for display.
|
139
|
+
* If no mediaInfos property is provided, the popupElement will display whatever is specified in the popupInfo.mediaInfo property.
|
140
|
+
*/
|
141
|
+
mediaInfos?: IMediaInfo[];
|
142
|
+
/**
|
143
|
+
* This property applies to elements of type text. This is string value indicating the text to be displayed within the popupElement.
|
144
|
+
* If no text property is provided, the popupElement will display whatever is specified in the popupInfo.description property.
|
145
|
+
*/
|
146
|
+
text?: string;
|
147
|
+
/** String value indicating which elements to use. */
|
148
|
+
type?: "text" | "fields" | "media" | "attachments";
|
149
|
+
}
|
150
|
+
|
151
|
+
/**
|
152
|
+
* Object indicating the field display order for the related records and whether they should be sorted in ascending or descending order.
|
153
|
+
*/
|
154
|
+
export interface IOrderByField {
|
155
|
+
/** The attribute value of the field selected that will drive the sorting of related records. */
|
156
|
+
field?: string;
|
157
|
+
/** Set the ascending or descending sort order of the returned related records. */
|
158
|
+
order?: "asc" | "desc";
|
159
|
+
}
|
160
|
+
|
161
|
+
/**
|
162
|
+
* The sort in the popupInfo for the parent feature. This impacts the sorting order for the returned child records.
|
163
|
+
*/
|
164
|
+
export interface IRelatedRecordsInfo {
|
165
|
+
/** Array of orderByFields objects indicating the field display order for the related records and whether they should be sorted in ascending 'asc' or descending 'desc' order. */
|
166
|
+
orderByFields?: IOrderByField[];
|
167
|
+
/** Required boolean value indicating whether to display related records. If true, client should let the user navigate to the related records. Defaults to true if the layer participates in a relationship AND the related layer/table has already been added to the map (either as an operationalLayer or as a table). */
|
168
|
+
showRelatedRecords: boolean;
|
169
|
+
}
|
170
|
+
|
171
|
+
/**
|
172
|
+
* Defines the look and feel of popup windows when a user clicks or queries a feature.
|
173
|
+
*/
|
174
|
+
export interface IPopupInfo {
|
175
|
+
/** A string that appears in the body of the popup window as a description. It is also possible to specify the description as HTML-formatted content. */
|
176
|
+
description?: string | null;
|
177
|
+
/** List of Arcade expressions added to the pop-up. */
|
178
|
+
expressionInfos?: IPopupExpressionInfo[];
|
179
|
+
/** Array of fieldInfo information properties. This information is provided by the service layer definition. When the description uses name/value pairs, the order of the array is how the fields display in the editable Map Viewer popup and the resulting popup. It is also possible to specify HTML-formatted content. */
|
180
|
+
fieldInfos?: IFieldInfo[];
|
181
|
+
/** Additional options that can be defined for the popup layer. */
|
182
|
+
layerOptions?: {
|
183
|
+
/** Indicates whether or not the NoData records should be displayed. */
|
184
|
+
showNoDataRecords: boolean;
|
185
|
+
};
|
186
|
+
/** Array of various mediaInfo to display. Can be of type image, piechart, barchart, columnchart, or linechart. The order given is the order in which is displays. */
|
187
|
+
mediaInfos?: IMediaInfo[];
|
188
|
+
/** An array of popupElement objects that represent an ordered list of popup elements. */
|
189
|
+
popupElements?: IPopupElement[];
|
190
|
+
/** Indicates whether to enable related records if they exist on a layer. */
|
191
|
+
relatedRecordsInfo?: IRelatedRecordsInfo;
|
192
|
+
/** Indicates whether attachments will be loaded for feature layers that have attachments. */
|
193
|
+
showAttachments?: boolean;
|
194
|
+
/** A string that appears at the top of the popup window as a title. */
|
195
|
+
title?: string;
|
196
|
+
}
|
197
|
+
|
198
|
+
/**
|
199
|
+
* Defines the appearance for the background of the map.
|
200
|
+
* @example
|
201
|
+
* { "background": { "color": [255,255,255,255] } }
|
202
|
+
*/
|
203
|
+
export interface IWebMapBackground {
|
204
|
+
/**
|
205
|
+
* To define the color of the background of the map (which is shown when no data is shown).
|
206
|
+
*/
|
207
|
+
color: Color;
|
208
|
+
}
|
209
|
+
|
210
|
+
/**
|
211
|
+
* Predefined bookmarks for use by the application. A bookmark is a saved map extent that allows end users to quickly navigate to a particular area of interest.
|
212
|
+
*/
|
213
|
+
export interface IBookmark {
|
214
|
+
/** An extent object containing a spatial reference, a lower left coordinate, and an upper right coordinate defining the rectangular area of the bookmark. The spatial reference must be the same as the map spatial reference. Documentation for the envelope is in the Geometry Objects topic of the ArcGIS REST API help. */
|
215
|
+
extent: IExtent;
|
216
|
+
/** A string name for the bookmark. */
|
217
|
+
name: string;
|
218
|
+
}
|
219
|
+
|
220
|
+
/**
|
221
|
+
* Map range information
|
222
|
+
* @example
|
223
|
+
* {
|
224
|
+
* "mapRangeInfo": {
|
225
|
+
* "activeRangeName": "floors",
|
226
|
+
* "currentRangeExtent": [ -2, 10 ],
|
227
|
+
* "fullRangeExtent": [-2, 100 ]
|
228
|
+
* }
|
229
|
+
* }
|
230
|
+
*/
|
231
|
+
export interface IMapRangeInfo {
|
232
|
+
/** Active range ID that slider/picker acts upon. */
|
233
|
+
activeRangeName?: string;
|
234
|
+
/** Current range for the active range. */
|
235
|
+
currentRangeExtent?: number[];
|
236
|
+
/** Full range extent for the active range to be presented in the UI. */
|
237
|
+
fullRangeExtent?: number[];
|
238
|
+
}
|
239
|
+
|
240
|
+
/**
|
241
|
+
* Contains location information within a presentation slide.
|
242
|
+
* @see https://developers.arcgis.com/web-map-specification/objects/mapLocation/
|
243
|
+
*/
|
244
|
+
export interface IMapLocation {
|
245
|
+
/** The center of the map specified using X/Y coordinates. */
|
246
|
+
centerPoint: IPoint;
|
247
|
+
/** Well-known ID (WKID) or well-known text (WKT). */
|
248
|
+
spatialReference: ISpatialReference;
|
249
|
+
}
|
250
|
+
|
251
|
+
/**
|
252
|
+
* An array of numbers indicating layer visibility.
|
253
|
+
* @example
|
254
|
+
* {
|
255
|
+
* "visibleLayer": {
|
256
|
+
* "featureVisibility": [
|
257
|
+
* [ 1 ],
|
258
|
+
* [],
|
259
|
+
* [],
|
260
|
+
* [ 0 ]
|
261
|
+
* ],
|
262
|
+
* "id": "73128eb3-05ee-46a7-8c22-0c385a0b1827"
|
263
|
+
* }
|
264
|
+
* }
|
265
|
+
*/
|
266
|
+
export interface IVisibleLayer {
|
267
|
+
/** An array of arrays. */
|
268
|
+
featureVisibility?: any[][];
|
269
|
+
/** The id of the layer as listed on the operational layer. */
|
270
|
+
id?: number;
|
271
|
+
/** An array of integers. */
|
272
|
+
subLayerIds?: number[];
|
273
|
+
}
|
274
|
+
|
275
|
+
/**
|
276
|
+
* A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId.
|
277
|
+
* @see https://developers.arcgis.com/web-map-specification/objects/visiblePopup/
|
278
|
+
*/
|
279
|
+
export interface IVisiblePopup {
|
280
|
+
/** Object with spatialReference, x, and y. */
|
281
|
+
anchorPoint?: IPoint;
|
282
|
+
/** An integer specifying the feature's id. */
|
283
|
+
featureId?: number;
|
284
|
+
/** A string specifying the layer id. */
|
285
|
+
layerId?: string;
|
286
|
+
/** An integer specifying the sublayer id. */
|
287
|
+
subLayerId?: number;
|
288
|
+
}
|
289
|
+
|
290
|
+
export interface ISlide {
|
291
|
+
/** Basemaps give the web map a geographic context. */
|
292
|
+
baseMap?: IBaseMap;
|
293
|
+
/** The standard Esri extent object with spatialReference, xmax, xmin, ymax and ymin. */
|
294
|
+
extent?: IExtent;
|
295
|
+
/** Indicates whether the slide should be hidden within the presentation. */
|
296
|
+
hidden?: boolean;
|
297
|
+
/** An object with a centerPoint object and sometimes a resolution. */
|
298
|
+
mapLocation?: IMapLocation;
|
299
|
+
/** An array of two numbers. The first one indicates start time and the second one indicates end time. */
|
300
|
+
timeExtent?: [number, number];
|
301
|
+
/** Title including text and formatting for each slide. */
|
302
|
+
title?: string;
|
303
|
+
/** An array of objects used to indicate layer visibility. */
|
304
|
+
visibleLayers?: IVisibleLayer;
|
305
|
+
/** A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId. */
|
306
|
+
visiblePopup?: IVisiblePopup;
|
307
|
+
}
|
308
|
+
|
309
|
+
export interface IPresentation {
|
310
|
+
/** Indicates whether to display the time slider (if accessible). */
|
311
|
+
displayTimeSlider?: boolean;
|
312
|
+
/** Indicates whether to display a legend on all slides. */
|
313
|
+
showLegend?: boolean;
|
314
|
+
/** Number of seconds to show slide before proceeding to the next slide. */
|
315
|
+
slideAdvancementInterval?: number;
|
316
|
+
/** Array of slide objects. */
|
317
|
+
slides?: ISlide[];
|
318
|
+
/** Indicates whether to use the time extent (if applicable) of a slide. */
|
319
|
+
useTimeExtentOfSlide?: boolean;
|
320
|
+
}
|
321
|
+
|
322
|
+
/**
|
323
|
+
* Root element in the web map specifying an array of table objects.
|
324
|
+
*/
|
325
|
+
export interface ITable {
|
326
|
+
/** A comma-separated string listing which editing operations are allowed on an editable feature service. Available operations include: 'Create', 'Delete', 'Query', 'Update', and 'Editing'. */
|
327
|
+
capabilities?: string;
|
328
|
+
/** Object indicating the definitionEditor used as a layer's interactive filter. */
|
329
|
+
definitionEditor?: IDefinitionEditor;
|
330
|
+
/** Unique string identifier for the table. */
|
331
|
+
id?: string;
|
332
|
+
/** Unique string value indicating an item registered in ArcGIS Online or your organization's portal. */
|
333
|
+
itemId?: string;
|
334
|
+
/** A layerDefinition object defining a definition expression for the table. */
|
335
|
+
layerDefinition?: ILayerDefinition;
|
336
|
+
/** An object defining the content of popup windows when you query a record and the sort option for child related records. */
|
337
|
+
popupInfo?: IPopupInfo;
|
338
|
+
/** String value for the title of the table. */
|
339
|
+
title?: string;
|
340
|
+
/** String value indicating the URL reference of the hosted table. */
|
341
|
+
url?: string;
|
342
|
+
}
|
343
|
+
|
344
|
+
/**
|
345
|
+
* The web map data lists the basemap, operational layers, and bookmarks to be used in the web map.
|
346
|
+
* It also contains information about popup windows and layer styling overrides to be used in the web map.
|
347
|
+
* A version property allows you to supply the version of the web map JSON format being used.
|
348
|
+
*/
|
349
|
+
export interface IWebmap {
|
350
|
+
/** Viewing and editing properties of the webmap */
|
351
|
+
applicationProperties?: IApplicationProperties;
|
352
|
+
/** String value indicating the application which authored the webmap */
|
353
|
+
authoringApp?: string;
|
354
|
+
/** String value indicating the authoring App's version number */
|
355
|
+
authoringAppVersion?: string;
|
356
|
+
/** Defines the appearance for the background of the map. */
|
357
|
+
background?: IWebMapBackground;
|
358
|
+
/** [Required] Basemaps give the web map a geographic context */
|
359
|
+
baseMap: IBaseMap;
|
360
|
+
/** A bookmark is a saved geographic extent that allows end users to quickly navigate to a particular area of interest */
|
361
|
+
bookmarks?: IBookmark[];
|
362
|
+
/** Map Range Information */
|
363
|
+
mapRangeInfo?: IMapRangeInfo;
|
364
|
+
/** Operational layers contain business data which are used to make thematic maps */
|
365
|
+
operationalLayers?: ILayer[];
|
366
|
+
/** A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc */
|
367
|
+
presentation?: any;
|
368
|
+
/** [Required] An object used to specify the spatial reference of the given geometry. */
|
369
|
+
spatialReference: ISpatialReference;
|
370
|
+
/** Root element in the web map specifying an array of table objects. (optional) */
|
371
|
+
tables?: ITable[];
|
372
|
+
/** [Required] Root element in the web map specifying a string value indicating the web map version. */
|
373
|
+
version: string;
|
374
|
+
/** The widgets object contains widgets that should be exposed to the user */
|
375
|
+
widgets?: any;
|
376
|
+
}
|
377
|
+
|
378
|
+
/**
|
379
|
+
* Range object.
|
380
|
+
* @see https://developers.arcgis.com/web-map-specification/objects/range/
|
381
|
+
*/
|
382
|
+
export interface IRange {
|
383
|
+
/** Indicates the mode in which the active range should be presented to the user. Must be one of the following values: slider, picker */
|
384
|
+
interactionMode?: "slider" | "picker";
|
385
|
+
|
386
|
+
/** This is used to generate the activeRangeValues if activeRangeValues are not specified. */
|
387
|
+
numberOfStops?: any;
|
388
|
+
/** Interval in which stops should be generated. */
|
389
|
+
stopInterval?: number;
|
390
|
+
}
|
391
|
+
|
392
|
+
/**
|
393
|
+
* The widgets object contains widgets that should be exposed to the user.
|
394
|
+
*/
|
395
|
+
export interface IWidget {
|
396
|
+
/** Active range. */
|
397
|
+
range?: IRange;
|
398
|
+
/** Time animation is controlled by a configurable time slider. The time slider widget will act upon all the time aware layers in the map. */
|
399
|
+
timeSlider?: ITimeSliderProperties;
|
400
|
+
}
|
401
|
+
|
402
|
+
/**
|
403
|
+
* Configurable properties used within the TimeSlider widget.
|
404
|
+
*/
|
405
|
+
export interface ITimeSliderProperties {
|
406
|
+
/** An optional array of numbers indicating the slider's start to end time extent. */
|
407
|
+
currentTimeExtent?: number[];
|
408
|
+
/** The optional end of the time slider. If not specified, the slider defaults to the full time extent of all time-enabled layers. */
|
409
|
+
endTime?: number;
|
410
|
+
/** Number of stops within the timeSlider widget. */
|
411
|
+
numberOfStops?: number;
|
412
|
+
/** The optional start of the time slider. If not specified, the slider defaults to the full time extent of all time-enabled layers. */
|
413
|
+
startTime?: number;
|
414
|
+
/** The default value for the thumbCount is 1. */
|
415
|
+
thumbCount?: number;
|
416
|
+
/** Rate at which the time animation plays. Units are in milliseconds. Default is 1000. */
|
417
|
+
thumbMovingRate?: number;
|
418
|
+
/** The interval which has been defined for the time slider. */
|
419
|
+
timeStopInterval?: number;
|
420
|
+
}
|
421
|
+
|
422
|
+
/**
|
423
|
+
* Time animation is controlled by a configurable time slider. Those configurations are saved to the web map as a timeSlider widget.
|
424
|
+
*/
|
425
|
+
export interface ITimeSlider {
|
426
|
+
/**
|
427
|
+
* Configurable properties used within the TimeSlider widget.
|
428
|
+
*/
|
429
|
+
properties: ITimeSliderProperties;
|
430
|
+
}
|
431
|
+
|
432
|
+
/**
|
433
|
+
* The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions.
|
434
|
+
*/
|
435
|
+
export interface IApplicationProperties {
|
436
|
+
/** If locationTracking is set and enabled, the Collector application will update the feature service at the defined interval with the current location of the user logged into the Collector app. */
|
437
|
+
editing?: IEditingProperties | null;
|
438
|
+
/** Use if working with offline maps. */
|
439
|
+
offline?: IOfflineInfo | null;
|
440
|
+
/** An object containing all the viewing properties of the web map. If this is null or not defined, the client should assume a logical default. */
|
441
|
+
viewing?: IViewingInfo | null;
|
442
|
+
}
|
443
|
+
|
444
|
+
/**
|
445
|
+
* An object containing all the editing properties within the web map.
|
446
|
+
*/
|
447
|
+
export interface IEditingProperties {
|
448
|
+
/**
|
449
|
+
* If locationTracking is set and enabled, the collector app will update the feature service at the defined interval with the current location of the user logged into the collector application.
|
450
|
+
*/
|
451
|
+
locationTracking: ILocationTracking;
|
452
|
+
}
|
453
|
+
|
454
|
+
/**
|
455
|
+
* If locationTracking is set and enabled, the collector app will update the feature service at the defined interval with the current location of the user logged into the collector application.
|
456
|
+
*/
|
457
|
+
export interface ILocationTracking {
|
458
|
+
/** A boolean value indicating whether or not location tracking is enabled on the webmap. */
|
459
|
+
enabled: boolean;
|
460
|
+
/** An object of additional information specifying layer and update interval time. */
|
461
|
+
info: ILocationTrackingInfo;
|
462
|
+
}
|
463
|
+
|
464
|
+
/**
|
465
|
+
* An object containing additional information specifying layer and update interval time used in the locationTracking object.
|
466
|
+
*/
|
467
|
+
export interface ILocationTrackingInfo {
|
468
|
+
/** A string value indicating the given layer id specified in the web map. */
|
469
|
+
layerId: any;
|
470
|
+
/** A numeric value indicating the time interval used to update the feature service. Default value is 300 seconds. */
|
471
|
+
updateInterval?: any;
|
472
|
+
}
|
473
|
+
|
474
|
+
/**
|
475
|
+
* Use if working with offline maps.
|
476
|
+
*/
|
477
|
+
export interface IOfflineInfo {
|
478
|
+
/** Object detailing the available offline editing options. */
|
479
|
+
editableLayers: IEditableLayers;
|
480
|
+
/** Object indicating what to do with attachments in read-only layers. */
|
481
|
+
readonlyLayers: IReadOnlyLayers;
|
482
|
+
}
|
483
|
+
|
484
|
+
/**
|
485
|
+
* Object detailing the available offline editing options.
|
486
|
+
*/
|
487
|
+
export interface IEditableLayers {
|
488
|
+
/**
|
489
|
+
* When editing layers, the edits are always sent to the server. This string value indicates which data is retrieved.
|
490
|
+
* For example, none indicates that only the schema is written since neither the features nor attachments are retrieved.
|
491
|
+
* For a full sync without downloading attachments, indicate features. Lastly, the default behavior is to have a full
|
492
|
+
* sync using featuresAndAttachments where both features and attachments are retrieved.
|
493
|
+
*/
|
494
|
+
download: "none" | "featuresAndAttachments" | "featuers";
|
495
|
+
/** This string value indicates how the data is synced. */
|
496
|
+
sync:
|
497
|
+
| "uploadFeaturesAndAttachments"
|
498
|
+
| "syncFeaturesAndAttachments"
|
499
|
+
| "syncFeaturesUploadAttachments";
|
500
|
+
}
|
501
|
+
|
502
|
+
/**
|
503
|
+
* Read-only layers as the features are always retrieved from the server.
|
504
|
+
*/
|
505
|
+
export interface IReadOnlyLayers {
|
506
|
+
/** Indicates whether to include attachments with the read-only data. */
|
507
|
+
downloadAttachments: boolean;
|
508
|
+
}
|
509
|
+
|
510
|
+
export interface IEnableable {
|
511
|
+
enabled: boolean;
|
512
|
+
}
|
513
|
+
|
514
|
+
/**
|
515
|
+
* An object specifying the search parameters set within the web map.
|
516
|
+
*/
|
517
|
+
export interface ISearch extends IEnableable {
|
518
|
+
/** A boolean value indicating whether or not to disable the place finder. */
|
519
|
+
disablePlaceFinder?: any;
|
520
|
+
/** A string value used to indicate the hint provided with the search dialog. */
|
521
|
+
hintText?: any;
|
522
|
+
/** An array of layer objects defining the styling, geometry, and attribute information for the features. */
|
523
|
+
layers?: any;
|
524
|
+
}
|
525
|
+
|
526
|
+
/**
|
527
|
+
* An object containing all the viewing properties of the web map. If this is null or not defined, the client should assume a logical default.
|
528
|
+
*/
|
529
|
+
export interface IViewingInfo {
|
530
|
+
/** The basemap tool which will use the basemap group defined in the Portal. */
|
531
|
+
basemapGallery?: IEnableable;
|
532
|
+
/** Measure tool. */
|
533
|
+
measure?: IEnableable;
|
534
|
+
/** The route tool which will leverage the Portals defined route service. */
|
535
|
+
routing?: IEnableable;
|
536
|
+
/** An object specifying search parameters within the webmap. */
|
537
|
+
search?: ISearch;
|
538
|
+
}
|
539
|
+
|
540
|
+
/**
|
541
|
+
* A basemap layer is a layer that provides geographic context to the map. A web map always contains a basemap.
|
542
|
+
* The basemap has a title and is the combination of each baseMapLayer.
|
543
|
+
* It is required that a baseMap be saved within the web map.
|
544
|
+
*/
|
545
|
+
export interface IBaseMap {
|
546
|
+
/** An array of baseMapLayer objects defining the basemaps used in the web map. */
|
547
|
+
baseMapLayers: ILayer[];
|
548
|
+
/** Required string title for the basemap that can be used in a table of contents. It takes the title of the first baseMapLayer in the array. */
|
549
|
+
title: string;
|
550
|
+
}
|
551
|
+
|
552
|
+
export interface ILayer {
|
553
|
+
/** A unique identifying string for the layer. */
|
554
|
+
id: any;
|
555
|
+
/** Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal. */
|
556
|
+
itemId?: string;
|
557
|
+
/** Indicates the layer type */
|
558
|
+
layerType: string;
|
559
|
+
/** Integer property used to determine the maximum scale at which the layer is displayed. */
|
560
|
+
maxScale?: number;
|
561
|
+
/** Integer property used to determine the minimum scale at which the layer is displayed. */
|
562
|
+
minScale?: number;
|
563
|
+
/** The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency. */
|
564
|
+
opacity?: number;
|
565
|
+
/** Boolean property indicating whether to display in the legend. */
|
566
|
+
showLegend?: boolean;
|
567
|
+
/** A user-friendly string title for the layer that can be used in a table of contents. */
|
568
|
+
title?: string;
|
569
|
+
/**
|
570
|
+
* Deprecated, use layerType instead.
|
571
|
+
* @deprecated
|
572
|
+
*/
|
573
|
+
type?: string;
|
574
|
+
/** Boolean property determining whether the layer is initially visible in the web map. */
|
575
|
+
visibility?: boolean;
|
576
|
+
/** The URL to the layer. Not applicable to all layer types. */
|
577
|
+
url?: string;
|
578
|
+
}
|
579
|
+
|
580
|
+
export interface ISupportsTime {
|
581
|
+
/** This property is applicable to layers that support time. If 'true', timeAnimation is enabled. */
|
582
|
+
timeAnimation?: boolean;
|
583
|
+
}
|
584
|
+
|
585
|
+
export interface IBingLayer extends ILayer {
|
586
|
+
/** String value that unlocks the use of Bing layers in a web map. */
|
587
|
+
bingKey?: string;
|
588
|
+
/** Boolean value indicating whether the Bing key can be shared to the public. */
|
589
|
+
canShareBingPublic?: boolean;
|
590
|
+
/** String indicating the layer type. */
|
591
|
+
layerType: "BingMapsAerial" | "BingMapsRoad" | "BingMapsHybrid";
|
592
|
+
/** A string value representing the URL to the Portal/organization Self resource. Calls should be made to this property to retrieve the Bing key. If the key is not made accessible to the public or if canShareBingPublic is false, any web maps using Bing layers will not work. */
|
593
|
+
portalUrl?: string;
|
594
|
+
}
|
595
|
+
|
596
|
+
export interface IImageServiceLayer extends ILayer, ISupportsTime {
|
597
|
+
/** An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service). */
|
598
|
+
bandIds?: number[];
|
599
|
+
/** Controls how much loss the image will be subjected to by the compression algorithm (from image service). */
|
600
|
+
compressionQuality?: any;
|
601
|
+
/** Stores interactive filters. */
|
602
|
+
definitionEditor?: any;
|
603
|
+
/** Boolean property indicating whether to ignore popups defined by the service item. */
|
604
|
+
disablePopup?: boolean;
|
605
|
+
/** String value representing image format. */
|
606
|
+
format?:
|
607
|
+
| "jpgpng"
|
608
|
+
| "png"
|
609
|
+
| "png8"
|
610
|
+
| "png24"
|
611
|
+
| "jpg"
|
612
|
+
| "bmp"
|
613
|
+
| "gif"
|
614
|
+
| "tiff"
|
615
|
+
| "png32";
|
616
|
+
|
617
|
+
/** The algorithm used for interpolation. */
|
618
|
+
interpolation?:
|
619
|
+
| "RSP_BilinearInterpolation"
|
620
|
+
| "RSP_CubicConvolution"
|
621
|
+
| "RSP_Majority"
|
622
|
+
| "RSP_NearestNeighbor";
|
623
|
+
|
624
|
+
/** This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
625
|
+
isReference?: boolean;
|
626
|
+
/** A layerDefinition object defining the attribute schema and drawing information for the layer. */
|
627
|
+
layerDefinition?: any;
|
628
|
+
/** String indicating the layer type. Value of this property must be ArcGISImageServiceLayer */
|
629
|
+
layerType: "ArcGISImageServiceLayer";
|
630
|
+
/** Specifies the mosaic rule when defining how individual images should be mosaicked. */
|
631
|
+
mosaicRule?: any;
|
632
|
+
/** The pixel value that represents no information. */
|
633
|
+
noData?: any;
|
634
|
+
/** A string value of interpretation of noData setting. Default is 'esriNoDataMatchAny' when noData is a number, and 'esriNoDataMatchAll' when noData is an array. */
|
635
|
+
noDataInterpretation?: "esriNoDataMatchAny" | "esriNoDataMatchAll";
|
636
|
+
/** Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. */
|
637
|
+
pixelType?:
|
638
|
+
| "C128"
|
639
|
+
| "C64"
|
640
|
+
| "F32"
|
641
|
+
| "F64"
|
642
|
+
| "S16"
|
643
|
+
| "S32"
|
644
|
+
| "S8"
|
645
|
+
| "U1"
|
646
|
+
| "U16"
|
647
|
+
| "U2"
|
648
|
+
| "U32"
|
649
|
+
| "U4"
|
650
|
+
| "U8"
|
651
|
+
| "UNKNOWN";
|
652
|
+
|
653
|
+
/** A popupInfo object defining the content of popup windows when you click or query a feature. */
|
654
|
+
popupInfo?: IPopupInfo;
|
655
|
+
/** 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. */
|
656
|
+
refreshInterval?: number;
|
657
|
+
/** Specifies the rendering rule for how the requested image should be rendered. */
|
658
|
+
renderingRule?: any;
|
659
|
+
}
|
660
|
+
|
661
|
+
export interface IImageVectorLayer extends ILayer, ISupportsTime {
|
662
|
+
/** Stores interactive filters. */
|
663
|
+
definitionEditor?: any;
|
664
|
+
/** Boolean property indicating whether to ignore popups defined by the service item. */
|
665
|
+
disablePopup?: any;
|
666
|
+
/** This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
667
|
+
isReference?: boolean;
|
668
|
+
/** A layerDefinition object defining the attribute schema and drawing information for the layer. */
|
669
|
+
layerDefinition?: any;
|
670
|
+
/** String indicating the layer type. Value of this property must be ArcGISImageServiceVectorLayer */
|
671
|
+
layerType: "ArcGISImageServiceVectorLayer";
|
672
|
+
/** Specifies the mosaic rule when defining how individual images should be mosaicked. */
|
673
|
+
mosaicRule?: any;
|
674
|
+
/** A popupInfo object defining the content of popup windows when you click or query a feature. */
|
675
|
+
popupInfo?: IPopupInfo;
|
676
|
+
/** Number describing the size of the tile. */
|
677
|
+
symbolTileSize?: any;
|
678
|
+
}
|
679
|
+
|
680
|
+
export interface IDefinitionParameter {
|
681
|
+
/** The default value that is automatically given if nothing is provided. */
|
682
|
+
defaultValue?: number | string;
|
683
|
+
/** A string value representing the name of the field to query. */
|
684
|
+
fieldName?: string;
|
685
|
+
/** Number given to uniquely identify the specified parameter. */
|
686
|
+
parameterId?: any;
|
687
|
+
/** The field type for the specified field parameter. */
|
688
|
+
type?:
|
689
|
+
| "esriFieldTypeBlob"
|
690
|
+
| "esriFieldTypeDate"
|
691
|
+
| "esriFieldTypeDouble"
|
692
|
+
| "esriFieldTypeGeometry"
|
693
|
+
| "esriFieldTypeGlobalID"
|
694
|
+
| "esriFieldTypeGUID"
|
695
|
+
| "esriFieldTypeInteger"
|
696
|
+
| "esriFieldTypeOID"
|
697
|
+
| "esriFieldTypeRaster"
|
698
|
+
| "esriFieldTypeSingle"
|
699
|
+
| "esriFieldTypeSmallInteger"
|
700
|
+
| "esriFieldTypeString"
|
701
|
+
| "esriFieldTypeXML";
|
702
|
+
|
703
|
+
/** An integer value representing exact UNIX time used when defaultValue is a date string. */
|
704
|
+
utcValue?: number;
|
705
|
+
}
|
706
|
+
|
707
|
+
export interface IDefinitionInput {
|
708
|
+
/** A string value representing a hint for the input. */
|
709
|
+
hint?: string;
|
710
|
+
/** An array of parameter objects. */
|
711
|
+
parameters?: IDefinitionParameter[];
|
712
|
+
/** A string value representing the prompt for the input. */
|
713
|
+
prompt?: string;
|
714
|
+
}
|
715
|
+
|
716
|
+
/**
|
717
|
+
* The definitionEditor stores interactive filters at the same level as layerDefinition.
|
718
|
+
*/
|
719
|
+
export interface IDefinitionEditor {
|
720
|
+
/** An array of input objects. */
|
721
|
+
inputs?: IDefinitionInput[];
|
722
|
+
/** A string value representing the where clause for the interactive filter. */
|
723
|
+
parameterizedExpression?: string;
|
724
|
+
}
|
725
|
+
|
726
|
+
/**
|
727
|
+
* A layer object may allow overrides on popup content and drawing behavior for individual layers of a web service.
|
728
|
+
* This object also contains geographic features and their attributes when used in a feature collection.
|
729
|
+
*/
|
730
|
+
export interface IChildLayer {
|
731
|
+
/** Default visibility of the layers in the map service. */
|
732
|
+
defaultVisibility?: any;
|
733
|
+
/** An object that provides interactive filters. */
|
734
|
+
definitionEditor?: IDefinitionEditor;
|
735
|
+
/** A featureSet object containing the geometry and attributes of the features in the layer. Used with feature collections only. */
|
736
|
+
featureSet?: IFeatureSet;
|
737
|
+
/** Information about each field in a layer. Used with feature collections. */
|
738
|
+
field?: IField[];
|
739
|
+
/** A string indicating the index position of the layer in the map service or feature collection. */
|
740
|
+
id?: string;
|
741
|
+
/** The layerDefinition object defines the attribute schema and drawing information for the layer. */
|
742
|
+
layerDefinition?: any;
|
743
|
+
/** A string URL to a service that should be used for all queries against the layer. Used with hosted tiled map services on ArcGIS Online when there is an associated feature service that allows for queries. */
|
744
|
+
layerUrl?: any;
|
745
|
+
/** Represents the maximum scale at which the layer definition will be applied. */
|
746
|
+
maxScale?: any;
|
747
|
+
/** Represents the minimum scale at which the layer definition will be applied. */
|
748
|
+
minScale?: any;
|
749
|
+
/** Iterates within a featureset. Number objectId value is incremented +1 based on last Object ID defined for the feature in a featureset. Used with feature collections. */
|
750
|
+
nextObjectId?: any;
|
751
|
+
/** If working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer. */
|
752
|
+
parentLayerId?: any;
|
753
|
+
/** A popupInfo object defining the popup window content for the layer. */
|
754
|
+
popupInfo?: IPopupInfo;
|
755
|
+
/** Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend. */
|
756
|
+
showLegend?: any;
|
757
|
+
/** Array of numeric values indicating the layer index for layers nested directly under the parent layer. */
|
758
|
+
subLayer?: any;
|
759
|
+
/** If the layer is a parent layer, it will have one or more sub layers included in an array. */
|
760
|
+
subLayerIds?: any;
|
761
|
+
/** A user-friendly string title for the layer that can be used in a table of contents. */
|
762
|
+
title?: any;
|
763
|
+
}
|
764
|
+
|
765
|
+
export interface IMapServiceLayer extends ILayer, ISupportsTime {
|
766
|
+
/** This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
767
|
+
isReference?: any;
|
768
|
+
/** String indicating the layer type. */
|
769
|
+
layerType: "ArcGISMapServiceLayer";
|
770
|
+
/** An array of layer objects defining the styling, geometry, and attribute information for the features. */
|
771
|
+
layers?: IChildLayer[];
|
772
|
+
/** 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. */
|
773
|
+
refreshInterval?: number;
|
774
|
+
/** (Optional) A thematicGroup object used in ArcGISMapServiceLayer layers. */
|
775
|
+
thematicGroup?: IThematicGroup;
|
776
|
+
/** An array of sublayer ids that should appear visible. Used with map service layers that are not tiled. */
|
777
|
+
visibleLayers?: number[];
|
778
|
+
}
|
779
|
+
|
780
|
+
export interface IThematicGroup {
|
781
|
+
/** An array of string values indicating all the fields used within the webmap. All other fields can be disregarded and should not display in any field selection list. */
|
782
|
+
fieldNames?: string[];
|
783
|
+
/** A zero-based array of integers indicating the layers to be used in the webmap. NOTE: All other layers should not be added to the TOC and may or may not be visible on the map as reference layers. */
|
784
|
+
layerIds?: number[];
|
785
|
+
/** String property indicating the name for the thematic grouping of layers. */
|
786
|
+
name?: string;
|
787
|
+
}
|
788
|
+
|
789
|
+
export interface IDrawingInfo {
|
790
|
+
/** Only used for feature collections with a renderer. The feature's symbol is defined by the layer's renderer. */
|
791
|
+
fixedSymbols?: any;
|
792
|
+
/** An object defining the properties used for labeling the layer. */
|
793
|
+
labelingInfo?: any;
|
794
|
+
/** An object defined which provides the symbology for the layer. */
|
795
|
+
renderer?: any;
|
796
|
+
/** Boolean property indicating whether symbols should stay the same size in screen units as you zoom in. A value of true means the symbols stay the same size in screen units regardless of the map scale. */
|
797
|
+
scaleSymbols?: any;
|
798
|
+
/** Defines whether labels should be shown or not. This is only valid for sublayers. */
|
799
|
+
showLabels?: boolean;
|
800
|
+
/** Number value ranging between 0 (no transparency) to 100 (completely transparent). */
|
801
|
+
transparency?: number;
|
802
|
+
}
|
803
|
+
|
804
|
+
export interface ILayerDefinition extends IHasZM {
|
805
|
+
/** Boolean value indicating whether the geometry of the features in the layer can be edited. */
|
806
|
+
allowGeometryUpdates?: boolean;
|
807
|
+
/** A comma separated list of supported capabilities, e.g. Query,Editing. */
|
808
|
+
capabilities?: string;
|
809
|
+
/** String value for the copyright text information for the layer. */
|
810
|
+
copyrightText?: string;
|
811
|
+
/** Numeric value indicating the server version of the layer. */
|
812
|
+
currentVersion?: number;
|
813
|
+
/** Boolean value indicating whether the layer's visibility is turned on. */
|
814
|
+
defaultVisibility?: boolean;
|
815
|
+
/** Stores interactive filters. */
|
816
|
+
definitionEditor?: IDefinitionEditor;
|
817
|
+
/** SQL-based definition expression string that narrows the data to be displayed in the layer. */
|
818
|
+
definitionExpression?: string;
|
819
|
+
/** String value of the layer as defined in the map service. */
|
820
|
+
description?: string;
|
821
|
+
/** A string value that summarizes the feature. */
|
822
|
+
displayField?: string;
|
823
|
+
/** Contains drawing, labeling, and transparency information. */
|
824
|
+
drawingInfo?: any;
|
825
|
+
/** An object defining the rectangular area. */
|
826
|
+
extent?: IExtent | null;
|
827
|
+
/** Feature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen. */
|
828
|
+
featureReduction?: any;
|
829
|
+
/** An array of field objects containing information about the attribute fields for the feature collection or layer. */
|
830
|
+
fields?: IField[];
|
831
|
+
/** A string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope. */
|
832
|
+
geometryType?: esriGeometryType;
|
833
|
+
/** The unique identifier for a feature or table row within a geodatabase. */
|
834
|
+
globalIdField?: string;
|
835
|
+
/** Indicates whether attachments should be loaded for the layer. */
|
836
|
+
hasAttachments?: boolean;
|
837
|
+
/** Boolean value indicating whether data changes. True if it does not. */
|
838
|
+
hasStaticData?: boolean;
|
839
|
+
/** String value indicating the HTML popup type. */
|
840
|
+
htmlPopupType?:
|
841
|
+
| "esriServerHTMLPopupTypeNone"
|
842
|
+
| "esriServerHTMLPopupTypeAsURL"
|
843
|
+
| "esriServerHTMLPopupTypeAsHTMLText";
|
844
|
+
|
845
|
+
/** The identifier assigned to the layer. */
|
846
|
+
id?: string;
|
847
|
+
/** Boolean value indicating whether the data is versioned. */
|
848
|
+
isDataVersioned?: boolean;
|
849
|
+
/** Numeric value indicating tbe maximum number of records that will be returned at once for a query. */
|
850
|
+
maxRecordCount?: number;
|
851
|
+
/** Represents the maximum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer. */
|
852
|
+
maxScale?: number;
|
853
|
+
/** Represents the minimum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer. */
|
854
|
+
minScale?: number;
|
855
|
+
/** Contains a unique name for the layer that can be displayed in a legend. */
|
856
|
+
name?: string;
|
857
|
+
/** Indicates the name of the object ID field in the dataset. */
|
858
|
+
objectIdField?: string;
|
859
|
+
/** Dictates whether a client can support having an end user modify symbols on individual features. */
|
860
|
+
overrideSymbols?: boolean;
|
861
|
+
/** Indicates range information */
|
862
|
+
rangeInfos?: any;
|
863
|
+
/** An object indicating the layerDefinition's layer source. */
|
864
|
+
source?: any;
|
865
|
+
/** An object containing the WKID or WKT identifying the spatial reference of the layer's geometry. */
|
866
|
+
spatialReference?: ISpatialReference;
|
867
|
+
/** String value indicating the output formats that are supported in a query. */
|
868
|
+
supportedQueryFormats?: string;
|
869
|
+
/** Boolean value indicating whether the layer supports orderByFields in a query operation. */
|
870
|
+
supportsAdvancedQueries?: boolean;
|
871
|
+
/** Boolean value indicating whether the layer supports uploading attachments with the Uploads operation. This can then be used in the Add Attachment and Update Attachment operations. */
|
872
|
+
supportsAttachmentsByUploadId?: boolean;
|
873
|
+
/** Boolean value indicating whether the layer supports the Calculate REST operation when updating features. */
|
874
|
+
supportsCalculate?: boolean;
|
875
|
+
/** Boolean value indicating whether the layer supports rolling back edits made on a feature layer if some of the edits fail. */
|
876
|
+
supportsRollbackOnFailureParameter?: boolean;
|
877
|
+
/** Boolean value indicating whether feature layer query operations support statistical functions. */
|
878
|
+
supportsStatistics?: boolean;
|
879
|
+
/** Boolean value indicating whether the validateSQL operation is supported across a feature service layer. */
|
880
|
+
supportsValidateSql?: boolean;
|
881
|
+
/** A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types. */
|
882
|
+
templates?: ITemplate;
|
883
|
+
/** The time info metadata of the layer. May be set for feature layers inside a feature collection item. */
|
884
|
+
timeInfo?: any;
|
885
|
+
/** Indicates whether the layerDefinition applies to a Feature Layer or a Table. */
|
886
|
+
type?: "Feature Layer" | "Table";
|
887
|
+
/** Contains the name of the field holding the type ID for the features. */
|
888
|
+
typeIdField?: string;
|
889
|
+
/** Contains information about an attribute field. */
|
890
|
+
types?: any;
|
891
|
+
/** String value indicating the attribute field that is used to control the visibility of a feature.
|
892
|
+
* If applicable, when rendering a feature the client should use this field to control visibility.
|
893
|
+
* The field's values are 0 = do not display, 1 = display.
|
894
|
+
*/
|
895
|
+
visibilityField?: string;
|
896
|
+
}
|
897
|
+
|
898
|
+
export interface ITypeInfoDomain {
|
899
|
+
type: string | "inherited";
|
900
|
+
}
|
901
|
+
|
902
|
+
export type FeatureEditTool =
|
903
|
+
| "esriFeatureEditToolAutoCompletePolygon"
|
904
|
+
| "esriFeatureEditToolPolygon"
|
905
|
+
| "esriFeatureEditToolTriangle"
|
906
|
+
| "esriFeatureEditToolRectangle"
|
907
|
+
| "esriFeatureEditToolLeftArrow"
|
908
|
+
| "esriFeatureEditToolRightArrow"
|
909
|
+
| "esriFeatureEditToolEllipse"
|
910
|
+
| "esriFeatureEditToolUpArrow"
|
911
|
+
| "esriFeatureEditToolDownArrow"
|
912
|
+
| "esriFeatureEditToolCircle"
|
913
|
+
| "esriFeatureEditToolFreehand"
|
914
|
+
| "esriFeatureEditToolLine"
|
915
|
+
| "esriFeatureEditToolNone"
|
916
|
+
| "esriFeatureEditToolText"
|
917
|
+
| "esriFeatureEditToolPoint";
|
918
|
+
|
919
|
+
/**
|
920
|
+
* Templates describe features that can be created in a layer. They are generally used with feature collections and editable web-based CSV layers.
|
921
|
+
* Templates are not used with ArcGIS feature services as these already have templates defined in the service. They are also defined as properties
|
922
|
+
* of the layer definition when there are no defined types. Otherwise, templates are defined as properties of the types.
|
923
|
+
*/
|
924
|
+
export interface ITemplate {
|
925
|
+
/** A string value containing a detailed description of the template. */
|
926
|
+
description?: any;
|
927
|
+
/**
|
928
|
+
* An optional string that can define a client-side drawing tool to be used with this feature. For example, map notes used by the Online Map Viewer use this to represent the viewer's different drawing tools.
|
929
|
+
*/
|
930
|
+
drawingTool?: FeatureEditTool;
|
931
|
+
/** A string containing a user-friendly name for the template. */
|
932
|
+
name?: string;
|
933
|
+
/** A feature object representing a prototypical feature for the template. */
|
934
|
+
prototype?: IFeature;
|
935
|
+
}
|
936
|
+
|
937
|
+
export interface ITypeInfo {
|
938
|
+
/** A comma-delimited series of domain objects for each domain in the type. */
|
939
|
+
domains?: {
|
940
|
+
[domain: string]: ITypeInfoDomain;
|
941
|
+
};
|
942
|
+
/** A unique string or numerical ID for the type. */
|
943
|
+
id?: string | number;
|
944
|
+
/** A user-friendly name for the type. */
|
945
|
+
name?: string;
|
946
|
+
/** Defined as a property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types. */
|
947
|
+
templates?: ITemplate[];
|
948
|
+
}
|
949
|
+
|
950
|
+
/**
|
951
|
+
* Allows use of OpenStreetMap data for use in basemaps only.
|
952
|
+
*/
|
953
|
+
export interface IOpenStreetMapLayer extends ILayer {
|
954
|
+
/** String indicating the layer type. Value of this property must be OpenStreetMap */
|
955
|
+
layerType: "OpenStreetMap";
|
956
|
+
/**
|
957
|
+
* @deprecated
|
958
|
+
*/
|
959
|
+
type?: "OpenStreetMap";
|
960
|
+
}
|
961
|
+
|
962
|
+
export interface ITiledImageServiceLayer extends ILayer {
|
963
|
+
/** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
964
|
+
isReference?: boolean;
|
965
|
+
/** String indicating the layer type. Value of this property must be ArcGISTiledImageServiceLayer */
|
966
|
+
layerType: "ArcGISTiledImageServiceLayer";
|
967
|
+
/** 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. */
|
968
|
+
refreshInterval?: number;
|
969
|
+
}
|
970
|
+
|
971
|
+
/**
|
972
|
+
* Exclusion areas define extent areas where no data will be fetched for a layer.
|
973
|
+
*/
|
974
|
+
export interface IExclusionArea {
|
975
|
+
/** The geometry defining the area where no data will be fetched. Only extent is supported. */
|
976
|
+
geometry?: IGeometry;
|
977
|
+
/** The zoom level where the exclusion ends. */
|
978
|
+
maxScale?: number;
|
979
|
+
/** The zoom level where the exclusion ends. */
|
980
|
+
maxZoom?: number;
|
981
|
+
/** The zoom level where the exclusion starts. */
|
982
|
+
minScale?: number;
|
983
|
+
/** The zoom level where the exclusion starts. */
|
984
|
+
minZoom?: number;
|
985
|
+
}
|
986
|
+
|
987
|
+
/**
|
988
|
+
* An ArcGIS Tiled Map Service layer displays map content from an ArcGIS Server Map service that has been cached (tiled).
|
989
|
+
*/
|
990
|
+
export interface ITiledMapServiceLayer extends ILayer {
|
991
|
+
/**
|
992
|
+
* NOTE: Applicable if used as a baseMapLayer. Integer value(s) indicating the display levels of the basemap layer.
|
993
|
+
* Only applicable for TiledMapService layers. All tiled map service layers should share the same tiling scheme.
|
994
|
+
* This property cannot be set via the Map Viewer UI.
|
995
|
+
*/
|
996
|
+
displayLevels?: number | number[];
|
997
|
+
/**
|
998
|
+
* NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions.
|
999
|
+
*/
|
1000
|
+
exclusionAreas?: IExclusionArea[];
|
1001
|
+
/** This property is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
1002
|
+
isReference?: any;
|
1003
|
+
/** Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal. */
|
1004
|
+
itemId?: any;
|
1005
|
+
/** String indicating the layer type. */
|
1006
|
+
layerType: "ArcGISTiledMapServiceLayer";
|
1007
|
+
/** An array of layer objects defining a URL for queries and the popup window content. */
|
1008
|
+
layers?: IChildLayer[];
|
1009
|
+
/** 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. */
|
1010
|
+
refreshInterval?: number;
|
1011
|
+
}
|
1012
|
+
|
1013
|
+
/**
|
1014
|
+
* A vector tile layer references a set of web-accessible vector tiles and the corresponding style for how those tiles should be drawn.
|
1015
|
+
*/
|
1016
|
+
export interface IVectorTileLayer extends ILayer {
|
1017
|
+
/** String indicating the layer type. */
|
1018
|
+
layerType: "VectorTileLayer";
|
1019
|
+
/** A url to a JSON file containing the stylesheet information used to render the layer. You may also pass an object containing the stylesheet information identical to the JSON file. */
|
1020
|
+
styleUrl?: string;
|
1021
|
+
/** Deprecated. User layerType instead. */
|
1022
|
+
type?: "VectorTileLayer";
|
1023
|
+
}
|
1024
|
+
|
1025
|
+
export interface ILod {
|
1026
|
+
/** ID for each level. */
|
1027
|
+
level?: number;
|
1028
|
+
/** String to be used when constructing URL to access a tile from this LOD. */
|
1029
|
+
levelValue?: string;
|
1030
|
+
/** Resolution in map units of each pixel in a tile for each level. */
|
1031
|
+
resolution?: number;
|
1032
|
+
/** Scale for each level. */
|
1033
|
+
scale?: number;
|
1034
|
+
}
|
1035
|
+
|
1036
|
+
/**
|
1037
|
+
* Tile information, returned from the WMTS OGC Web Service. The tileInfo will contain the spatial reference of the layer.
|
1038
|
+
* tileInfo is the same json representation as the ArcGIS Map/Image service tileInfo except that it may contain a levelValue
|
1039
|
+
* on the lod objects that should be used instead of the level in the templateUrl.
|
1040
|
+
*/
|
1041
|
+
export interface ITileInfo {
|
1042
|
+
/** Requested tile's column. */
|
1043
|
+
cols?: any;
|
1044
|
+
/** Compression quality of the tile. */
|
1045
|
+
compressionQuality?: any;
|
1046
|
+
/** The dpi of the tiling scheme. */
|
1047
|
+
dpi?: any;
|
1048
|
+
/** Image format of the cached tiles. */
|
1049
|
+
format?:
|
1050
|
+
| "jpg"
|
1051
|
+
| "png"
|
1052
|
+
| "png24"
|
1053
|
+
| "png32"
|
1054
|
+
| "png8"
|
1055
|
+
| "pdf"
|
1056
|
+
| "bmp"
|
1057
|
+
| "gif"
|
1058
|
+
| "svg"
|
1059
|
+
| "svgz"
|
1060
|
+
| "emf"
|
1061
|
+
| "ps"
|
1062
|
+
| "mixed"
|
1063
|
+
| "lerc";
|
1064
|
+
|
1065
|
+
/** An array of levels of detail that define the tiling scheme. */
|
1066
|
+
lods?: ILod[];
|
1067
|
+
/** The tiling scheme origin. */
|
1068
|
+
origin?: IPoint;
|
1069
|
+
/** Requested tile's row. */
|
1070
|
+
rows?: any;
|
1071
|
+
/** The spatial reference of the tiling schema. */
|
1072
|
+
spatialReference?: ISpatialReference;
|
1073
|
+
}
|
1074
|
+
|
1075
|
+
/**
|
1076
|
+
* Object defines and provides information about layers in a WMTSLayer service.
|
1077
|
+
*/
|
1078
|
+
export interface IWebMapTileServiceInfo {
|
1079
|
+
/** A sequence of parameters used to append different custom parameters to a WMTS tile request. These parameters are applied to GetTile. The customLayerParameters property takes precedence if customParameters is also present. */
|
1080
|
+
customLayerParameters?: any;
|
1081
|
+
/** A sequence of parameters used to append custom parameters to all WMTS requests. These parameters are applied to GetCapabilities and GetTile. If used with the customLayerParameters property, customParameters will not take precedence. */
|
1082
|
+
customParameters?: any;
|
1083
|
+
/** Identifier for the specific layer used in the WMTS service. Required input by the user. */
|
1084
|
+
layerIdentifier: string;
|
1085
|
+
/** Tiling schema, set by the WMTS service. */
|
1086
|
+
tileMatrixSet?: any;
|
1087
|
+
/** URL to the WMTS web service. Required input by the user. */
|
1088
|
+
url: string;
|
1089
|
+
}
|
1090
|
+
|
1091
|
+
export interface IWebTiledLayer extends ILayer {
|
1092
|
+
/** Attribution to the Web Tiled Layer provider. It is displayed in the attribution on the web map. Input required by the user when the layer is added to the web map. */
|
1093
|
+
copyright?: any;
|
1094
|
+
/** An extent object representing the full extent envelope for the layer. */
|
1095
|
+
fullExtent?: IExtent;
|
1096
|
+
/** This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
|
1097
|
+
isReference?: any;
|
1098
|
+
/** String indicating the layer type. Value of this property must be WebTiledLayer */
|
1099
|
+
layerType: "WebTiledLayer";
|
1100
|
+
/** 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. */
|
1101
|
+
refreshInterval?: any;
|
1102
|
+
/** If subdomains are detected, they must be specified. The map viewer detects if the Web Tiled Layer has subdomains by parsing the templateURL value for {subDomain}. */
|
1103
|
+
subDomains?: any;
|
1104
|
+
/** URL to the Web Tiled Layer. Input required by the user when the layer is added to the web map. The template URL contains a parameterized URL. The URL can contain the following templated parameters: 'level', 'col', 'row', and 'subDomain'. */
|
1105
|
+
templateUrl?: any;
|
1106
|
+
/** Contains the spatial reference and the tiling scheme of the layer. Typically retrieved from a WMTS OGC Web Service. If missing the layer must be in the WGS 1984 Web Mercator (Auxiliary Sphere) tiling scheme. */
|
1107
|
+
tileInfo?: ITileInfo;
|
1108
|
+
/**
|
1109
|
+
* Deprecated, use layerType instead.
|
1110
|
+
* @deprecated
|
1111
|
+
*/
|
1112
|
+
type?: "WebTiledLayer";
|
1113
|
+
/** Object containing information about the chosen WMTS service layer and tiling schema. */
|
1114
|
+
wmtsInfo?: IWebMapTileServiceInfo;
|
1115
|
+
}
|
1116
|
+
|
1117
|
+
/**
|
1118
|
+
* The CSV layer type references a CSV or TXT file from a publically-accessible web server. It then dynamically loads into the map at run time. The CSV layer will maintain a reference to the CSV resource.
|
1119
|
+
*/
|
1120
|
+
export interface ICsvLayer extends ILayer {
|
1121
|
+
/** A string defining the character used to separate columns in a CSV file. */
|
1122
|
+
columnDelimiter?: "," | " " | ";" | "|" | "\t";
|
1123
|
+
/** A layerDefinition object defining the attribute schema and drawing information for the layer. */
|
1124
|
+
layerDefinition?: ILayerDefinition;
|
1125
|
+
/** String indicating the layer type. */
|
1126
|
+
layerType: "CSV";
|
1127
|
+
/** A locationInfo object defining how location information will be retrieved from a CSV file. */
|
1128
|
+
locationInfo?: any;
|
1129
|
+
/** A popupInfo object defining the content of popup windows when you click or query a feature. */
|
1130
|
+
popupInfo?: IPopupInfo;
|
1131
|
+
/** 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. */
|
1132
|
+
refreshInterval?: number;
|
1133
|
+
/** Deprecated, use layerType instead. */
|
1134
|
+
type?: "CSV";
|
1135
|
+
}
|
1136
|
+
|
1137
|
+
/**
|
1138
|
+
* Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object.
|
1139
|
+
* Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if
|
1140
|
+
* you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the
|
1141
|
+
* feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create
|
1142
|
+
* a feature layer based on the supplied definition.
|
1143
|
+
*/
|
1144
|
+
export interface IFeatureLayer extends ILayer, ISupportsTime {
|
1145
|
+
/** A comma-separated string listing which editing operations are allowed on an editable feature service. */
|
1146
|
+
capabilities?: string;
|
1147
|
+
/** Stores interactive filters. */
|
1148
|
+
definitionEditor?: IDefinitionEditor;
|
1149
|
+
/** Indicates whether to allow a client to ignore popups defined by the service item. */
|
1150
|
+
disablePopup?: true;
|
1151
|
+
/** A featureCollection object defining a layer of features whose geometry and attributes are either stored directly within the web map or with an item. Feature Collections can be created from CSVs, shapefiles, GPX, or map notes. */
|
1152
|
+
featureCollection?: any;
|
1153
|
+
/** Indicates the type of features in the feature collection. If featureCollectionType is missing, it means the feature collection is a regular single-layer or multi-layer feature collection. */
|
1154
|
+
featureCollectionType?: "markup" | "notes" | "route";
|
1155
|
+
|
1156
|
+
/** A layerDefinition object defining the attribute schema and drawing information for the layer. */
|
1157
|
+
layerDefinition?: ILayerDefinition;
|
1158
|
+
/** String indicating the layer type. */
|
1159
|
+
layerType: "ArcGISFeatureLayer";
|
1160
|
+
/** 0 is snapshot mode. 1 is on-demand mode. 2 is selection-only mode. Used with ArcGIS feature services and individual layers in ArcGIS map services. */
|
1161
|
+
mode?: 0 | 1 | 2;
|
1162
|
+
/** A popupInfo object defining the content of popup windows when you click or query a feature. */
|
1163
|
+
popupInfo?: IPopupInfo;
|
1164
|
+
/** 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. */
|
1165
|
+
refreshInterval?: number;
|
1166
|
+
/** Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it. This property can get stored in the web map config and in the item/data. */
|
1167
|
+
showLabels?: true;
|
1168
|
+
/** An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections. */
|
1169
|
+
visibleLayers?: number[];
|
1170
|
+
}
|
1171
|
+
|
1172
|
+
export interface IGeoRssLayer extends ILayer {
|
1173
|
+
/** String indicating the layer type. */
|
1174
|
+
layerType: "GeoRSS";
|
1175
|
+
/** Defined by the GeoRSS to JSON request service. If the GeoRSS feed does not have lines, this property is not added to the layer JSON. */
|
1176
|
+
lineSymbol?: ISimpleLineSymbol;
|
1177
|
+
/** Defined by the GeoRSS to JSON request service. If the GeoRSS feed does not have points, this property is not added to the layer JSON. */
|
1178
|
+
pointSymbol?: IPictureMarkerSymbol;
|
1179
|
+
/** Defined by the GeoRSS to JSON request service. If the GeoRSS feed does not have polygons, this property is not added to the layer JSON. */
|
1180
|
+
polygonSymbol?: ISimpleFillSymbol;
|
1181
|
+
/** 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. */
|
1182
|
+
refreshInterval?: number;
|
1183
|
+
/**
|
1184
|
+
* Deprecated, please use layerType.
|
1185
|
+
* @deprecated
|
1186
|
+
*/
|
1187
|
+
type?: "GeoRSS";
|
1188
|
+
}
|
1189
|
+
|
1190
|
+
export interface IKmlLayer extends ILayer {
|
1191
|
+
/** String indicating the layer type. */
|
1192
|
+
layerType: "KML";
|
1193
|
+
/** A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator. */
|
1194
|
+
maxScale?: any;
|
1195
|
+
/** A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator. */
|
1196
|
+
minScale?: any;
|
1197
|
+
/** The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency. */
|
1198
|
+
opacity?: any;
|
1199
|
+
/** 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. */
|
1200
|
+
refreshInterval?: any;
|
1201
|
+
/** Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend. */
|
1202
|
+
showLegend?: any;
|
1203
|
+
/** A user-friendly string title for the layer that can be used in a table of contents. */
|
1204
|
+
title?: any;
|
1205
|
+
/**
|
1206
|
+
* @deprecated
|
1207
|
+
* Use layerType instead.
|
1208
|
+
*/
|
1209
|
+
type?: "KML";
|
1210
|
+
/** Array of numeric IDs of folders that will be made visible. */
|
1211
|
+
visibleFolders?: number[];
|
1212
|
+
}
|
1213
|
+
|
1214
|
+
export interface IArcGisStreamLayer extends ILayer {
|
1215
|
+
/** Stores interactive filters. */
|
1216
|
+
definitionEditor?: IDefinitionEditor;
|
1217
|
+
/** Indicates whether to ignore popups defined by the service item. */
|
1218
|
+
disablePopup?: boolean;
|
1219
|
+
/** A layerDefinition object defining the attribute schema and drawing information for the layer. */
|
1220
|
+
layerDefinition?: ILayerDefinition;
|
1221
|
+
/** String indicating the layer type. */
|
1222
|
+
layerType: "ArcGISStreamLayer";
|
1223
|
+
/** A popupInfo object defining the content of pop-up windows when you click or query a feature. */
|
1224
|
+
popupInfo?: IPopupInfo;
|
1225
|
+
}
|