import type { IFeature, IFeatureSet, IEnvelope, GeometryType, SpatialRelationship } from "@arcgis/charts-components/spec/rest-js-types.js";Type definitions
IFeature
a spatial entity and its corresponding properties
IFeature can also be imported from the following packages:
import { IFeature } from "@esri/arcgis-rest-feature-layer";import { IFeature } from "@esri/arcgis-rest-routing"; IFeatureSet
IFeatureSet can also be imported from the following packages:
import { IFeatureSet } from "@esri/arcgis-rest-feature-layer";- Supertypes
- IHasZM
features
- Type
- IFeature[]
IEnvelope
An envelope is a rectangle defined by a range of values for each coordinate and attribute.
- Supertypes
- IGeometry
xmin
- Type
- number
xmax
- Type
- number
ymin
- Type
- number
ymax
- Type
- number
GeometryType
GeometryType can also be imported from the following packages:
import { GeometryType } from "@esri/arcgis-rest-feature-layer";- Type
- "esriGeometryEnvelope" | "esriGeometryMultipoint" | "esriGeometryPoint" | "esriGeometryPolygon" | "esriGeometryPolyline"
SpatialRelationship
The spatial relationship used to compare input geometries
SpatialRelationship can also be imported from the following packages:
import { SpatialRelationship } from "@esri/arcgis-rest-feature-layer";- Type
- "esriSpatialRelContains" | "esriSpatialRelCrosses" | "esriSpatialRelEnvelopeIntersects" | "esriSpatialRelIndexIntersects" | "esriSpatialRelIntersects" | "esriSpatialRelOverlaps" | "esriSpatialRelTouches" | "esriSpatialRelWithin"
IExtent
Extents are used to define rectangles and bounding boxes.
IExtent can also be imported from the following packages:
import { IExtent } from "@esri/arcgis-rest-geocoding";import { IExtent } from "@esri/arcgis-rest-service-admin";import { IExtent } from "@esri/arcgis-rest-feature-layer"; xmin
- Type
- number
ymin
- Type
- number
xmax
- Type
- number
ymax
- Type
- number
spatialReference
- Type
- ISpatialReference | undefined
JsonCurve
- Type
- IArc | IBezierCurve | ICircularArc | IOldCircularArc
Units
Units can also be imported from the following packages:
import { Units } from "@esri/arcgis-rest-feature-layer";- Type
- "esriSRUnit_Foot" | "esriSRUnit_Kilometer" | "esriSRUnit_Meter" | "esriSRUnit_NauticalMile" | "esriSRUnit_StatuteMile" | "esriSRUnit_USNauticalMile"
IStatisticDefinition
outStatisticFieldName
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 outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
IFont
style
- Type
- "italic" | "normal" | "oblique" | undefined
weight
- Type
- "bold" | "bolder" | "lighter" | "normal" | undefined
decoration
- Type
- "line-through" | "none" | "underline" | undefined
SimpleMarkerSymbolStyle
- Type
- "esriSMSCircle" | "esriSMSCross" | "esriSMSDiamond" | "esriSMSSquare" | "esriSMSTriangle" | "esriSMSX"
SimpleLineSymbolStyle
- Type
- "esriSLSDash" | "esriSLSDashDot" | "esriSLSDashDotDot" | "esriSLSDot" | "esriSLSNull" | "esriSLSSolid"
SimpleFillSymbolStyle
- Type
- "esriSFSBackwardDiagonal" | "esriSFSCross" | "esriSFSDiagonalCross" | "esriSFSForwardDiagonal" | "esriSFSHorizontal" | "esriSFSNull" | "esriSFSSolid" | "esriSFSVertical"
SymbolType
- Type
- "esriPFS" | "esriPMS" | "esriSFS" | "esriSLS" | "esriSMS" | "esriTS"
ISimpleFillSymbol
- Supertypes
- ISymbol
style
- Type
- SimpleFillSymbolStyle | undefined
outline
- Type
- ISimpleLineSymbol | undefined
ISimpleLineSymbol
- Supertypes
- ISymbol
style
- Type
- SimpleLineSymbolStyle | undefined
ISimpleMarkerSymbol
- Supertypes
- IMarkerSymbol
style
- Type
- SimpleMarkerSymbolStyle | undefined
outline
- Type
- ISimpleLineSymbol | undefined
ITextSymbol
- Supertypes
- IMarkerSymbol
verticalAlignment
- Type
- "baseline" | "bottom" | "middle" | "top" | undefined
horizontalAlignment
- Type
- "center" | "justify" | "left" | "right" | undefined
IField
Contains information about an attribute field.
IField can also be imported from the following packages:
import { IField } from "@esri/arcgis-rest-feature-layer"; IDefinitionParameter
type
- Type
- "esriFieldTypeBlob" | "esriFieldTypeDate" | "esriFieldTypeDateOnly" | "esriFieldTypeDouble" | "esriFieldTypeGeometry" | "esriFieldTypeGlobalID" | "esriFieldTypeGUID" | "esriFieldTypeInteger" | "esriFieldTypeOID" | "esriFieldTypeRaster" | "esriFieldTypeSingle" | "esriFieldTypeSmallInteger" | "esriFieldTypeString" | "esriFieldTypeTimeOnly" | "esriFieldTypeTimestampOffset" | "esriFieldTypeXML" | undefined
The field type for the specified field parameter.
ILayerDefinition
ILayerDefinition can also be imported from the following packages:
import { ILayerDefinition } from "@esri/arcgis-rest-service-admin";import { ILayerDefinition } from "@esri/arcgis-rest-feature-layer";- Supertypes
- IHasZM
editingInfo
- Type
- IEditingInfo | undefined
An object defining the editing info (last edit date).
geometryType
- Type
- GeometryType | undefined
A string defining the type of geometry. Possible geometry types are: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryEnvelope.
htmlPopupType
- Type
- "esriServerHTMLPopupTypeAsHTMLText" | "esriServerHTMLPopupTypeAsURL" | "esriServerHTMLPopupTypeNone" | undefined
String value indicating the HTML popup type.
spatialReference
- Type
- ISpatialReference | undefined
An object containing the WKID or WKT identifying the spatial reference of the layer's geometry.
type
- Type
- "Feature Layer" | "Table" | undefined
Indicates whether the layerDefinition applies to a Feature Layer or a Table.
advancedQueryCapabilities
- Type
- { supportsPagination?: boolean; supportsTrueCurve?: boolean; supportsQueryWithDistance?: boolean; supportsReturningQueryExtent?: boolean; supportsStatistics?: boolean; supportsOrderBy?: boolean; supportsDistinct?: boolean; supportsSqlExpression?: boolean; supportsPercentileStatistics?: boolean; } | undefined
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.
drawingTool
- Type
- FeatureEditTool | undefined
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.