Charts Interfaces

CalculatedMinMaxBoundsPayload

Represents a subset of the event payload carrying the chart's axes bounds. See event arcgisChartsAxesMinMaxChange.

Property	Type	Description
isSecondValueAxis?	`boolean`
isXAxis	`boolean`
maximum	`undefined` \| `null` \| `number`
minimum	`undefined` \| `null` \| `number`

CategoryFormatOptions

Defines how the category axis data (Categories) should be formatted.

Property	Type	Description
characterLimit?	`null` \| `number`	Represents a positive integer which represents the limit on the number of characters to be displayed for all the category strings. The truncated string are appended with `...`. If property is not present or `null`, no truncation is done.
type	`"category"`	Represents a unique string identifier for the CategoryFormatOptions object. For CategoryFormatOptions object, it is "category". It can help us to differentiate category axis from other types of axes, viz., date-time axis and numeric (value) axis.

ChartDeletePayload

Represents the payload of the event sent when a chart is removed from the chart list (component arcgis-charts-config-view-charts).

Property	Type	Description
chartId	`string`

DateTimeFormatOptions

Defines how the DateTime axis data should be formatted.

Property	Type	Description
formatPerDateTimeUnit?	`WebChartDateTimeUnitFormatOptions`	Represents how to format specific date and time units when displayed on the axis, independently from the `intlOptions`.
intlOptions	`DateTimeFormatOptions`	Represent the JS native Intl.DateTimeFormatOptions, which is based on CLDR specifications.
type	`"date"`	Represents a unique string identifier for the NumberFormatOptions object. For NumberFormatOptions object, it is "date". It can help us to differentiate date-time axis from other types of axes viz., numeric (value) axis and category axis.

HistogramOverlays

Object containing Histogram overlays

Property	Type	Description
comparisonDistribution?	`WebChartOverlay`	Specifies the comparison distribution overlay for histogram. If not provided, the comparison distribution overlay is not displayed.
mean?	`WebChartOverlay`	Specifies the mean overlay for histogram. If not provided, the mean overlay is not displayed.
median?	`WebChartOverlay`	Specifies the median overlay for histogram. If not provided, the median overlay is not displayed.
standardDeviation?	`WebChartOverlay`	Specifies the standard deviation overlay for histogram. If not provided, the standard deviation overlay is not displayed.
type	`"chartOverlays"`	Represents a unique string identifier for the HistogramOverlays object. For HistogramOverlays object, it is "chartOverlays".

IApplicationProperties

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.

Property	Type	Description
editing?	`null` \| `IEditingProperties`	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.
offline?	`null` \| `IOfflineInfo`	Use if working with offline maps.
viewing?	`null` \| `IViewingInfo`	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.

IArc

an arc can be represented as a JSON curve object

Property	Type	Description
a	[`Position`, `Position2D`, `number`, `number`, `number`, `number`, `number`]

IArcGisStreamLayer

Property	Type	Description
definitionEditor?	`IDefinitionEditor`	Stores interactive filters.
disablePopup?	`boolean`	Indicates whether to ignore popups defined by the service item.
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition?	`ILayerDefinition`	A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType	`"ArcGISStreamLayer"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo?	`IPopupInfo`	A popupInfo object defining the content of pop-up windows when you click or query a feature.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IBaseMap

A basemap layer is a layer that provides geographic context to the map. A web map always contains a basemap. The basemap has a title and is the combination of each baseMapLayer. It is required that a baseMap be saved within the web map.

Property	Type	Description
baseMapLayers	`ILayer`[]	An array of baseMapLayer objects defining the basemaps used in the web map.
title	`string`	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.

IBezierCurve

a bezier curve can be represented as a JSON curve object

Property	Type	Description
b	[`Position`, `Position2D`, `Position2D`]

IBingLayer

Property	Type	Description
bingKey?	`string`	String value that unlocks the use of Bing layers in a web map.
canShareBingPublic?	`boolean`	Boolean value indicating whether the Bing key can be shared to the public.
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"BingMapsAerial"` \| `"BingMapsHybrid"` \| `"BingMapsRoad"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
portalUrl?	`string`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IBookmark

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.

Property	Type	Description
extent	`IExtent`	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.
name	`string`	A string name for the bookmark.

IChildLayer

A layer object may allow overrides on popup content and drawing behavior for individual layers of a web service. This object also contains geographic features and their attributes when used in a feature collection.

Property	Type	Description
defaultVisibility?	`any`	Default visibility of the layers in the map service.
definitionEditor?	`IDefinitionEditor`	An object that provides interactive filters.
featureSet?	`IFeatureSet`	A featureSet object containing the geometry and attributes of the features in the layer. Used with feature collections only.
field?	`IField`[]	Information about each field in a layer. Used with feature collections.
id?	`string`	A string indicating the index position of the layer in the map service or feature collection.
layerDefinition?	`any`	The layerDefinition object defines the attribute schema and drawing information for the layer.
layerUrl?	`any`	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.
maxScale?	`any`	Represents the maximum scale at which the layer definition will be applied.
minScale?	`any`	Represents the minimum scale at which the layer definition will be applied.
nextObjectId?	`any`	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.
parentLayerId?	`any`	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.
popupInfo?	`IPopupInfo`	A popupInfo object defining the popup window content for the layer.
showLegend?	`any`	Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.
subLayer?	`any`	Array of numeric values indicating the layer index for layers nested directly under the parent layer.
subLayerIds?	`any`	If the layer is a parent layer, it will have one or more sub layers included in an array.
title?	`any`	A user-friendly string title for the layer that can be used in a table of contents.

ICircularArc

a circular arc can be represented as a JSON curve object

Property	Type	Description
c	[`Position`, `Position2D`]

ICsvLayer

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.

Property	Type	Description
columnDelimiter?	`" "` \| `","` \| `";"` \| `"\t"` \| `"\|"`	A string defining the character used to separate columns in a CSV file.
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition?	`ILayerDefinition`	A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType	`"CSV"`	String indicating the layer type.
locationInfo?	`any`	A locationInfo object defining how location information will be retrieved from a CSV file.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo?	`IPopupInfo`	A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval?	`number`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"CSV"`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IDefinitionEditor

The definitionEditor stores interactive filters at the same level as layerDefinition.

Property	Type	Description
inputs?	`IDefinitionInput`[]	An array of input objects.
parameterizedExpression?	`string`	A string value representing the where clause for the interactive filter.

IDefinitionInput

Property	Type	Description
hint?	`string`	A string value representing a hint for the input.
parameters?	`IDefinitionParameter`[]	An array of parameter objects.
prompt?	`string`	A string value representing the prompt for the input.

IDefinitionParameter

Property	Type	Description
defaultValue?	`string` \| `number`	The default value that is automatically given if nothing is provided.
fieldName?	`string`	A string value representing the name of the field to query.
parameterId?	`any`	Number given to uniquely identify the specified parameter.
type?	`"esriFieldTypeBlob"` \| `"esriFieldTypeDate"` \| `"esriFieldTypeDateOnly"` \| `"esriFieldTypeDouble"` \| `"esriFieldTypeGeometry"` \| `"esriFieldTypeGlobalID"` \| `"esriFieldTypeGUID"` \| `"esriFieldTypeInteger"` \| `"esriFieldTypeOID"` \| `"esriFieldTypeRaster"` \| `"esriFieldTypeSingle"` \| `"esriFieldTypeSmallInteger"` \| `"esriFieldTypeString"` \| `"esriFieldTypeTimestampOffset"` \| `"esriFieldTypeXML"` \| `"esriFieldTypeTimeOnly"`	The field type for the specified field parameter.
utcValue?	`number`	An integer value representing exact UNIX time used when defaultValue is a date string.

IDrawingInfo

Property	Type	Description
fixedSymbols?	`any`	Only used for feature collections with a renderer. The feature's symbol is defined by the layer's renderer.
labelingInfo?	`any`	An object defining the properties used for labeling the layer.
renderer?	`any`	An object defined which provides the symbology for the layer.
scaleSymbols?	`any`	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.
showLabels?	`boolean`	Defines whether labels should be shown or not. This is only valid for sublayers.
transparency?	`number`	Number value ranging between 0 (no transparency) to 100 (completely transparent).

IEditableLayers

Object detailing the available offline editing options.

Property	Type	Description
download	`"none"` \| `"featuers"` \| `"featuresAndAttachments"`	When editing layers, the edits are always sent to the server. This string value indicates which data is retrieved. For example, none indicates that only the schema is written since neither the features nor attachments are retrieved. For a full sync without downloading attachments, indicate features. Lastly, the default behavior is to have a full sync using featuresAndAttachments where both features and attachments are retrieved.
sync	`"syncFeaturesAndAttachments"` \| `"syncFeaturesUploadAttachments"` \| `"uploadFeaturesAndAttachments"`	This string value indicates how the data is synced.

IEditingInfo

Property	Type	Description
lastEditDate?	`number`	date of last edit to the layer

IEditingProperties

An object containing all the editing properties within the web map.

Property	Type	Description
locationTracking	`ILocationTracking`	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.

IEnableable

Property	Type	Description
enabled	`boolean`

IEnvelope

An envelope is a rectangle defined by a range of values for each coordinate and attribute.

Property	Type	Description
mmax?	`number`
mmin?	`number`
spatialReference?	`ISpatialReference`
xmax	`number`
xmin	`number`
ymax	`number`
ymin	`number`
zmax?	`number`
zmin?	`number`

IExclusionArea

Exclusion areas define extent areas where no data will be fetched for a layer.

Property	Type	Description
geometry?	`IGeometry`	The geometry defining the area where no data will be fetched. Only extent is supported.
maxScale?	`number`	The zoom level where the exclusion ends.
maxZoom?	`number`	The zoom level where the exclusion ends.
minScale?	`number`	The zoom level where the exclusion starts.
minZoom?	`number`	The zoom level where the exclusion starts.

IExtent

Extents are used to define rectangles and bounding boxes.

IExtent can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IExtent }` from "@esri/arcgis-rest-geocoding";
import `{ IExtent }` from "@esri/arcgis-rest-service-admin";
import `{ IExtent }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
spatialReference?	`ISpatialReference`
xmax	`number`
xmin	`number`
ymax	`number`
ymin	`number`
zmax?	`number`
zmin?	`number`

IFeature

a spatial entity and its corresponding properties

IFeature can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IFeature }` from "@esri/arcgis-rest-feature-layer";
import `{ IFeature }` from "@esri/arcgis-rest-routing";

Property	Type	Description
attributes	`Record`
geometry?	`IGeometry`
symbol?	`ISymbol`

IFeatureLayer

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. 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 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 feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create a feature layer based on the supplied definition.

Property	Type	Description
capabilities?	`string`	A comma-separated string listing which editing operations are allowed on an editable feature service.
definitionEditor?	`IDefinitionEditor`	Stores interactive filters.
disablePopup?	`true`	Indicates whether to allow a client to ignore popups defined by the service item.
featureCollection?	`any`	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.
featureCollectionType?	`"markup"` \| `"notes"` \| `"route"`	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.
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition?	`ILayerDefinition`	A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType	`"ArcGISFeatureLayer"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
mode?	`0` \| `2` \| `1`	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.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo?	`IPopupInfo`	A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval?	`number`	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.
showLabels?	`true`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
timeAnimation?	`boolean`	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.
visibleLayers?	`number`[]	An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.

IFeatureServiceDefinition

IFeatureServiceDefinition can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IFeatureServiceDefinition }` from "@esri/arcgis-rest-service-admin";
import `{ IFeatureServiceDefinition }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
advancedEditingCapabilities	`Record`
allowGeometryUpdates	`boolean`	Boolean value indicating whether the geometry of the features in the layer can be edited.
capabilities	`string`	A comma separated list of supported capabilities, e.g. Query,Editing.
copyrightText	`string`	String value for the copyright text information for the layer.
currentVersion?	`number`
description	`string`	String value of the layer as defined in the map service.
documentInfo?	`Record`
editorTrackingInfo	`object`
enableZDefaults?	`boolean`
extractChangesCapabilities	`object`
fullExtent	`IExtent`
hasStaticData?	`boolean`	Boolean value indicating whether data changes. True if it does not.
hasVersionedData	`boolean`
initialExtent	`IExtent`
isLocationTrackingService	`boolean`
isLocationTrackingView	`boolean`
layers	`ILayerDefinition`[]
maxRecordCount	`number`	Numeric value indicating tbe maximum number of records that will be returned at once for a query.
relationships	[`object`]
returnServiceEditsHaveSR?	`boolean`
serviceDescription	`string`
spatialReference	`ISpatialReference`	An object containing the WKID or WKT identifying the spatial reference of the layer's geometry.
supportedQueryFormats	`string`	String value indicating the output formats that are supported in a query.
supportsDisconnectedEditing	`boolean`
supportsRelationshipsResource	`boolean`
supportsReturnDeleteResults	`boolean`
syncCapabilities	`object`
syncEnabled	`boolean`
tables	`ITable`[]
units	`string`
validationSystemLayers	`object`
zDefault?	`number`

IFeatureSet

IFeatureSet can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IFeatureSet }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
displayFieldName?	`string`
features	`IFeature`[]
fieldAliases?	`Record`
fields?	`IField`[]
geometryType?	`GeometryType`
globalIdFieldName?	`string`
hasM?	`boolean`
hasZ?	`boolean`
objectIdFieldName?	`string`
spatialReference?	`ISpatialReference`

IField

Contains information about an attribute field.

IField can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IField }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
alias?	`string`	A string defining the field alias.
defaultValue?	`any`	The value written in for new records by default.
domain?	`IDomain`	The domain objects if applicable.
editable?	`boolean`	A Boolean defining whether this field is editable.
exactMatch?	`boolean`	A Boolean defining whether or not the field is an exact match.
length?	`number`	A number defining how many characters are allowed in a string. field.
name	`string`	A string defining the field name.
nullable?	`boolean`	A Boolean defining whether this field can have a null value.
type	`FieldType`	A string defining the field type.

IFieldFormat

The format object can be used with numerical or date fields to provide more detail about how values should be displayed in popup windows.

Property	Type	Description
dateFormat?	`"dayShortMonthYear"` \| `"longDate"` \| `"longMonthDayYear"` \| `"longMonthYear"` \| `"shortDate"` \| `"shortDateLE"` \| `"shortDateLELongTime"` \| `"shortDateLELongTime24"` \| `"shortDateLEShortTime"` \| `"shortDateLEShortTime24"` \| `"shortDateLongTime"` \| `"shortDateLongTime24"` \| `"shortDateShortTime"` \| `"shortDateShortTime24"` \| `"shortMonthYear"` \| `"year"`	A string used with date fields to specify how the date should appear in popup windows.
digitSeparator?	`boolean`	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. Depending on the locale, this separator is a decimal point or a comma. A value of false means that no separator will be used.
places?	`number`	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.

IFieldInfo

Defines how a field in the dataset participates (or does not participate) in a popup window.

Property	Type	Description
fieldName?	`any`	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/}``.</td></tr> <tr><td>format?</td><td>IFieldFormat`</td><td>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.</td></tr> <tr><td>isEditable?</td><td>`boolean`</td><td>A Boolean determining whether users can edit this field. Not applicable to Arcade expressions.</td></tr> <tr><td>label?</td><td>`string`</td><td>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.</td></tr> <tr><td>stringFieldOption?</td><td>`"richtext"`\|`"textarea"`\|`"textbox"`</td><td>A string determining what type of input box editors see when editing the field. Applies only to string fields. Not applicable to Arcade expressions.</td></tr> <tr><td>tooltip?</td><td>`string`</td><td>A string providing an editing hint for editors of the field. Not applicable to Arcade expressions.</td></tr> <tr><td>visible?</td><td>`boolean`	A Boolean determining whether the field is visible in the popup window.

IFolder

Used for organizing content. See Create Folder for more details.

IFolder can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IFolder }` from "@esri/arcgis-rest-portal";

Property	Type	Description
created?	`number`
id	`string`
title	`string`
username	`string`

IFont

Property	Type	Description
decoration?	`"none"` \| `"line-through"` \| `"underline"`
family?	`string`
size?	`number`
style?	`"italic"` \| `"normal"` \| `"oblique"`
weight?	`"normal"` \| `"bold"` \| `"bolder"` \| `"lighter"`

IGeometry

a building block for discrete geometries

IGeometry can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IGeometry }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
spatialReference?	`ISpatialReference`

IGeoRssLayer

Property	Type	Description
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"GeoRSS"`	String indicating the layer type.
lineSymbol?	`ISimpleLineSymbol`	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.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
pointSymbol?	`IPictureMarkerSymbol`	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.
polygonSymbol?	`ISimpleFillSymbol`	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.
refreshInterval?	`number`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"GeoRSS"`	Deprecated, please use layerType.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IGroup

Existing Portal Group.

IGroup can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IGroup }` from "@esri/arcgis-rest-portal";

Property	Type	Description
access	`"org"` \| `"private"` \| `"public"`
autoJoin	`boolean`
created	`number`
description?	`string`
hasCategorySchema?	`boolean`
id	`string`
isFav	`boolean`
isInvitationOnly	`boolean`
isOpenData?	`boolean`
isViewOnly	`boolean`
modified	`number`
owner	`string`
phone?	`string`
protected	`boolean`
snippet?	`string`
sortField?	`"owner"` \| `"title"` \| `"avgrating"` \| `"created"` \| `"modified"` \| `"numviews"`
sortOrder?	`"asc"` \| `"desc"`
tags	`string`[]
thumbnail?	`string`
title	`string`
userMembership?	`object`

IGroupAdd

A Group that has not been created yet.

IGroupAdd can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IGroupAdd }` from "@esri/arcgis-rest-portal";

Property	Type	Description
access	`"org"` \| `"private"` \| `"public"`
autoJoin?	`boolean`
description?	`string`
isInvitationOnly?	`boolean`
isViewOnly?	`boolean`
owner?	`string`
phone?	`string`
snippet?	`string`
sortField?	`"owner"` \| `"title"` \| `"avgrating"` \| `"created"` \| `"modified"` \| `"numviews"`
sortOrder?	`"asc"` \| `"desc"`
tags?	`string`[]
thumbnail?	`string`
title	`string`

IHasZM

IHasZM can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IHasZM }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
hasM?	`boolean`
hasZ?	`boolean`

IImageServiceLayer

Property	Type	Description
bandIds?	`number`[]	An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service).
compressionQuality?	`any`	Controls how much loss the image will be subjected to by the compression algorithm (from image service).
definitionEditor?	`any`	Stores interactive filters.
disablePopup?	`boolean`	Boolean property indicating whether to ignore popups defined by the service item.
format?	`"bmp"` \| `"gif"` \| `"jpg"` \| `"jpgpng"` \| `"png"` \| `"png8"` \| `"png24"` \| `"png32"` \| `"tiff"`	String value representing image format.
id	`any`	A unique identifying string for the layer.
interpolation?	`"RSP_BilinearInterpolation"` \| `"RSP_CubicConvolution"` \| `"RSP_Majority"` \| `"RSP_NearestNeighbor"`	The algorithm used for interpolation.
isReference?	`boolean`	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).
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition?	`any`	A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType	`"ArcGISImageServiceLayer"`	String indicating the layer type. Value of this property must be ArcGISImageServiceLayer
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
mosaicRule?	`any`	Specifies the mosaic rule when defining how individual images should be mosaicked.
name?	`string`	Layer name
noData?	`any`	The pixel value that represents no information.
noDataInterpretation?	`"esriNoDataMatchAll"` \| `"esriNoDataMatchAny"`	A string value of interpretation of noData setting. Default is 'esriNoDataMatchAny' when noData is a number, and 'esriNoDataMatchAll' when noData is an array.
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
pixelType?	`"C64"` \| `"C128"` \| `"F32"` \| `"F64"` \| `"S8"` \| `"S16"` \| `"S32"` \| `"U1"` \| `"U2"` \| `"U4"` \| `"U8"` \| `"U16"` \| `"U32"` \| `"UNKNOWN"`	Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.
popupInfo?	`IPopupInfo`	A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval?	`number`	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.
renderingRule?	`any`	Specifies the rendering rule for how the requested image should be rendered.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
timeAnimation?	`boolean`	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IImageVectorLayer

Property	Type	Description
definitionEditor?	`any`	Stores interactive filters.
disablePopup?	`any`	Boolean property indicating whether to ignore popups defined by the service item.
id	`any`	A unique identifying string for the layer.
isReference?	`boolean`	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).
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerDefinition?	`any`	A layerDefinition object defining the attribute schema and drawing information for the layer.
layerType	`"ArcGISImageServiceVectorLayer"`	String indicating the layer type. Value of this property must be ArcGISImageServiceVectorLayer
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
mosaicRule?	`any`	Specifies the mosaic rule when defining how individual images should be mosaicked.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo?	`IPopupInfo`	A popupInfo object defining the content of popup windows when you click or query a feature.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
symbolTileSize?	`any`	Number describing the size of the tile.
timeAnimation?	`boolean`	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IItem

Existing Portal Item.

IItem can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IItem }` from "@esri/arcgis-rest-portal";

Property	Type	Description
categories?	`string`[]
created	`number`
culture?	`string`
description?	`string`
documentation?	`string`
extent?	`number`[][]
id	`string`
modified	`number`
numViews	`number`
owner	`string`
properties?	`any`
protected?	`boolean`
size	`number`
snippet?	`string`
spatialReference?	`ISpatialReference`
tags	`string`[]
title	`string`
type	`string`
typeKeywords?	`string`[]
url?	`string`

IItemAdd

A Portal Item that has not been created yet.

IItemAdd can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IItemAdd }` from "@esri/arcgis-rest-portal";

Property	Type	Description
categories?	`string`[]
culture?	`string`
description?	`string`
documentation?	`string`
extent?	`number`[][]
owner?	`string`
properties?	`any`
snippet?	`string`
spatialReference?	`ISpatialReference`
tags?	`string`[]
title	`string`
type	`string`
typeKeywords?	`string`[]
url?	`string`

IItemUpdate

A Portal Item to be updated.

IItemUpdate can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IItemUpdate }` from "@esri/arcgis-rest-portal";

Property	Type	Description
id	`string`

IKmlLayer

Property	Type	Description
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"KML"`	String indicating the layer type.
maxScale?	`any`	A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
minScale?	`any`	A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
name?	`string`	Layer name
opacity?	`any`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval?	`any`	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.
showLegend?	`any`	Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.
title?	`any`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"KML"`
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.
visibleFolders?	`number`[]	Array of numeric IDs of folders that will be made visible.

ILayer

Property	Type	Description
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`string`	Indicates the layer type
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

ILayerDefinition

ILayerDefinition can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ ILayerDefinition }` from "@esri/arcgis-rest-service-admin";
import `{ ILayerDefinition }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
advancedQueryCapabilities?	`object`
allowGeometryUpdates?	`boolean`	Boolean value indicating whether the geometry of the features in the layer can be edited.
allowTrueCurvesUpdates?	`boolean`
archivingInfo?	`object`
capabilities?	`string`	A comma separated list of supported capabilities, e.g. Query,Editing.
copyrightText?	`string`	String value for the copyright text information for the layer.
currentVersion?	`number`	Numeric value indicating the server version of the layer.
dateFieldsTimeReference?	`object`
defaultVisibility?	`boolean`	Boolean value indicating whether the layer's visibility is turned on.
definitionEditor?	`IDefinitionEditor`	Stores interactive filters.
definitionExpression?	`string`	SQL-based definition expression string that narrows the data to be displayed in the layer.
description?	`string`	String value of the layer as defined in the map service.
displayField?	`string`	A string value that summarizes the feature.
drawingInfo?	`any`	Contains drawing, labeling, and transparency information.
editFieldsInfo?	`object`
editingInfo?	`IEditingInfo`	An object defining the editing info (last edit date).
extent?	`null` \| `IExtent`	An object defining the rectangular area.
featureReduction?	`any`	Feature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen.
fields?	`IField`[]	An array of field objects containing information about the attribute fields for the feature collection or layer.
geometryType?	`GeometryType`	A string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope.
globalIdField?	`string`	The unique identifier for a feature or table row within a geodatabase.
hasAttachments?	`boolean`	Indicates whether attachments should be loaded for the layer.
hasM?	`boolean`
hasStaticData?	`boolean`	Boolean value indicating whether data changes. True if it does not.
hasZ?	`boolean`
htmlPopupType?	`"esriServerHTMLPopupTypeAsHTMLText"` \| `"esriServerHTMLPopupTypeAsURL"` \| `"esriServerHTMLPopupTypeNone"`	String value indicating the HTML popup type.
id?	`number`	The identifier assigned to the layer.
indexes?	`any`[]
isDataVersioned?	`boolean`	Boolean value indicating whether the data is versioned.
maxRecordCount?	`number`	Numeric value indicating tbe maximum number of records that will be returned at once for a query.
maxScale?	`number`	Represents the maximum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.
minScale?	`number`	Represents the minimum scale at which the layer definition will be applied. This does not apply to layers of type: ArcGISMapServiceLayer, ImageServiceVectorLayer or ImageServiceLayer.
name?	`string`	Contains a unique name for the layer that can be displayed in a legend.
objectIdField?	`string`	Indicates the name of the object ID field in the dataset.
onlyAllowTrueCurveUpdatesByTrueCurveClients?	`boolean`
overrideSymbols?	`boolean`	Dictates whether a client can support having an end user modify symbols on individual features.
ownershipBasedAccessControlForFeatures?	`boolean`
parentLayerId?	`number`
rangeInfos?	`any`	Indicates range information
relationships?	`any`[]
source?	`any`	An object indicating the layerDefinition's layer source.
spatialReference?	`ISpatialReference`	An object containing the WKID or WKT identifying the spatial reference of the layer's geometry.
subtypeField?	`string`
supportedQueryFormats?	`string`	String value indicating the output formats that are supported in a query.
supportsAdvancedQueries?	`boolean`	Boolean value indicating whether the layer supports orderByFields in a query operation.
supportsApplyEditsWithGlobalIds?	`boolean`
supportsAttachmentsByUploadId?	`boolean`	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.
supportsCalculate?	`boolean`	Boolean value indicating whether the layer supports the Calculate REST operation when updating features.
supportsRollbackOnFailureParameter?	`boolean`	Boolean value indicating whether the layer supports rolling back edits made on a feature layer if some of the edits fail.
supportsStatistics?	`boolean`	Boolean value indicating whether feature layer query operations support statistical functions.
supportsValidateSql?	`boolean`	Boolean value indicating whether the validateSQL operation is supported across a feature service layer.
supportsValidateSQL?	`boolean`
syncCanReturnChanges?	`boolean`
templates?	`ITemplate`[]	A property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.
timeInfo?	`any`	The time info metadata of the layer. May be set for feature layers inside a feature collection item.
type?	`"Feature Layer"` \| `"Table"`	Indicates whether the layerDefinition applies to a Feature Layer or a Table.
typeIdField?	`string`	Contains the name of the field holding the type ID for the features.
types?	`any`	Contains information about an attribute field.
useStandardizedQueries?	`boolean`
visibilityField?	`string`	String value indicating the attribute field that is used to control the visibility of a feature. If applicable, when rendering a feature the client should use this field to control visibility. The field's values are 0 = do not display, 1 = display.

ILocation

ILocation can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ ILocation }` from "@esri/arcgis-rest-routing";
import `{ ILocation }` from "@esri/arcgis-rest-geocoding";

Property	Type	Description
lat?	`number`
latitude?	`number`
long?	`number`
longitude?	`number`
z?	`number`

ILocationTracking

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.

Property	Type	Description
enabled	`boolean`	A boolean value indicating whether or not location tracking is enabled on the webmap.
info	`ILocationTrackingInfo`	An object of additional information specifying layer and update interval time.

ILocationTrackingInfo

An object containing additional information specifying layer and update interval time used in the locationTracking object.

Property	Type	Description
layerId	`any`	A string value indicating the given layer id specified in the web map.
updateInterval?	`any`	A numeric value indicating the time interval used to update the feature service. Default value is 300 seconds.

ILod

Property	Type	Description
level?	`number`	ID for each level.
levelValue?	`string`	String to be used when constructing URL to access a tile from this LOD.
resolution?	`number`	Resolution in map units of each pixel in a tile for each level.
scale?	`number`	Scale for each level.

IMapLocation

Contains location information within a presentation slide.

Property	Type	Description
centerPoint	`IPoint`	The center of the map specified using X/Y coordinates.
spatialReference	`ISpatialReference`	Well-known ID (WKID) or well-known text (WKT).

IMapRangeInfo

Map range information

Property	Type	Description
activeRangeName?	`string`	Active range ID that slider/picker acts upon.
currentRangeExtent?	`number`[]	Current range for the active range.
fullRangeExtent?	`number`[]	Full range extent for the active range to be presented in the UI.

IMapServiceLayer

Property	Type	Description
id	`any`	A unique identifying string for the layer.
isReference?	`any`	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).
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layers?	`IChildLayer`[]	An array of layer objects defining the styling, geometry, and attribute information for the features.
layerType	`"ArcGISMapServiceLayer"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval?	`number`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
thematicGroup?	`IThematicGroup`	(Optional) A thematicGroup object used in ArcGISMapServiceLayer layers.
timeAnimation?	`boolean`	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.
visibleLayers?	`number`[]	An array of sublayer ids that should appear visible. Used with map service layers that are not tiled.

IMarkerSymbol

Property	Type	Description
angle?	`number`
style?	`string`
type	`SymbolType`
xoffset?	`number`
yoffset?	`number`

IMediaInfo

Defines an image or a chart to be displayed in a popup window.

Property	Type	Description
caption?	`any`	A string caption describing the media.
refreshInterval?	`any`	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.
title?	`null` \| `string`	A string title for the media.
type?	`"barchart"` \| `"columnchart"` \| `"image"` \| `"linechart"` \| `"piechart"`	A string defining the type of media.
value?	`null` \| `IMediaInfoValue`	A value object containing information about how the image should be retrieved or how the chart should be constructed.

IMediaInfoValue

The value object contains information for popup windows about how images should be retrieved or charts constructed.

Property	Type	Description
fields?	`string`[]	Used with charts. An array of strings, with each string containing the name of a field to display in the chart.
linkURL?	`string`	Used with images. A string containing a URL to be launched in a browser when a user clicks the image.
normalizeField?	`string`	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.
sourceURL?	`string`	Used with images. A string containing the URL to the image.
tooltipField?	`string`	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.

IMultipoint

A multipoint contains an array of points.

Property	Type	Description
hasM?	`boolean`
hasZ?	`boolean`
points	`Position`[]
spatialReference?	`ISpatialReference`

IOfflineInfo

Use if working with offline maps.

Property	Type	Description
editableLayers	`IEditableLayers`	Object detailing the available offline editing options.
readonlyLayers	`IReadOnlyLayers`	Object indicating what to do with attachments in read-only layers.

IOldCircularArc

Property	Type	Description
a	[`Position`, `Position2D`, `number`, `number`]

IOpenStreetMapLayer

Allows use of OpenStreetMap data for use in basemaps only.

Property	Type	Description
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"OpenStreetMap"`	String indicating the layer type. Value of this property must be OpenStreetMap
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"OpenStreetMap"`
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IOrderByField

Object indicating the field display order for the related records and whether they should be sorted in ascending or descending order.

Property	Type	Description
field?	`string`	The attribute value of the field selected that will drive the sorting of related records.
order?	`"asc"` \| `"desc"`	Set the ascending or descending sort order of the returned related records.

IPagedResponse

Paging properties for paged responses.

IPagedResponse can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IPagedResponse }` from "@esri/arcgis-rest-portal";

Property	Type	Description
nextStart	`number`	next entry index or -1 for the last page
num?	`number`
start?	`number`
total	`number`	total number of object across all pages

IPagingParams

Params for paging operations

IPagingParams can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IPagingParams }` from "@esri/arcgis-rest-portal";

Property	Type	Description
num?	`number`
start?	`number`

IPictureFillSymbol

Property	Type	Description
angle?	`number`
contentType?	`string`
height?	`number`
imageData?	`string`
outline?	`ISimpleLineSymbol`
style?	`string`
type	`"esriPFS"`
url?	`string`
width?	`number`
xoffset?	`number`
xscale?	`number`
yoffset?	`number`
yscale?	`number`

IPictureMarkerSymbol

Property	Type	Description
angle?	`number`
contentType?	`string`
height?	`number`
imageData?	`string`
style?	`string`
type	`"esriPMS"`
url?	`string`
width?	`number`
xoffset?	`number`
yoffset?	`number`

IPictureSourced

Property	Type	Description
angle?	`number`
contentType?	`string`
height?	`number`
imageData?	`string`
url?	`string`
width?	`number`
xoffset?	`number`
yoffset?	`number`

IPoint

A simple point geometry, with spatial reference defined.

IPoint can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IPoint }` from "@esri/arcgis-rest-routing";
import `{ IPoint }` from "@esri/arcgis-rest-geocoding";

Property	Type	Description
hasM?	`boolean`
hasZ?	`boolean`
spatialReference?	`ISpatialReference`
x	`number`
y	`number`
z?	`number`

IPolygon

Property	Type	Description
hasM?	`boolean`
hasZ?	`boolean`
rings	`Position`[][]
spatialReference?	`ISpatialReference`

IPolygonWithCurves

Property	Type	Description
curveRings	`Position` \| `JsonCurve`[][]
hasM?	`boolean`
hasZ?	`boolean`
spatialReference?	`ISpatialReference`

IPolyline

Property	Type	Description
hasM?	`boolean`
hasZ?	`boolean`
paths	`Position`[][]
spatialReference?	`ISpatialReference`

IPolylineWithCurves

Property	Type	Description
curvePaths	`Position` \| `JsonCurve`[][]
hasM?	`boolean`
hasZ?	`boolean`
spatialReference?	`ISpatialReference`

IPopupElement

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 and control the order in which they appear. Specifically, popupElements do the following:

provide the ability to explicitly add a field/ value table in addition to a description,
allow adding multiple description elements, and
allow a user to author and consume elements of a popup in the order of their choosing.

Property	Type	Description
displayType?	`"list"` \| `"preview"`	This property applies to elements of type attachments. A string value indicating how to display the attachment. Possible values are, preview, and list. If list is specified, attachments show as links.
fieldInfos?	`IFieldInfo`[]	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. If the fieldInfos property is not provided, the popupElement will display whatever is specified directly in the popupInfo.fieldInfos property.
mediaInfos?	`IMediaInfo`[]	This property applies to elements of type media. An array of popupInfo.mediaInfo objects representing an image or chart for display. If no mediaInfos property is provided, the popupElement will display whatever is specified in the popupInfo.mediaInfo property.
text?	`string`	This property applies to elements of type text. This is string value indicating the text to be displayed within the popupElement. If no text property is provided, the popupElement will display whatever is specified in the popupInfo.description property.
type?	`"fields"` \| `"attachments"` \| `"media"` \| `"text"`	String value indicating which elements to use.

IPopupExpressionInfo

Arcade expression added to the pop-up.

Property	Type	Description
expression?	`string`	The Arcade expression.
name?	`string`	Unique identifier for the expression.
returnType?	`"string"` \| `"number"`	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.
title?	`string`	Title of the expression.

IPopupInfo

Defines the look and feel of popup windows when a user clicks or queries a feature.

Property	Type	Description
description?	`null` \| `string`	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.
expressionInfos?	`IPopupExpressionInfo`[]	List of Arcade expressions added to the pop-up.
fieldInfos?	`IFieldInfo`[]	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.
layerOptions?	`object`	Additional options that can be defined for the popup layer.
mediaInfos?	`IMediaInfo`[]	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.
popupElements?	`IPopupElement`[]	An array of popupElement objects that represent an ordered list of popup elements.
relatedRecordsInfo?	`IRelatedRecordsInfo`	Indicates whether to enable related records if they exist on a layer.
showAttachments?	`boolean`	Indicates whether attachments will be loaded for feature layers that have attachments.
title?	`string`	A string that appears at the top of the popup window as a title.

IPresentation

Property	Type	Description
displayTimeSlider?	`boolean`	Indicates whether to display the time slider (if accessible).
showLegend?	`boolean`	Indicates whether to display a legend on all slides.
slideAdvancementInterval?	`number`	Number of seconds to show slide before proceeding to the next slide.
slides?	`ISlide`[]	Array of slide objects.
useTimeExtentOfSlide?	`boolean`	Indicates whether to use the time extent (if applicable) of a slide.

IRange

Range object.

Property	Type	Description
interactionMode?	`"picker"` \| `"slider"`	Indicates the mode in which the active range should be presented to the user. Must be one of the following values: slider, picker
numberOfStops?	`any`	This is used to generate the activeRangeValues if activeRangeValues are not specified.
stopInterval?	`number`	Interval in which stops should be generated.

IReadOnlyLayers

Read-only layers as the features are always retrieved from the server.

Property	Type	Description
downloadAttachments	`boolean`	Indicates whether to include attachments with the read-only data.

IRelatedRecordsInfo

The sort in the popupInfo for the parent feature. This impacts the sorting order for the returned child records.

Property	Type	Description
orderByFields?	`IOrderByField`[]	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.
showRelatedRecords	`boolean`	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).

ISearch

An object specifying the search parameters set within the web map.

Property	Type	Description
disablePlaceFinder?	`any`	A boolean value indicating whether or not to disable the place finder.
enabled	`boolean`
hintText?	`any`	A string value used to indicate the hint provided with the search dialog.
layers?	`any`	An array of layer objects defining the styling, geometry, and attribute information for the features.

IServiceInfo

Very generic structure representing the return value from the /arcgis/rest/admin/services/<service-name>/FeatureServer?f=json response

Property	Type	Description
adminServiceInfo	`object`
layers	`Record`[]

IServiceNameAvailable

Response from the portals/Self/isServiceNameAvailable request

Property	Type	Description
available	`boolean`

ISimpleFillSymbol

Property	Type	Description
color?	`Color`
outline?	`ISimpleLineSymbol`
style?	`SimpleFillSymbolStyle`
type	`"esriSFS"`

ISimpleLineSymbol

Property	Type	Description
color?	`Color`
style?	`SimpleLineSymbolStyle`
type	`"esriSLS"`
width?	`number`

ISimpleMarkerSymbol

Property	Type	Description
angle?	`number`
color?	`Color`
outline?	`ISimpleLineSymbol`
size?	`number`
style?	`SimpleMarkerSymbolStyle`
type	`"esriSMS"`
xoffset?	`number`
yoffset?	`number`

ISlide

Property	Type	Description
baseMap?	`IBaseMap`	Basemaps give the web map a geographic context.
extent?	`IExtent`	The standard Esri extent object with spatialReference, xmax, xmin, ymax and ymin.
hidden?	`boolean`	Indicates whether the slide should be hidden within the presentation.
mapLocation?	`IMapLocation`	An object with a centerPoint object and sometimes a resolution.
timeExtent?	[`number`, `number`]	An array of two numbers. The first one indicates start time and the second one indicates end time.
title?	`string`	Title including text and formatting for each slide.
visibleLayers?	`IVisibleLayer`	An array of objects used to indicate layer visibility.
visiblePopup?	`IVisiblePopup`	A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId.

ISpatialReference

Spatial reference systems define mathematical transformations and coordinate systems for displaying spatial information in 2D and 3D.

ISpatialReference can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ ISpatialReference }` from "@esri/arcgis-rest-geocoding";
import `{ ISpatialReference }` from "@esri/arcgis-rest-routing";
import `{ ISpatialReference }` from "@esri/arcgis-rest-service-admin";
import `{ ISpatialReference }` from "@esri/arcgis-rest-feature-layer";

Property	Type	Description
latestVcsWkid?	`number`
latestWkid?	`number`
latestWkt?	`string`
vcsWkid?	`number`
wkid?	`null` \| `number`
wkt?	`null` \| `string`

IStatisticDefinition

Property	Type	Description
onStatisticField	`string`	Field on which to perform the statistical operation.
outStatisticFieldName?	`string`	Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
statisticParameters?	`object`	Parameters to be used along with statisticType. Currently, only applicable for percentile-continuous (continuous percentile) and percentile-discrete (discrete percentile).
statisticType	`"count"` \| `"sum"` \| `"min"` \| `"max"` \| `"avg"` \| `"stddev"` \| `"var"` \| `"percentile-continuous"` \| `"percentile-discrete"` \| `"envelope-aggregate"` \| `"centroid-aggregate"` \| `"convex-hull-aggregate"`	Statistical operation to perform (count, sum, min, max, avg, stddev, var, percentile_cont, percentile_disc, EnvelopeAggregate, CentroidAggregate, ConvexHullAggregate).

ISupportsTime

Property	Type	Description
timeAnimation?	`boolean`	This property is applicable to layers that support time. If 'true', timeAnimation is enabled.

ISymbol

Property	Type	Description
style?	`string`
type	`SymbolType`

ITable

Root element in the web map specifying an array of table objects.

ITable can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ ITable }` from "@esri-arcgis-rest-service-admin"

Property	Type	Description
capabilities?	`string`	A comma-separated string listing which editing operations are allowed on an editable feature service. Available operations include: 'Create', 'Delete', 'Query', 'Update', and 'Editing'.
definitionEditor?	`IDefinitionEditor`	Object indicating the definitionEditor used as a layer's interactive filter.
id?	`number`	Unique identifier for the table.
itemId?	`string`	Unique string value indicating an item registered in ArcGIS Online or your organization's portal.
layerDefinition?	`ILayerDefinition`	A layerDefinition object defining a definition expression for the table.
name?	`string`	Table name
popupInfo?	`IPopupInfo`	An object defining the content of popup windows when you query a record and the sort option for child related records.
title?	`string`	String value for the title of the table.
url?	`string`	String value indicating the URL reference of the hosted table.

ITemplate

Templates describe features that can be created in a layer. They are generally used with feature collections and editable web-based CSV layers. Templates are not used with ArcGIS feature services as these already have templates defined in the service. They are also defined as properties of the layer definition when there are no defined types. Otherwise, templates are defined as properties of the types.

Property	Type	Description
description?	`any`	A string value containing a detailed description of the template.
drawingTool?	`FeatureEditTool`	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.
name?	`string`	A string containing a user-friendly name for the template.
prototype?	`IFeature`	A feature object representing a prototypical feature for the template.

ITextSymbol

Property	Type	Description
angle?	`number`
backgroundColor?	`Color`
borderLineColor?	`Color`
borderLineSize?	`number`
color?	`Color`
font?	`IFont`
haloColor?	`Color`
haloSize?	`number`
horizontalAlignment?	`"left"` \| `"right"` \| `"center"` \| `"justify"`
kerning?	`boolean`
rightToLeft?	`boolean`
style?	`string`
text?	`string`
type	`"esriTS"`
verticalAlignment?	`"top"` \| `"bottom"` \| `"baseline"` \| `"middle"`
xoffset?	`number`
yoffset?	`number`

IThematicGroup

Property	Type	Description
fieldNames?	`string`[]	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.
layerIds?	`number`[]	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.
name?	`string`	String property indicating the name for the thematic grouping of layers.

ITiledImageServiceLayer

Property	Type	Description
id	`any`	A unique identifying string for the layer.
isReference?	`boolean`	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).
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"ArcGISTiledImageServiceLayer"`	String indicating the layer type. Value of this property must be ArcGISTiledImageServiceLayer
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval?	`number`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

ITiledMapServiceLayer

An ArcGIS Tiled Map Service layer displays map content from an ArcGIS Server Map service that has been cached (tiled).

Property	Type	Description
displayLevels?	`number` \| `number`[]	NOTE: Applicable if used as a baseMapLayer. Integer value(s) indicating the display levels of the basemap layer. Only applicable for TiledMapService layers. All tiled map service layers should share the same tiling scheme. This property cannot be set via the Map Viewer UI.
exclusionAreas?	`IExclusionArea`[]	NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions.
id	`any`	A unique identifying string for the layer.
isReference?	`any`	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).
itemId?	`any`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layers?	`IChildLayer`[]	An array of layer objects defining a URL for queries and the popup window content.
layerType	`"ArcGISTiledMapServiceLayer"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval?	`number`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`string`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

ITileInfo

Tile information, returned from the WMTS OGC Web Service. The tileInfo will contain the spatial reference of the layer. tileInfo is the same json representation as the ArcGIS Map/Image service tileInfo except that it may contain a levelValue on the lod objects that should be used instead of the level in the templateUrl.

Property	Type	Description
cols?	`any`	Requested tile's column.
compressionQuality?	`any`	Compression quality of the tile.
dpi?	`any`	The dpi of the tiling scheme.
format?	`"bmp"` \| `"gif"` \| `"jpg"` \| `"png"` \| `"png8"` \| `"png24"` \| `"png32"` \| `"emf"` \| `"lerc"` \| `"mixed"` \| `"pdf"` \| `"ps"` \| `"svg"` \| `"svgz"`	Image format of the cached tiles.
lods?	`ILod`[]	An array of levels of detail that define the tiling scheme.
origin?	`IPoint`	The tiling scheme origin.
rows?	`any`	Requested tile's row.
spatialReference?	`ISpatialReference`	The spatial reference of the tiling schema.

ITimeSlider

Time animation is controlled by a configurable time slider. Those configurations are saved to the web map as a timeSlider widget.

Property	Type	Description
properties	`ITimeSliderProperties`	Configurable properties used within the TimeSlider widget.

ITimeSliderProperties

Configurable properties used within the TimeSlider widget.

Property	Type	Description
currentTimeExtent?	`number`[]	An optional array of numbers indicating the slider's start to end time extent.
endTime?	`number`	The optional end of the time slider. If not specified, the slider defaults to the full time extent of all time-enabled layers.
numberOfStops?	`number`	Number of stops within the timeSlider widget.
startTime?	`number`	The optional start of the time slider. If not specified, the slider defaults to the full time extent of all time-enabled layers.
thumbCount?	`number`	The default value for the thumbCount is 1.
thumbMovingRate?	`number`	Rate at which the time animation plays. Units are in milliseconds. Default is 1000.
timeStopInterval?	`number`	The interval which has been defined for the time slider.

ITypeInfo

Property	Type	Description
domains?	`Record`	A comma-delimited series of domain objects for each domain in the type.
id?	`string` \| `number`	A unique string or numerical ID for the type.
name?	`string`	A user-friendly name for the type.
templates?	`ITemplate`[]	Defined as a property of the layer definition when there are no types defined; otherwise, templates are defined as properties of the types.

ITypeInfoDomain

Property	Type	Description
type	`string`

IUser

An ArcGIS Online or Enterprise user

IUser can also be imported from the following packages:

Use dark colors for code blocksCopy
import `{ IUser }` from "@esri/arcgis-rest-auth";
import `{ IUser }` from "@esri/arcgis-rest-portal";

Property	Type	Description
access?	`string`
assignedCredits?	`number`
availableCredits?	`number`
cOrgId?	`string`
created?	`number`
culture?	`string`
description?	`string`
disabled?	`boolean`
email?	`string`
favGroupId?	`string`
firstName?	`string`
fullName?	`string`
groups?	`IGroup`[]
idpUsername?	`string`
lastLogin?	`number`
lastName?	`string`
level?	`string`
mfaEnabled?	`boolean`
modified?	`number`
orgId?	`string`
preferredView?	`any`
privileges?	`string`[]
provider?	`"arcgis"` \| `"enterprise"` \| `"facebook"` \| `"google"`
region?	`string`
role?	`"org_admin"` \| `"org_publisher"` \| `"org_user"`
roleId?	`string`
storageQuota?	`number`
storageUsage?	`number`
tags?	`string`[]
thumbnail?	`string`
units?	`string`
username?	`string`

IVectorTileLayer

A vector tile layer references a set of web-accessible vector tiles and the corresponding style for how those tiles should be drawn.

Property	Type	Description
id	`any`	A unique identifying string for the layer.
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"VectorTileLayer"`	String indicating the layer type.
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
styleUrl?	`string`	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.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"VectorTileLayer"`	Deprecated. User layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.

IViewingInfo

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.

Property	Type	Description
basemapGallery?	`IEnableable`	The basemap tool which will use the basemap group defined in the Portal.
measure?	`IEnableable`	Measure tool.
routing?	`IEnableable`	The route tool which will leverage the Portals defined route service.
search?	`ISearch`	An object specifying search parameters within the webmap.

IViewServiceSource

Individual View Source entry

Property	Type	Description
name	`string`
serviceItemId	`string`
type	`string`
url	`string`

IViewServiceSources

Response from the /sources end-point of a view service

Property	Type	Description
currentVersion	`number`
services	`IViewServiceSource`[]

IVisibleLayer

An array of numbers indicating layer visibility.

Property	Type	Description
featureVisibility?	`any`[][]	An array of arrays.
id?	`number`	The id of the layer as listed on the operational layer.
subLayerIds?	`number`[]	An array of integers.

IVisiblePopup

A presentation slide's visiblePopup which contains anchorPoint, featureId, layerId, and subLayerId.

Property	Type	Description
anchorPoint?	`IPoint`	Object with spatialReference, x, and y.
featureId?	`number`	An integer specifying the feature's id.
layerId?	`string`	A string specifying the layer id.
subLayerId?	`number`	An integer specifying the sublayer id.

IWebmap

The web map data lists the basemap, operational layers, and bookmarks to be used in the web map. It also contains information about popup windows and layer styling overrides to be used in the web map. A version property allows you to supply the version of the web map JSON format being used.

Property	Type	Description
applicationProperties?	`IApplicationProperties`	Viewing and editing properties of the webmap
authoringApp?	`string`	String value indicating the application which authored the webmap
authoringAppVersion?	`string`	String value indicating the authoring App's version number
background?	`IWebMapBackground`	Defines the appearance for the background of the map.
baseMap	`IBaseMap`	[Required] Basemaps give the web map a geographic context
bookmarks?	`IBookmark`[]	A bookmark is a saved geographic extent that allows end users to quickly navigate to a particular area of interest
mapRangeInfo?	`IMapRangeInfo`	Map Range Information
operationalLayers?	`ILayer`[]	Operational layers contain business data which are used to make thematic maps
presentation?	`any`	A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc
spatialReference	`ISpatialReference`	[Required] An object used to specify the spatial reference of the given geometry.
tables?	`ITable`[]	Root element in the web map specifying an array of table objects. (optional)
version	`string`	[Required] Root element in the web map specifying a string value indicating the web map version.
widgets?	`any`	The widgets object contains widgets that should be exposed to the user

IWebMapBackground

Defines the appearance for the background of the map.

Property	Type	Description
color	`Color`	To define the color of the background of the map (which is shown when no data is shown).

IWebMapTileServiceInfo

Object defines and provides information about layers in a WMTSLayer service.

Property	Type	Description
customLayerParameters?	`any`	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.
customParameters?	`any`	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.
layerIdentifier	`string`	Identifier for the specific layer used in the WMTS service. Required input by the user.
tileMatrixSet?	`any`	Tiling schema, set by the WMTS service.
url	`string`	URL to the WMTS web service. Required input by the user.

IWebTiledLayer

Property	Type	Description
copyright?	`any`	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.
fullExtent?	`IExtent`	An extent object representing the full extent envelope for the layer.
id	`any`	A unique identifying string for the layer.
isReference?	`any`	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).
itemId?	`string`	Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layerType	`"WebTiledLayer"`	String indicating the layer type. Value of this property must be WebTiledLayer
maxScale?	`number`	Integer property used to determine the maximum scale at which the layer is displayed.
minScale?	`number`	Integer property used to determine the minimum scale at which the layer is displayed.
name?	`string`	Layer name
opacity?	`number`	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval?	`any`	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.
showLegend?	`boolean`	Boolean property indicating whether to display in the legend.
subDomains?	`any`	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}`.
templateUrl?	`any`	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'.
tileInfo?	`ITileInfo`	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.
title?	`string`	A user-friendly string title for the layer that can be used in a table of contents.
type?	`"WebTiledLayer"`	Deprecated, use layerType instead.
url?	`string`	The URL to the layer. Not applicable to all layer types.
visibility?	`boolean`	Boolean property determining whether the layer is initially visible in the web map.
wmtsInfo?	`IWebMapTileServiceInfo`	Object containing information about the chosen WMTS service layer and tiling schema.

IWidget

The widgets object contains widgets that should be exposed to the user.

Property	Type	Description
range?	`IRange`	Active range.
timeSlider?	`ITimeSliderProperties`	Time animation is controlled by a configurable time slider. The time slider widget will act upon all the time aware layers in the map.

LegendItemVisibility

Represents the payload of the event sent when an item is toggled in the chart's legend (slice or series).

Property	Type	Description
overlayType?	`OverlayTerms`
seriesId?	`string`
sliceData?	`WebChartDataItem`
sliceId?	`string`
visible	`boolean`

NumberFormatOptions

Defines how the numerical(value) axis data should be formatted.

Property	Type	Description
intlOptions	`NumberFormatOptions`	Represents the JS native Intl.NumberFormatOptions, which is based on CLDR specifications.
type	`"number"`	Represents a unique string identifier for the NumberFormatOptions object. For NumberFormatOptions object, it is "number". It can help us to differentiate numerical (value) axis from other types of axes viz., date-time axis and category axis.

RGBObject

JSON representation of the color object

Property	Type	Description
a?	`number`
b	`number`
g	`number`
r	`number`

ScatterplotOverlays

Object containing Scatter Plot overlays

Property	Type	Description
trendLine?	`WebChartOverlay`	Specifies the trendline overlay for scatter plot. The trendline won't show if the property is not defined.
type	`"chartOverlays"`	Represents a unique string identifier for the ScatterplotOverlays object. For ScatterplotOverlays object, it is "chartOverlays".

ScatterplotTrendLineData

JSON representation of the processed data for a Scatter plot trend line

Property	Type	Description
r2?	`number`
trendLinePoints?	[`WebChartDataItem`, `WebChartDataItem`]

SizePolicy

Property	Type	Description
field	`string`	The field which determines the markers size
maxSize?	`number`	The maximum marker size
minSize?	`number`	The minimum marker size
scaleType?	`SizePolicyScaleTypes`	The type of scale to apply to the markers (linear or logarithmic)
type	`"sizeScale"`	Represents a unique string identifier for the sizePolicy object. For sizePolicy object, it is "sizeScale".

TimeIntervalInfo

Property	Type	Description
size?	`number`
unit?	`WebChartTemporalBinningUnits`

ValueConversion

Stores information regarding a numeric conversion

Property	Type	Description
factor?	`number`	A numeric value multiplying the value to convert
offset?	`number`	A numeric offset to apply to the value to convert

WebBoxPlot

JSON representation of Gauge

Property	Type	Description
axes?	[`WebChartAxis`, `any`, `any`]	Represents an array of at least 1 or at most 3 Chart Axis accompanying the chart. The axes property is optional because Pie chart does not use any axis. The third axis config is used when a series `assignToSecondValueAxis` is set to `true`. Some of the axis features won't apply to the third axis (e.g. labels behaviors).
background?	`Color`	Specifies the background color of the chart.
chartRenderer?	`any`	Renderer to use to style the series when the chart uses the color match mode. Considered before the layer's renderer.
colorMatch?	`boolean`	Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc. To do so, this property needs to be set to `true`. When there is no matching color found (for when `colorMatch = true`) or when `colorMatch = false`, the colors from the config, and then from the color ramps will be used, in that order.
cursorCrosshair?	`WebChartCursorCrosshair`	Specifies cursor's crosshair information for the chart. Only for XY charts.
dataFilters?	`WebChartDataFilters`	Used to filter the chart's data while in Layer mode.
footer?	`WebChartText`	Specifies footer of the chart
horizontalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the horizontal axis can't display them all. The available options are: "none", "rotate", "stagger" and "wrap". For XY Chart only. Histogram can handle "none" and "rotate" only. The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
id?	`string`	Can be used to uniquely identify a chart. The consumer app can choose whether to use it or not.
iLayer?	`IFeatureLayer`	Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.
legend?	`WebChartLegend` \| `WebChartPieChartLegend`	Specifies the Legend information for the chart.
orderOptions?	`object`	Chart order options (data and series)
rotated?	`boolean`	Specifies whether or not the chart is rotated. Applied to Bar, Line, and Combo Bar and Line charts.
series	`WebChartBoxPlotSeries` \| `WebChartLineChartSeries`[]	The box plot series can be of type "boxPlotSeries" or "lineSeries".
showMean?	`boolean`	Whether to show the mean lines on the chart. Applies only if a split-by field is set. Additionally the chart will render with that option enabled only if the the series array contains one box plot series and N lines series.
showOutliers?	`boolean`	Whether to show the outliers on the chart
stackedType?	`WebChartStackedKinds`	Specifies how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or when multiple attributes/fields corresponding to the same set of classes are to be visualized. Currently this property is only used for bar and line series.
standardizeValues?	`boolean`	Whether to standardize the values by calculating the series z-score
subtitle?	`WebChartText`	Specifies sub-heading/subtitle of the chart.
title?	`WebChartText`	Specifies heading/title of the chart.
type	`"chart"`	Represents a unique string identifier for the Chart object. For Chart object, it is chart.
version	`"24.3.0"`	Version of the specification. Used to identify when a saved config was created.
verticalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the vertical axis can't display them all. For XY Chart only. The available options are: "none" and "wrap". The default value for the vertical axis is "wrap".

WebChart

Gives a JSON representation of the Chart object.

Property	Type	Description
axes?	[`WebChartAxis`, `any`, `any`]	Represents an array of at least 1 or at most 3 Chart Axis accompanying the chart. The axes property is optional because Pie chart does not use any axis. The third axis config is used when a series `assignToSecondValueAxis` is set to `true`. Some of the axis features won't apply to the third axis (e.g. labels behaviors).
background?	`Color`	Specifies the background color of the chart.
chartRenderer?	`any`	Renderer to use to style the series when the chart uses the color match mode. Considered before the layer's renderer.
colorMatch?	`boolean`	Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc. To do so, this property needs to be set to `true`. When there is no matching color found (for when `colorMatch = true`) or when `colorMatch = false`, the colors from the config, and then from the color ramps will be used, in that order.
cursorCrosshair?	`WebChartCursorCrosshair`	Specifies cursor's crosshair information for the chart. Only for XY charts.
dataFilters?	`WebChartDataFilters`	Used to filter the chart's data while in Layer mode.
footer?	`WebChartText`	Specifies footer of the chart
horizontalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the horizontal axis can't display them all. The available options are: "none", "rotate", "stagger" and "wrap". For XY Chart only. Histogram can handle "none" and "rotate" only. The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
id?	`string`	Can be used to uniquely identify a chart. The consumer app can choose whether to use it or not.
iLayer?	`IFeatureLayer`	Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.
legend?	`WebChartLegend` \| `WebChartPieChartLegend`	Specifies the Legend information for the chart.
orderOptions?	`object`	Chart order options (data and series)
rotated?	`boolean`	Specifies whether or not the chart is rotated. Applied to Bar, Line, and Combo Bar and Line charts.
series	`WebChartSeriesType`[]	Represents an array of various chart series to be plot inside the chart. Empty array is not allowed.
stackedType?	`WebChartStackedKinds`	Specifies how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or when multiple attributes/fields corresponding to the same set of classes are to be visualized. Currently this property is only used for bar and line series.
subtitle?	`WebChartText`	Specifies sub-heading/subtitle of the chart.
title?	`WebChartText`	Specifies heading/title of the chart.
type	`"chart"`	Represents a unique string identifier for the Chart object. For Chart object, it is chart.
version	`"24.3.0"`	Version of the specification. Used to identify when a saved config was created.
verticalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the vertical axis can't display them all. For XY Chart only. The available options are: "none" and "wrap". The default value for the vertical axis is "wrap".

WebChartAxis

JSON representation of the chart's axis object

Property	Type	Description
buffer?	`boolean`	Allows setting a buffer to a value axis to provide some space around the series.
dateBaseInterval?	`TimeIntervalInfo`	Specifies the base interval on a date axis. Will be ignored on the other axis types. It will be overridden by the properties from the series `binTemporalData` when provided.
displayCursorTooltip?	`boolean`	Specifies whether cursor tooltip should be displayed.
displayZeroLine?	`boolean`	Represents an option to hide/un-hide the zero line on value axis
grid?	`ISimpleLineSymbol`	Dictates how the grid lines associated with a particular axis should be rendered.
guides?	`WebChartGuide`[]	Represent an array of guides that should be rendered onto the axis.
integerOnlyValues?	`boolean`	Represents an option to show `integer-only` values for a value axis
isLogarithmic?	`boolean`	Specifies whether the axis has a logarithmic scale or not.
labels	`WebChartText`	Contains styling info on how the axis labels should be rendered.
lineSymbol?	`ISimpleLineSymbol`	Contains styling info on how the axis line should be rendered. If not provided a default style is applied.
maximum?	`null` \| `number`	The maximum value which the axis should represent, when it is not defined or null, then the maximum value for the corresponding axis is automatically calculated.
minimum?	`null` \| `number`	The minimum value which the axis should represent, when it is not defined or null, then the minimum value for the corresponding axis is automatically calculated.
scrollbar?	`WebChartAxisScrollBar`	Represents the axis scrollbar style and visibility
tickSpacing?	`number`	The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size. When not provided a default value is assigned according to the axis type and axis labels behavior.
title?	`WebChartText`	Contains styling info on how the title of the axis should be rendered
type	`"chartAxis"`	Represents a unique string identifier for the WebChartAxis object. For ChartAxis object, it is "chartAxis".
valueFormat	`NumberFormatOptions` \| `DateTimeFormatOptions` \| `CategoryFormatOptions`	Specifies how numerical/categorical/date-time values should be formatted.
visible?	`boolean`	Determines the visibility of the content.

WebChartAxisScrollBar

Describes the properties of an axis scrollbar

Property	Type	Description
color?	`Color`	Scrollbar color
gripSize?	`number`	Grip size in pixels
margin?	`number`	Margin between the scrollbar and the series container in pixels
visible?	`boolean`	Scrollbar visibility
width?	`number`	Scrollbar width in pixels

WebChartBarChartSeries

Bar chart shows the categorical distribution of String/DateTime data.

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
binTemporalData?	`boolean`	Whether to use the time properties to bin the temporal data. If set to `false` the `binCount` and `unit` properties can be used to set the date axis base interval.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the columns/bars should be rendered
hideOversizedSideBySideLabels?	`boolean`	When true, the labels displayed within a small column for sideBySide bar series are hidden to avoid cluttering. When false or undefined (default), all the data labels are displayed.
hideOversizedStackedLabels?	`boolean`	When true or undefined (default), the labels displayed within a small stacked column are hidden to avoid cluttering. When false, all the data labels are displayed.
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
nullCategory?	`WebChartNullCategory`	Specifies how to display the category with null value Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
temporalBinning?	`WebChartTemporalBinning`	Describes how to bin the temporal data.
type	`"barSeries"`	Represents a unique string identifier for the BarChartSeries object. For BarSeries object, it is "barSeries".
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
y	`string`	Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartBin

JSON representation of a Histogram bin

Property	Type	Description
count	`number`
isLastBin?	`boolean`	Whether this is the last bin.
maxValue	`number`	Max value in the bin
minValue	`number`	Min value in the bin
symbol?	`WebChartDataItem`	Symbol associated with the bin.

WebChartBoxPlotDataItem

JSON representation of the processed data for a Box Plot

Property	Type	Description
dataItems	`WebChartDataItem`[]
meanLines?	`WebChartDataItem`[]
outliers?	`WebChartDataItem`[]

WebChartBoxPlotSeries

JSON representation of the Box plot series

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the box and whiskers should be rendered. The whiskers use the fillSymbol.outline.
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
type	`"boxPlotSeries"`
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
y	`string` \| `string`[]	Specifies the numeric field(s) used by the box plot series.

WebChartCalendarDatePartsBinning

Property	Type	Description
end?	`number`	The binning end date Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
offset?	`object`	Offset to apply to the results Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
start?	`number`	The binning start date. Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
trimIncompleteTimeInterval?	`boolean`	Determines whether incomplete time intervals at the start or end of the data span (depending on the `timeAggregationType`) will be removed from the chart. Incomplete intervals on a chart can cause misleading results in which the period in question is under- or over reported due to a different amount of time in the interval. Setting `true` indicates to trim these incomplete intervals. Setting `false` does not trim incomplete intervals.
unit	`WebChartCalendarDatePartsUnits`	Represents the unit to use to bin the data.

WebChartCursorCrosshair

JSON representation of the cursor's crosshair for a chart.

Property	Type	Description
horizontalLineVisible?	`boolean`	Indicates whether the horizontal crosshair line should be displayed
style?	`ISimpleLineSymbol`	Contains styling info on how the chart cursor's crosshair should be rendered.
type	`"cursorCrosshair"`	Represents a unique string identifier for the chart cursor's crosshair.
verticalLineVisible?	`boolean`	Indicates whether the vertical crosshair line should be displayed

WebChartDateTimeUnitFormatOptions

Interface used by the axis valueFormat property to describe how to format specific date and time units when displayed on the axis. For instance: "year": { year: "numeric" } "month": { month: "numeric" } "day": { day: "2-digit" } "hour": { day: "numeric" } "minute": { minute: "numeric" } "second": { second: "numeric" } Reference: https://tc39.es/ecma402/#sec-datetimeformat-abstracts

Property	Type	Description
day?	`DateTimeFormatOptions`
hour?	`DateTimeFormatOptions`
minute?	`DateTimeFormatOptions`
month?	`DateTimeFormatOptions`
second?	`DateTimeFormatOptions`
year?	`DateTimeFormatOptions`

WebChartDirectionalDataOrder

A data order option that the items are to be ordered either ascending or descending. It can be used for any type of order, like by category, by mean, by median, etc.

Property	Type	Description
orderBy	`WebChartSortOrderKinds`	The direction of the order, either ascending or descending.
orderType	`WebChartOrderDataByTypes`	The type of order, eg by category, by mean, by median, or by y value.
preferLabel?	`boolean`	Indicates whether to order data by the label or the value. For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value. Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.

WebChartGaugeAxis

JSON representation of the gauge chart's axis object. Inherits from the WebChartAxis properties.

Property	Type	Description
buffer?	`boolean`	Allows setting a buffer to a value axis to provide some space around the series.
dateBaseInterval?	`TimeIntervalInfo`	Specifies the base interval on a date axis. Will be ignored on the other axis types. It will be overridden by the properties from the series `binTemporalData` when provided.
displayCursorTooltip?	`boolean`	Specifies whether cursor tooltip should be displayed.
displayZeroLine?	`boolean`	Represents an option to hide/un-hide the zero line on value axis
grid?	`ISimpleLineSymbol`	Dictates how the grid lines associated with a particular axis should be rendered.
guides?	`WebChartGuide`[]	Represent an array of guides that should be rendered onto the axis.
innerLabel?	`WebChartText`	Specifies how the axis' inner label needs to be displayed
integerOnlyValues?	`boolean`	Represents an option to show `integer-only` values for a value axis
isLogarithmic?	`boolean`	Specifies whether the axis has a logarithmic scale or not.
labels	`WebChartText`	Contains styling info on how the axis labels should be rendered.
labelsIncrement?	`number`	If a label has a value being a multiple of that property, it will be displayed. Otherwise it will be hidden. If the property is `undefined` or 0, the chart will be displayed with 6 axis labels distributed evenly along the axis min and max. If the property has a value that results in more than a set limit of axis labels (25 as defined in `ChartDefaults.gauge.maximumNumberOfLabelIntervals`) this property value will be ignored and the chart will be displayed with only axis min/max with 4 ticks in between.
lineSymbol?	`ISimpleLineSymbol`	Contains styling info on how the axis line should be rendered. If not provided a default style is applied.
maximum?	`null` \| `number`	The maximum value which the axis should represent, when it is not defined or null, then the maximum value for the corresponding axis is automatically calculated.
maximumFromField?	`string` \| `IStatisticDefinition`	If used with a gauge by feature: - `maximumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis maximum value If used with a statistic gauge: - If `maximumFromField` is set to a field name (string), the maximum from that field is mapped to the axis maximum value - If it is set to an `IStatisticDefinition` the statistic (min, max, avg...) from the given field is mapped to the axis maximum value When `maximumFromField` is not provided or when it leads to an invalid value, the `maximum` value from the axis config, if provided, or the default value of 0, in that order, will be used.
maximumValueConversion?	`ValueConversion`	Defines how to convert the axis maximum
minimum?	`null` \| `number`	The minimum value which the axis should represent, when it is not defined or null, then the minimum value for the corresponding axis is automatically calculated.
minimumFromField?	`string` \| `IStatisticDefinition`	If used with a gauge by feature: - `minimumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis minimum value If used with a statistic gauge: - If `minimumFromField` is set to a field name (string), the minimum from that field is mapped to the axis minimum value - If it is set to an `IStatisticDefinition` the statistic (min, max, avg...) from the given field is mapped to the axis minimum value When `minimumFromField` is not provided or when it leads to an invalid value, the `minimum` value from the axis config, if provided, or the default value of 0, in that order, will be used.
minimumValueConversion?	`ValueConversion`	Defines how to convert the axis minimum
needle?	`WebChartNeedle`	Specifies how the axis' needle needs to be displayed
onlyShowFirstAndLastLabels?	`boolean`	Specifies if only the first and last labels need to be displayed. If set to `true` all the other labels will be hidden. Their visibility still depends on the axis labels visibility (WebChartAxis.labels.visible).
scrollbar?	`WebChartAxisScrollBar`	Represents the axis scrollbar style and visibility
ticks?	`WebChartGaugeAxisTick`	Specifies how the axis' ticks need to be displayed
tickSpacing?	`number`	The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size. When not provided a default value is assigned according to the axis type and axis labels behavior.
title?	`WebChartText`	Contains styling info on how the title of the axis should be rendered
type	`"chartAxis"`	Represents a unique string identifier for the WebChartAxis object. For ChartAxis object, it is "chartAxis".
valueFormat	`NumberFormatOptions` \| `DateTimeFormatOptions` \| `CategoryFormatOptions`	Specifies how numerical/categorical/date-time values should be formatted.
visible?	`boolean`	Determines the visibility of the content.

WebChartGaugeAxisTick

JSON representation of the gauge axis ticks. Currently only used by WebChartGaugeAxis.

Property	Type	Description
type	`"gaugeAxisTick"`	Represents a unique string identifier for the GaugeAxisTick object. For WebChartGaugeAxisTick object, it is "gaugeAxisTick".
visible?	`boolean`	Determines the visibility of the axis ticks.

WebChartGaugeSeries

JSON representation of the Gauge series

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
featureIndex?	`number`	Specifies the index of the feature to be rendered. This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property). For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
type	`"gaugeSeries"`	Represents a unique string identifier for the GaugeSeries object. For GaugeSeries object, it is "gaugeSeries".
valueConversion?	`ValueConversion`	Defines the conversion to apply to the gauge value
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartGenericDataItem

JSON representation of the generic data structure for bar, line bar-line, gauge and pie chart

Property	Type	Description
dataItems	`WebChartDataItem`[]
timeIntervalInfo?	`TimeIntervalInfo`	Time interval information, only for line charts

WebChartGuide

JSON representation of the chart's guide object. Can be used to represent both line and fill guides.

Property	Type	Description
above?	`boolean`	Determines whether the guide should be rendered on top of (overlapping) the series or under the series.
end?	`null` \| `string` \| `number` \| `Date`	Determines the value where the guide should end. If it is not specified, we get a line guide, otherwise we get a fill/rectangular guide.
label?	`WebChartTextSymbol`	Defines a text label for the given guide. It is displayed on the chart next to the concerned guide and is styled using esriTS format.
name	`string`	A unique string identifier which is used to refer to a particular guide. It is displayed in the Chart Authoring UI to differentiate between different guides.
start	`null` \| `string` \| `number` \| `Date`	Determines the value where the guide should begin.
style	`ISimpleLineSymbol` \| `ISimpleFillSymbol`	Determines how the guide should be rendered. Line guide requires esriSLS format, and fill guide requires esriSFS format.
tooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the guide's tooltip background (false) or its outline (true).
type	`"chartGuide"`	Represents a unique string identifier for the Guide object. For Guide class, it is "chartGuide".
visible?	`boolean`	Determines the visibility of the content.

WebChartHeatChartGradient

JSON representation of the Heat chart - gradient type specific

Property	Type	Description
colorList?	[`Color`, `Color`]	An array of 2 colors to use for the gradient. The first color represents the minimum value, the second color represents the maximum value.
maxValue?	`number`	Specifies the custom maximum value for the heat chart. If none is provided, the maximum value from the dataset will be used.
minValue?	`number`	Specifies the custom minimum value for the heat chart. If none is provided, the minimum value from the dataset will be used.
outsideRangeLowerColor?	`Color`	Specifies the color to use for the items outside the lower range specified by minValue. If none is provided, the default color will be used.
outsideRangeUpperColor?	`Color`	Specifies the color to use for the items outside the upper range specified by maxValue. If none is provided, the default color will be used.

WebChartHeatChartSeries

JSON representation of the Heat chart series

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
emptyCells?	`object`	Specifies how to display the empty cells, in terms of text and symbology.
gradientRules?	`WebChartHeatChartGradient`	Specifies the details of the gradient rules for the heat chart.
gridLine?	`ISimpleLineSymbol`	Defines how the cells outline should render.
heatRulesType?	`"gradient"`	Defines the type of rule to apply for the heat chart.
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
type	`"heatSeries"`
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
xTemporalBinning?	`WebChartCalendarDatePartsBinning`	Describes how to bin the temporal data when the x-axis field is a date.
y	`string`	Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
yTemporalBinning?	`WebChartCalendarDatePartsBinning`	Describes how to bin the temporal data when the y-axis field is a date.

WebChartHistogramDataItem

JSON representation of the processed data for a Histogram

Property	Type	Description
bins	`WebChartBin`[]
count?	`number`	Number of all the points/features in un-binned data (including only non-null entries)
max	`number`
mean	`number`
median	`number`
min	`number`
nulls?	`number`	Number of null entries in the pool of points
stddev	`number`
sum?	`number`	Sum of the values of all the points

WebChartHistogramSeries

Histogram shows the numerical(frequency) distribution of a numerical field.

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
binCount?	`null` \| `number`	Bin count must be a positive integer.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
dataTransformationType?	`WebChartDataTransformations`	Specifies how the data should be transformed (e.g. square root, log, etc.) before binning.
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the columns/bars should be rendered
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
overlays?	`HistogramOverlays`	Specifies the chart overlays. Histogram supports 4 overlays: mean, median, standardDeviation and comparisonDistribution. The overlays won't show if the property is not defined.
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
type	`"histogramSeries"`	Represents a unique string identifier for the HistogramSeries object. For BarSeries object, it is "histogramSeries".
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartLegend

JSON representation of the Chart's legend box

Property	Type	Description
body?	`WebChartTextSymbol`	Contains styling info on how legend body (excluding the title) should be rendered. Will use default styling if not provided.
maxHeight?	`null` \| `number`	Legend's maximum height. If not set the legend will occupy the same height as the series container or pie chart.
position?	`WebChartLegendPositions`	Positions the legends at `"right"`, `"left"`, `"top"`, or `"bottom"` of the chart.
roundMarkers?	`boolean`	Allows the legend markers to be displayed as circles. If the property is to: - `false` or `undefined` they will be rounded rectangles - `true` they will be circles
title?	`WebChartText`	Contains styling info on how the title of the legend box should be rendered
type	`"chartLegend"`	Represents a unique string identifier for the ChartLegend object. For ChartLegend object, it is "chartLegend".
visible?	`boolean`	Determines the visibility of the content.

WebChartLineChartSeries

JSON representation of the Line Chart series

Property	Type	Description
areaColor?	`Color`	Specifies the color of the filled area for line chart. areaColor will be applied only if showArea is true, and is defaulted to the line color if not provided.
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
binTemporalData?	`boolean`	Whether to use the time properties to bin the temporal data. If set to `false` the `binCount` and `unit` properties can be used to set the date axis base interval.
connectLines?	`boolean`	Whether to connect the lines when there's a gap in the data. Can be overridden by the temporal data setting `nullPolicy`.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
id	`string`	A unique string used to differentiate the series on a chart.
lineSmoothed?	`boolean`	Specifies whether line segments should be smoothed.
lineSymbol?	`ISimpleLineSymbol`	Contains styling info on how the line/line segments should be rendered
markerSymbol?	`ISimpleMarkerSymbol`	Contains styling info on how the marker should be rendered
markerVisible?	`boolean`	Indicates whether to show or hide the markers/bullets of the line series.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
nullCategory?	`WebChartNullCategory`	Specifies how to display the category with null value Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
showArea?	`boolean`	Indicates whether line series show area.
stackNegativeValuesToBaseline?	`boolean`	Specifies how negative values are treated in stacked series. If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
temporalBinning?	`WebChartTemporalBinning`	Describes how to bin the temporal data.
type	`SeriesType`	Represents a unique string identifier for the LineSeries object. For LineSeries object, it is "lineSeries".
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
y	`string` \| `string`[]	Specifies the numeric field(s) used by the series. The array type is useful when used for a box plot.

WebChartNeedle

JSON representation of a gauge needle.

Property	Type	Description
displayPin?	`boolean`	Hides or shows the needle's pin (centroid circle)
endWidth?	`null` \| `number`	Represents the needle's thickness at the top, in px
innerRadius?	`null` \| `number`	Represents the size of the hole in the middle of the chart. Can be visualized when guides are displayed.
startWidth?	`null` \| `number`	Represents the needle's thickness at the bottom (chart's center), in px
symbol?	`ISimpleFillSymbol`	Contains styling info on how the needle should be rendered
type	`"gaugeNeedle"`	Represents a unique string identifier for the ChartNeedle object. For WebChartNeedle object, it is "gaugeNeedle".
visible?	`boolean`	Hides or shows the needle.

WebChartNullCategory

Property	Type	Description
symbol?	`ISimpleFillSymbol`	Contains styling info on how the overlay should be rendered If not provided a default style is applied.
text?	`string`	Specifies the text to use for the null category. If none is provided, the default `null` text will be used.

WebChartOrderSeriesBy

Order options for split-by series.

Property	Type	Description
orderBy?	`WebChartSortOrderKinds`	The direction of the order.
preferLabel?	`boolean`	When the value is set to true, we want to order the split-by series based on the series' names (alias, custom label, or description). When the value is set to false, we want to order the split-by series based on the series' split-by values.

WebChartOverlay

JSON representation of the chart's overlays like trendline scatter plot, and median in histogram

Property	Type	Description
created?	`boolean`	Determines whether the overlay is created under the hood. It may or may not be visible.
symbol?	`ISimpleLineSymbol`	Contains styling info on how the overlay should be rendered If not provided a default style is applied.
type	`"chartOverlay"`	Represents a unique string identifier for the ChartOverlay object. For ChartOverlay object, it is "chartOverlay".
visible?	`boolean`	Determines the visibility of the content.

WebChartPieChartGroupSlice

JSON representation of the pie grouped slice

Property	Type	Description
dataLabels?	`WebChartText`	Specifies how the grouped slice data labels should be rendered. If the property is not set the `series.dataLabels` will be used instead.
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the slice should be rendered. If not provided, the slice will be styled with default values.
label?	`string`	Custom label for the slice. For grouped slice, the default value is `Other`. For regular slice, it will be either the category or field name.
originalLabel?	`null` \| `string` \| `number` \| `Date`	The slice's original label.
percentageThreshold	`number`	Slices that have a percent value equal or lesser to this threshold are grouped into a unique slice
sliceId	`string`	A unique string used identify the slice of a pie chart.

WebChartPieChartLegend

Specific legend for the Pie chart

Property	Type	Description
body?	`WebChartTextSymbol`	Contains styling info on how legend body (excluding the title) should be rendered. Will use default styling if not provided.
displayCategory?	`boolean`	Indicates whether the category associated to a slice is to be displayed in the legend.
displayNumericValue?	`boolean`	Indicates whether the numeric value associated to a slice is to be displayed in the legend. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`
displayPercentage?	`boolean`	Indicates whether the percentage to a slice is to be displayed in the legend. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`
labelMaxWidth?	`number`	Maximum width in pixels of the label displaying the slice name. If the label is larger than the maximum width, it will automatically wrap.
maxHeight?	`null` \| `number`	Legend's maximum height. If not set the legend will occupy the same height as the series container or pie chart.
position?	`WebChartLegendPositions`	Positions the legends at `"right"`, `"left"`, `"top"`, or `"bottom"` of the chart.
roundMarkers?	`boolean`	Allows the legend markers to be displayed as circles. If the property is to: - `false` or `undefined` they will be rounded rectangles - `true` they will be circles
title?	`WebChartText`	Contains styling info on how the title of the legend box should be rendered
type	`"chartLegend"`	Represents a unique string identifier for the ChartLegend object. For ChartLegend object, it is "chartLegend".
valueLabelMaxWidth?	`number`	Maximum width in pixels of the label displaying the slice name. If the label is larger than the maximum width, it will automatically wrap.
visible?	`boolean`	Determines the visibility of the content.

WebChartPieChartSeries

JSON representation of the Pie Chart series

Property	Type	Description
alignDataLabels?	`boolean`	Aligns labels into columns to make them more readable and avoid them to overlap each other. Ignored when `dataLabelsInside` is set to `true`.
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataLabelsCharacterLimit?	`null` \| `number`	If set, the category on the data label is truncated to display only `characterLimit` characters, and an ellipsis ("...") is added to the end of the label. This does not affect the value and percentage part of the labels. Does not apply to tooltips and legend labels.
dataLabelsInside?	`boolean`	Whether to place the data labels inside the pie slices. When set to `true` the following properties will be ignored: - dataLabelsOffset - alignDataLabels - optimizeDataLabelsOverlapping
dataLabelsOffset?	`number`	Determines in pixel how far the data labels should be placed from their slice. If a negative value is provided the label will be placed inside of the chart. Ignored when `dataLabelsInside` is set to `true`.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
displayCategoryOnDataLabel?	`boolean`	Indicates whether the category associated to a slice is to be displayed on its data label. This property will be ignored if the chart options `dataLabelFormatter` is provided.
displayCategoryOnTooltip?	`boolean`	Indicates whether the category associated to a slice is to be displayed on its tooltip. This property will be ignored if the chart options `tooltipFormatter` is provided.
displayNumericValueOnDataLabel?	`boolean`	Indicates whether the numeric value associated to a slice is to be displayed on its data label. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`. This property will be ignored if the chart options `dataLabelFormatter` is provided.
displayNumericValueOnTooltip?	`boolean`	Indicates whether the numeric value associated to a slice is to be displayed on its tooltip. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)` This property will be ignored if the chart options `tooltipFormatter` is provided.
displayPercentageOnDataLabel?	`boolean`	Indicates whether the percentage associated to a slice is to be displayed on its data label. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)` This property will be ignored if the chart options `dataLabelFormatter` is provided.
displayPercentageOnTooltip?	`boolean`	Indicates whether the percentage associated to a slice is to be displayed on its tooltip. If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)` This property will be ignored if the chart options `tooltipFormatter` is provided.
endAngle?	`null` \| `number`
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the slices should be rendered
id	`string`	A unique string used to differentiate the series on a chart.
innerRadius?	`null` \| `number`	Represents the size of the hole in middle of the chart. The number is used as a percentage rather than a fixed value.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
numericValueFormat?	`NumberFormatOptions`	Specifies how the numerical values should be formatted (applied to label, tooltip and legend). Can be overridden for the tooltips by series.dataTooltipValueFormat.
optimizeDataLabelsOverlapping?	`boolean`	Optimizes the data labels rendering to avoid them to be cut off on the edges or to overlap the legend by wrapping them and adding padding to the chart. Ignored when `dataLabelsInside` is set to `true`.
percentagePrefix?	`string`	Adds a prefix to all the percentages displayed on the pie chart: data labels, tooltips and legend
percentageSuffix?	`string`	Adds a suffix to all the percentages displayed on the pie chart: data labels, tooltips and legend
percentValueFormat?	`NumberFormatOptions`	Specifies how the percent values should be formatted (applied to label, tooltip and legend) Can be overridden for the tooltips by series.dataTooltipPercentFormat.
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
sliceGrouping?	`WebChartPieChartGroupSlice`	Specifies if and how the slices under a given percentage threshold are grouped into a unique slice
slices?	`WebChartPieChartSlice`[]	An array of WebChartPieChartSlice representing the ids, labels and styles of the pie slices. When this property is not defined, or when a pie slice does not have a matching slice in this array, the series' fillSymbol will be used. If the series' fillSymbol does not contain color information, colors from the color ramps will be utilized.
startAngle?	`null` \| `number`
ticks?	`WebChartPieChartTick`	Specifies how to render the ticks shown on each slide. Ticks will be displayed with default values if not provided.
type	`"pieSeries"`	Represents a unique string identifier for the PieSeries object. For PieSeries object, it is "pieSeries".
valuePrefix?	`string`	Adds a prefix to all the values displayed on the pie chart: data labels, tooltips and legend
valueSuffix?	`string`	Adds a suffix to all the values displayed on the pie chart: data labels, tooltips and legend
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
y	`string`	Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartPieChartSlice

JSON representation of the pie slices

Property	Type	Description
fillSymbol?	`ISimpleFillSymbol`	Contains styling info on how the slice should be rendered. If not provided, the slice will be styled with default values.
label?	`string`	Custom label for the slice. For grouped slice, the default value is `Other`. For regular slice, it will be either the category or field name.
originalLabel?	`null` \| `string` \| `number` \| `Date`	The slice's original label.
sliceId	`string`	A unique string used identify the slice of a pie chart.

WebChartPieChartTick

JSON representation of the pie ticks.

Property	Type	Description
lineSymbol?	`ISimpleLineSymbol`	Contains styling info on how the pie chart ticks should be rendered
type	`"pieTick"`	Represents a unique string identifier for the WebChartPieChartTick object. For PieTick object, it is "pieTick".
visible?	`boolean`	Determines the visibility of the tick. Assigning the `true` value will only be considered when the data labels are visible (`series.dataLabels.visible`) and when the data label associated to the tick is outside of the chart (`series.dataLabelsOffset` > 0).

WebChartPredefinedLabelsDataOrder

A data order option for the items to be ordered by category based on a predefined list of labels.

Property	Type	Description
orderBy	`string`[]	The predefined list of labels to order the data by. When the value of the `preferLabel` property is set to `false`, the `orderBy` list should be a list of coded domain values or field names; otherwise, it should be a list of domain descriptions, subtypes descriptions, or field aliases.
orderType	`"arcgis-charts-category"`	The type of order, which is by category.
preferLabel?	`boolean`	Indicates whether to order data by the label or the value. For example, when a field has domain coded values or supbtypes, setting this property to `false` will order the data by the field value. Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data. When the value is set to `true` or undefined, the `orderBy` property should contain a list of labels like domain descriptions, subtypes descriptions, or field aliases. When the value is set to `false`, the `orderBy` property should contain a list of coded domain values or field names, in order for the data to be sorted correctly.

WebChartQuery

Chart query object inspired by JSAPI Query class.

Property	Type	Description
distance?	`number`	Specifies a search distance for the `geometry`. To be associated with the `units` property. For compatible layers only.
fetchNullValues?	`boolean`	Indicates whether to fetch null values for them to be counted or displayed as categories on the chart.
gdbVersion?	`string`	Specifies the geodatabase version to display for feature service queries.
geometry?	`IPoint` \| `IPolyline` \| `IPolygon` \| `IPolygonWithCurves` \| `IEnvelope` \| `IExtent`	The geometry to apply to the spatial filter. A buffer can be applied to it by setting the properties `distance` and `units`.
groupByFieldsForStatistics?	`string`[]	An array of fields which determine how the base data is grouped. Only one groupBy Field is supported, but ArcGIS JSAPI supports multiple groupBy fields. While splitting by multiple group-by fields is possible, it is not being done because of the number of series it will give rise to (equal to the length of the Cartesian product set) possibly making the visualization hard to interpret.
num?	`number`	The number of features to retrieve.
objectIds?	`number`[]	An array of objectIds of the features to be filtered.
orderByFields?	`string`[]	Represents the sorting order of the output result. More info present in JSAPI docs. The format of any entry in this array is `field_name sorting_order`. When `sorting_order` is not defined, it is assumed to be ascending.
outFields?	`string`[]	Attribute fields to include in the FeatureSet. Will have an effect on chart with no aggregation.
outStatistics?	`IStatisticDefinition`[]	Represents an array of statistics definitions which dictate how a particular field should be aggregated. Refer to JSAPI Statistics Definition class for more info.
returnDistinctValues?	`boolean`	If true then the query returns distinct values based on the field(s) specified in outFields. Available for count-based aggregations only.
spatialRelationship?	`"intersects"` \| `"contains"` \| `"crosses"` \| `"disjoint"` \| `"envelope-intersects"` \| `"index-intersects"` \| `"overlaps"` \| `"touches"` \| `"within"` \| `"relation"`	For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter geometry.
start?	`number`	The zero-based index indicating where to begin retrieving features.
timeExtent?	[`number`, `number`]	A time extent ([timestamp, timestamp]) for a temporal query against time-aware layers.
units?	`RESTUnits`	The unit for calculating the buffer distance when `distance` and `geometry` are provided. If not specified, the unit is derived from the geometry spatial reference.
where?	`string`	Acts as a filter on the base data for attribute-based filtering, expect for bar/line charts for which is is used to handle the split-by field values.

WebChartRadarChartAxis

JSON representation of the radar chart's axis object.

Property	Type	Description
buffer?	`boolean`	Allows setting a buffer to a value axis to provide some space around the series.
dateBaseInterval?	`TimeIntervalInfo`	Specifies the base interval on a date axis. Will be ignored on the other axis types. It will be overridden by the properties from the series `binTemporalData` when provided.
displayCursorTooltip?	`boolean`	Specifies whether cursor tooltip should be displayed.
displayZeroLine?	`boolean`	Represents an option to hide/un-hide the zero line on value axis
grid?	`ISimpleLineSymbol`	Dictates how the grid lines associated with a particular axis should be rendered.
guides?	`WebChartGuide`[]	Represent an array of guides that should be rendered onto the axis.
integerOnlyValues?	`boolean`	Represents an option to show `integer-only` values for a value axis
isLogarithmic?	`boolean`	Specifies whether the axis has a logarithmic scale or not.
labels	`WebChartText`	Contains styling info on how the axis labels should be rendered.
labelsOrientation?	`WebChartRadarChartAxisLabelsOrientation`	Defines the labels orientation
lineSymbol?	`ISimpleLineSymbol`	Contains styling info on how the axis line should be rendered. If not provided a default style is applied.
maximum?	`null` \| `number`	The maximum value which the axis should represent, when it is not defined or null, then the maximum value for the corresponding axis is automatically calculated.
minimum?	`null` \| `number`	The minimum value which the axis should represent, when it is not defined or null, then the minimum value for the corresponding axis is automatically calculated.
scrollbar?	`WebChartAxisScrollBar`	Represents the axis scrollbar style and visibility
tickSpacing?	`number`	The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size. When not provided a default value is assigned according to the axis type and axis labels behavior.
title?	`WebChartText`	Contains styling info on how the title of the axis should be rendered
type	`"chartAxis"`	Represents a unique string identifier for the WebChartAxis object. For ChartAxis object, it is "chartAxis".
valueFormat	`NumberFormatOptions` \| `DateTimeFormatOptions` \| `CategoryFormatOptions`	Specifies how numerical/categorical/date-time values should be formatted.
visible?	`boolean`	Determines the visibility of the content.

WebChartScatterplotDataItem

JSON representation of the processed data for a Scatter plot

Property	Type	Description
aggregated?	`boolean`
dataItems	`WebChartDataItem`[]
r2?	`number`
trendLinePoints?	[`WebChartDataItem`, `WebChartDataItem`]

WebChartScatterplotSeries

Scatter plot shows the relationship between two numerical fields.

Property	Type	Description
additionalTooltipFields?	`string`[]	Specifies the additional numeric fields in the tooltip.
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
id	`string`	A unique string used to differentiate the series on a chart.
markerSymbol?	`ISimpleMarkerSymbol`	Specifies how each data point in the scatter plot should be rendered. The type is `"esriSMS"` and it is adopted from the REST API Types.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
overlays?	`ScatterplotOverlays`	Specifies all the chart overlays. The scatter plot implements only 1 overlay, trendLine. The overlays won't show if the property is not defined.
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
sizePolicy?	`SizePolicy`	Specifies rules to use the scatter plot as bubble plot, by changing dynamically the markers size according to a specific field value
type	`"scatterSeries"`	Represents a unique string identifier for the ScatterSeries object. For ScatterSeries object, it is "scatterSeries".
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
y	`string`	Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartSeries

JSON representation of the chart's series object. All other series extends this interface.

Property	Type	Description
assignToSecondValueAxis?	`boolean`	Specifies whether the series should be assigned to the second value axis, when the `axes` property defines it. Supported by bar and line series.
dataLabels?	`WebChartText`	Specifies how the data labels should be rendered.
dataTooltipDateFormat?	`DateTimeFormatOptions`	Defines how to render dates in tooltips. Currently used for bar and line charts using a date x-axis with no time binning.
dataTooltipPercentFormat?	`NumberFormatOptions`	Defines how to render percent values in tooltips. Currently used for stacked 100% bar and line charts, as well as pie charts.
dataTooltipReverseColor?	`boolean`	Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Applies to all charts but Gauge.
dataTooltipValueFormat?	`NumberFormatOptions`	Defines how to render numeric values in tooltips.
dataTooltipVisible?	`boolean`	Hides or shows data tooltips. Applies to all charts but Gauge.
id	`string`	A unique string used to differentiate the series on a chart.
name	`string`	Specifies the name of the series. It would be reflected in the chart legends
query?	`WebChartSeriesQuery`	Specifies a query object associated with a particular series containing info on what data to fetch for that series.
type	`string`
visible?	`boolean`	Hides or shows the series. If the series is has visible set to `false`, the corresponding legend is grayed out in the legend box.
x	`string`	Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

WebChartTemporalBinning

Describes the properties available for a temporal binning for a bar or line

Property	Type	Description
end?	`number`	The binning end date Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
firstDayOfWeek?	`number`	The first day of the week. This property is used to determine the start of the week for date-based bins. The default value depends on the user locale (e.g. 7 as Sunday for a USA user, 1 as Monday for a French one). Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
nullPolicy?	`WebChartNullPolicyTypes`	How summarized bins returning a null value are displayed. Supported options are: - `null`, `zero`, and `interpolate` for line series - `null` and `zero` for bar series
offset?	`object`	Offset to apply to the results Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
outTimeZone?	`string`	Defines the IANA time zone used for temporal bin calculations Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
size?	`number`	The span of time that will be binned or aggregated together. Works in coordination with `unit`.
start?	`number`	The binning start date. Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
timeAggregationType?	`WebChartTimeAggregationTypes`	The time interval alignment type. Valid options include `equalIntervalsFromStartTime` and `equalIntervalsFromEndTime`. When specific the binning will start at the first or last date of the dataset.
trimIncompleteTimeInterval?	`boolean`	Determines whether incomplete time intervals at the start or end of the data span (depending on the `timeAggregationType`) will be removed from the chart. Incomplete intervals on a chart can cause misleading results in which the period in question is under- or over reported due to a different amount of time in the interval. Setting `true` indicates to trim these incomplete intervals. Setting `false` does not trim incomplete intervals.
unit?	`WebChartTemporalBinningUnits`	The unit of time to use to bin the temporal data. Current limitation: the "quarters" unit is only supported if the provided layer supports the `queryBins` operation.

WebChartTemporalSeries

Describes the properties related to a temporal series

Property	Type	Description
binTemporalData?	`boolean`	Whether to use the time properties to bin the temporal data. If set to `false` the `binCount` and `unit` properties can be used to set the date axis base interval.
temporalBinning?	`WebChartTemporalBinning`	Describes how to bin the temporal data.

WebChartText

Stores info on how some text is rendered on the chart and whether it is visible or not.

Property	Type	Description
content	`WebChartTextSymbol`	Contains the styling info and text content. Details on esriTS are here.
type	`"chartText"`	Represents a unique string identifier for the ChartText object. For ChartText object, it is "chartText".
visible?	`boolean`	Determines the visibility of the content.

WebGaugeChart

JSON representation of Gauge chart.

Property	Type	Description
axes	[`WebChartGaugeAxis`]	Array of one WebChartGaugeAxis
background?	`Color`	Specifies the background color of the chart.
chartRenderer?	`any`	Renderer to use to style the series when the chart uses the color match mode. Considered before the layer's renderer.
colorMatch?	`boolean`	Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc. To do so, this property needs to be set to `true`. When there is no matching color found (for when `colorMatch = true`) or when `colorMatch = false`, the colors from the config, and then from the color ramps will be used, in that order.
cursorCrosshair?	`WebChartCursorCrosshair`	Specifies cursor's crosshair information for the chart. Only for XY charts.
dataFilters?	`WebChartDataFilters`	Used to filter the chart's data while in Layer mode.
endAngle?	`null` \| `number`	Represents where is the chart's ending point. To be related with startAngle. If endAngle-startAngle is 360 the chart will render as full circle.
footer?	`WebChartText`	Specifies footer of the chart
horizontalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the horizontal axis can't display them all. The available options are: "none", "rotate", "stagger" and "wrap". For XY Chart only. Histogram can handle "none" and "rotate" only. The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
id?	`string`	Can be used to uniquely identify a chart. The consumer app can choose whether to use it or not.
iLayer?	`IFeatureLayer`	Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.
innerRadius?	`null` \| `number`	Represents the size of the hole in middle of the chart. The number is used as a percentage rather than a fixed value.
legend?	`WebChartLegend` \| `WebChartPieChartLegend`	Specifies the Legend information for the chart.
orderOptions?	`object`	Chart order options (data and series)
rotated?	`boolean`	Specifies whether or not the chart is rotated. Applied to Bar, Line, and Combo Bar and Line charts.
series	`WebChartSeriesType`[]	Represents an array of various chart series to be plot inside the chart. Empty array is not allowed.
stackedType?	`WebChartStackedKinds`	Specifies how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or when multiple attributes/fields corresponding to the same set of classes are to be visualized. Currently this property is only used for bar and line series.
startAngle?	`null` \| `number`	Represents where is the chart's starting point
subtitle?	`WebChartText`	Specifies sub-heading/subtitle of the chart.
subType?	`GaugeChartSubTypes`	The type of Gauge, like FeatureGauge and StatisticGauge. When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
title?	`WebChartText`	Specifies heading/title of the chart.
type	`"chart"`	Represents a unique string identifier for the Chart object. For Chart object, it is chart.
version	`"24.3.0"`	Version of the specification. Used to identify when a saved config was created.
verticalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the vertical axis can't display them all. For XY Chart only. The available options are: "none" and "wrap". The default value for the vertical axis is "wrap".

WebHeatChart

Gives a JSON representation of the Heat Chart object.

Property	Type	Description
axes?	[`WebChartAxis`, `any`, `any`]	Represents an array of at least 1 or at most 3 Chart Axis accompanying the chart. The axes property is optional because Pie chart does not use any axis. The third axis config is used when a series `assignToSecondValueAxis` is set to `true`. Some of the axis features won't apply to the third axis (e.g. labels behaviors).
background?	`Color`	Specifies the background color of the chart.
chartRenderer?	`any`	Renderer to use to style the series when the chart uses the color match mode. Considered before the layer's renderer.
colorMatch?	`boolean`	Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc. To do so, this property needs to be set to `true`. When there is no matching color found (for when `colorMatch = true`) or when `colorMatch = false`, the colors from the config, and then from the color ramps will be used, in that order.
cursorCrosshair?	`WebChartCursorCrosshair`	Specifies cursor's crosshair information for the chart. Only for XY charts.
dataFilters?	`WebChartDataFilters`	Used to filter the chart's data while in Layer mode.
firstDayOfWeek?	`number`	The first day of the week. This property is used to determine the start of the week for date-based bins. The default value depends on the user locale (e.g. 7 as Sunday for a USA user, 1 as Monday for a French one). Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
footer?	`WebChartText`	Specifies footer of the chart
horizontalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the horizontal axis can't display them all. The available options are: "none", "rotate", "stagger" and "wrap". For XY Chart only. Histogram can handle "none" and "rotate" only. The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
id?	`string`	Can be used to uniquely identify a chart. The consumer app can choose whether to use it or not.
iLayer?	`IFeatureLayer`	Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.
legend?	`WebChartLegend` \| `WebChartPieChartLegend`	Specifies the Legend information for the chart.
nullPolicy?	`WebChartNullPolicyTypes`	How summarized bins returning a null value are displayed. Supported options are: - `null`, `zero`, and `interpolate` for line series - `null` and `zero` for bar series
orderOptions?	`object`	Chart order options (data and series)
outTimeZone?	`string`	Defines the IANA time zone used for temporal bin calculations Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
rotated?	`boolean`	Specifies whether or not the chart is rotated. Applied to Bar, Line, and Combo Bar and Line charts.
series	`WebChartHeatChartSeries`[]	The heat chart series
stackedType?	`WebChartStackedKinds`	Specifies how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or when multiple attributes/fields corresponding to the same set of classes are to be visualized. Currently this property is only used for bar and line series.
subtitle?	`WebChartText`	Specifies sub-heading/subtitle of the chart.
title?	`WebChartText`	Specifies heading/title of the chart.
type	`"chart"`	Represents a unique string identifier for the Chart object. For Chart object, it is chart.
version	`"24.3.0"`	Version of the specification. Used to identify when a saved config was created.
verticalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the vertical axis can't display them all. For XY Chart only. The available options are: "none" and "wrap". The default value for the vertical axis is "wrap".

WebRadarChart

Gives a JSON representation of the Radar Chart object.

Property	Type	Description
axes	[`WebChartRadarChartAxis`, `WebChartAxis`]	Array of two axes, one specific to the radar chart and the other one common to all charts
background?	`Color`	Specifies the background color of the chart.
chartRenderer?	`any`	Renderer to use to style the series when the chart uses the color match mode. Considered before the layer's renderer.
colorMatch?	`boolean`	Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc. To do so, this property needs to be set to `true`. When there is no matching color found (for when `colorMatch = true`) or when `colorMatch = false`, the colors from the config, and then from the color ramps will be used, in that order.
cursorCrosshair?	`WebChartCursorCrosshair`	Specifies cursor's crosshair information for the chart. Only for XY charts.
dataFilters?	`WebChartDataFilters`	Used to filter the chart's data while in Layer mode.
footer?	`WebChartText`	Specifies footer of the chart
horizontalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the horizontal axis can't display them all. The available options are: "none", "rotate", "stagger" and "wrap". For XY Chart only. Histogram can handle "none" and "rotate" only. The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
id?	`string`	Can be used to uniquely identify a chart. The consumer app can choose whether to use it or not.
iLayer?	`IFeatureLayer`	Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.
legend?	`WebChartLegend` \| `WebChartPieChartLegend`	Specifies the Legend information for the chart.
orderOptions?	`object`	Chart order options (data and series)
rotated?	`boolean`	Specifies whether or not the chart is rotated. Applied to Bar, Line, and Combo Bar and Line charts.
series	`WebChartRadarChartSeries`[]	The radar chart series
stackedType?	`WebChartStackedKinds`	Specifies how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or when multiple attributes/fields corresponding to the same set of classes are to be visualized. Currently this property is only used for bar and line series.
subtitle?	`WebChartText`	Specifies sub-heading/subtitle of the chart.
title?	`WebChartText`	Specifies heading/title of the chart.
type	`"chart"`	Represents a unique string identifier for the Chart object. For Chart object, it is chart.
version	`"24.3.0"`	Version of the specification. Used to identify when a saved config was created.
verticalAxisLabelsBehavior?	`WebChartLabelBehavior`	Represents the way the labels should behave when the vertical axis can't display them all. For XY Chart only. The available options are: "none" and "wrap". The default value for the vertical axis is "wrap".