Packages
Version 3.6.0@esri/arcgis-rest-auth
Authentication helpers for @esri/arcgis-rest-js.
npm install:
npm install @esri/arcgis-rest-auth @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
UserSession,
ApplicationSession
} from "@esri/arcgis-rest-auth";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-auth@3.6.0/dist/umd/auth.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-auth@3.6.0/dist/umd/auth.umd.min.js" integrity="sha384-7Em1nFlvogyhnCNL0MnwVYCuKHbr/rlzgToUT4D2i2/4JQgHwqhLwWovhb8CtvPh" crossorigin="anonymous"></script>
- ApiKey
- ApplicationSession
- UserSession
- exchangeToken
- canUseOnlineToken
- getOnlineEnvironment
- isFederated
- isOnline
- normalizeOnlinePortalUrl
- fetchToken
- generateToken
- validateAppAccess
- AuthenticationProvider
- IApiKeyOptions
- IApplicationSessionOptions
- ICredential
- IOAuth2Options
- IUserSessionOptions
- IAuthenticatedRequestOptions
- IUserRequestOptions
- IFetchTokenResponse
- IGenerateTokenResponse
- IAppAccess
Version 3.6.0
@esri/arcgis-rest-demographics
Demographics data helpers for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-demographics @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
getAvailableCountries,
getAvailableDataCollections,
getAvailableGeographyLevels,
getGeography,
queryDemographicData,
} from "@esri/arcgis-rest-demographics";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-demographics@3.6.0/dist/umd/demographics.umd.min.js"></script>
CDN with SRI:
- getAvailableCountries
- getAvailableDataCollections
- getAvailableGeographyLevels
- getGeography
- queryDemographicData
- ARCGIS_ONLINE_GEOENRICHMENT_URL
- ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL
- IApportionmentThreshold
- ICountry
- IGetAvailableCountriesOptions
- IGetAvailableCountriesResponse
- IHierarchy
- ILevelsInfo
- IVariablesInfo
- ICategory
- IDataCollection
- IDataInfo
- IFilter
- IFilteringTag
- IGetAvailableDataCollectionsOptions
- IGetAvailableDataCollectionsResponse
- IMetadata
- IBranch
- IDataset
- IGeographyLevel
- IGeographyLevelHierarchy
- IGetAvailableGeographyLevelsResponse
- ILevel
- IGetGeographyOptions
- IGetGeographyResponse
- IEndpointOptions
- IGeoenrichmentResult
- IQueryDemographicDataOptions
- IQueryDemographicDataResponse
Version 3.6.0
@esri/arcgis-rest-feature-layer
Feature layer query and edit helpers for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-feature-layer @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
addFeatures,
addAttachment,
applyEdits,
decodeValues,
deleteFeatures,
deleteAttachments,
getAllLayersAndTables,
getAttachments,
getLayer,
getService,
parseServiceUrl,
getFeature,
queryFeatures,
queryRelated,
updateFeatures,
updateAttachment,
} from "@esri/arcgis-rest-feature-layer";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-feature-layer@3.6.0/dist/umd/feature-layer.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-feature-layer@3.6.0/dist/umd/feature-layer.umd.min.js" integrity="sha384-G1cfompQwS/O57crskYv9WazDiJmAVfMEhIbti94x9zxezVMZKzzBRIAA+7urF32" crossorigin="anonymous"></script>
- addFeatures
- addAttachment
- applyEdits
- decodeValues
- deleteFeatures
- deleteAttachments
- getAllLayersAndTables
- getAttachments
- getLayer
- getService
- parseServiceUrl
- getFeature
- queryFeatures
- queryRelated
- updateFeatures
- updateAttachment
- IAddFeaturesOptions
- IAddAttachmentOptions
- IApplyEditsOptions
- IDecodeValuesOptions
- IDeleteFeaturesOptions
- IDeleteAttachmentsOptions
- IAllLayersAndTablesResponse
- IAttachmentInfo
- IGetAttachmentsOptions
- IApplyEditsAttachmentResult
- IApplyEditsResult
- IEditFeatureResult
- IGetLayerOptions
- ISharedEditOptions
- ISharedQueryOptions
- IGetFeatureOptions
- IQueryFeaturesOptions
- IQueryFeaturesResponse
- IQueryResponse
- IQueryRelatedOptions
- IQueryRelatedResponse
- IRelatedRecordGroup
- IUpdateFeaturesOptions
- IUpdateAttachmentOptions
Version 3.6.0
@esri/arcgis-rest-geocoding
Geocoding helpers for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-geocoding @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
bulkGeocode,
geocode,
getGeocodeService,
reverseGeocode,
suggest,
} from "@esri/arcgis-rest-geocoding";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.6.0/dist/umd/geocoding.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.6.0/dist/umd/geocoding.umd.min.js" integrity="sha384-CNPgbfmNeZ6S6+pzWHZ41henEUQ/P+1aeFHlfiqkNyBk4rjOu+Eha+aO8jnvP137" crossorigin="anonymous"></script>
- bulkGeocode
- geocode
- getGeocodeService
- reverseGeocode
- suggest
- ARCGIS_ONLINE_BULK_GEOCODING_URL
- ARCGIS_ONLINE_GEOCODING_URL
- IAddressBulk
- IBulkGeocodeOptions
- IBulkGeocodeResponse
- IGeocodeOptions
- IGeocodeResponse
- IEndpointOptions
- IGetGeocodeServiceResponse
- IReverseGeocodeResponse
- ISuggestResponse
Version 3.6.0
@esri/arcgis-rest-portal
ArcGIS Online and Enterprise content and user helpers for @esri/arcgis-rest-request
npm install:
npm install @esri/arcgis-rest-portal @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
SearchQueryBuilder,
addGroupUsers,
createGroup,
getGroup,
getGroupCategorySchema,
getGroupContent,
getGroupUsers,
searchGroupUsers,
inviteGroupUsers,
joinGroup,
leaveGroup,
createGroupNotification,
protectGroup,
unprotectGroup,
removeGroup,
removeGroupUsers,
searchGroupContent,
searchGroups,
updateGroup,
updateUserMemberships,
addItemData,
addItemRelationship,
addItemResource,
getUserContent,
createFolder,
createItem,
createItemInFolder,
exportItem,
getItem,
getItemBaseUrl,
getItemData,
getItemGroups,
getItemInfo,
getItemMetadata,
getItemParts,
getItemResource,
getItemResources,
getItemStatus,
getRelatedItems,
bboxToString,
isBBox,
serializeItem,
protectItem,
unprotectItem,
reassignItem,
removeFolder,
removeItem,
removeItemRelationship,
removeItemResource,
searchItems,
moveItem,
updateItem,
updateItemInfo,
updateItemResource,
addItemPart,
cancelItemUpload,
commitItemUpload,
createOrgNotification,
getUniqueServiceName,
isServiceNameAvailable,
setItemAccess,
getSharingUrl,
getUserMembership,
isItemSharedWithGroup,
ensureMembership,
shareItemWithGroup,
unshareItemWithGroup,
getUser,
getUserProperties,
getUserTags,
getUserUrl,
acceptInvitation,
declineInvitation,
getUserInvitation,
getUserInvitations,
getUserNotifications,
removeNotification,
searchUsers,
setUserProperties,
updateUser,
chunk,
getPortal,
getSelf,
getPortalSettings,
getPortalUrl,
getSubscriptionInfo,
scrubControlChars,
} from "@esri/arcgis-rest-portal";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-portal@3.6.0/dist/umd/portal.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-portal@3.6.0/dist/umd/portal.umd.min.js" integrity="sha384-NkumG2sqfbJiwPDQZzjg91GyiwcIHw0LAymYm1OIFkdCEzukcex2vt1Ve0yP+AVS" crossorigin="anonymous"></script>
- SearchQueryBuilder
- addGroupUsers
- createGroup
- getGroup
- getGroupCategorySchema
- getGroupContent
- getGroupUsers
- searchGroupUsers
- inviteGroupUsers
- joinGroup
- leaveGroup
- createGroupNotification
- protectGroup
- unprotectGroup
- removeGroup
- removeGroupUsers
- searchGroupContent
- searchGroups
- updateGroup
- updateUserMemberships
- addItemData
- addItemRelationship
- addItemResource
- getUserContent
- createFolder
- createItem
- createItemInFolder
- exportItem
- getItem
- getItemBaseUrl
- getItemData
- getItemGroups
- getItemInfo
- getItemMetadata
- getItemParts
- getItemResource
- getItemResources
- getItemStatus
- getRelatedItems
- bboxToString
- isBBox
- serializeItem
- protectItem
- unprotectItem
- reassignItem
- removeFolder
- removeItem
- removeItemRelationship
- removeItemResource
- searchItems
- moveItem
- updateItem
- updateItemInfo
- updateItemResource
- addItemPart
- cancelItemUpload
- commitItemUpload
- createOrgNotification
- getUniqueServiceName
- isServiceNameAvailable
- setItemAccess
- getSharingUrl
- getUserMembership
- isItemSharedWithGroup
- ensureMembership
- shareItemWithGroup
- unshareItemWithGroup
- getUser
- getUserProperties
- getUserTags
- getUserUrl
- acceptInvitation
- declineInvitation
- getUserInvitation
- getUserInvitations
- getUserNotifications
- removeNotification
- searchUsers
- setUserProperties
- updateUser
- chunk
- getPortal
- getSelf
- getPortalSettings
- getPortalUrl
- getSubscriptionInfo
- scrubControlChars
- NotificationChannelType
- UnixTime
- FetchReadMethodName
- ItemRelationshipType
- IAddGroupUsersOptions
- IAddGroupUsersResult
- ICreateGroupOptions
- IGetGroupContentOptions
- IGroupCategory
- IGroupCategorySchema
- IGroupContentResult
- IGroupUsersResult
- ISearchGroupUsersOptions
- ISearchGroupUsersResult
- IUserGroupOptions
- IInviteGroupUsersOptions
- IInviteGroupUsersResult
- ICreateGroupNotificationOptions
- IRemoveGroupUsersOptions
- IRemoveGroupUsersResult
- IUpdateGroupOptions
- IUpdateGroupUsersOptions
- IUpdateGroupUsersResult
- IAddItemDataOptions
- IUserContentRequestOptions
- IUserContentResponse
- ICreateFolderOptions
- ICreateItemOptions
- ICreateItemResponse
- IExportItemRequestOptions
- IExportItemResponse
- IExportLayerInfo
- IExportParameters
- IGetItemGroupsResponse
- IGetItemInfoOptions
- IGetItemPartsResponse
- IGetItemResourceOptions
- IGetItemStatusResponse
- IGetRelatedItemsResponse
- IItemStatusOptions
- IAddFolderResponse
- ICreateUpdateItemOptions
- IFolderIdOptions
- IItemDataOptions
- IItemInfoOptions
- IItemInfoResponse
- IItemPartOptions
- IItemRelationshipOptions
- IItemResourceOptions
- IItemResourceResponse
- IManageItemRelationshipOptions
- IMoveItemResponse
- IRemoveItemResourceOptions
- IUpdateItemResponse
- IUserItemOptions
- IMoveItemOptions
- IUpdateItemOptions
- ICommitItemOptions
- ICreateOrgNotificationOptions
- ICreateOrgNotificationResult
- ISetAccessOptions
- IGroupSharingOptions
- ISharingOptions
- ISharingResponse
- IGetUserOptions
- IUserProperties
- IGetUserTagsResponse
- ITagCount
- IGetUserInvitationOptions
- IInvitation
- IInvitationResult
- INotification
- INotificationResult
- IRemoveNotificationOptions
- IUserSearchOptions
- IUpdateUserOptions
- IUpdateUserResponse
- IPortal
- IPortalSettings
- ISubscriptionInfo
- ISearchGroupContentOptions
- ISearchOptions
- ISearchResult
Version 3.6.0
@esri/arcgis-rest-request
Common methods and utilities for @esri/arcgis-rest-js packages.
npm install:
npm install @esri/arcgis-rest-request
Module Import:
import {
request
} from "@esri/arcgis-rest-request";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-request@3.6.0/dist/umd/request.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-request@3.6.0/dist/umd/request.umd.min.js" integrity="sha384-UjSGsDWSs+t5lxbhsn/ZnF7bu+bePBOe8OXhlsFPS5ZXAfkJvklV6yyp4mPem21K" crossorigin="anonymous"></script>
- ArcGISAuthError
- ArcGISRequestError
- request
- setDefaultRequestOptions
- decodeParam
- decodeQueryString
- withOptions
- NODEJS_DEFAULT_REFERER_HEADER
- ErrorTypes
- GrantTypes
- HTTPMethods
- ResponseFormats
- IRetryAuthError
- IAuthenticationManager
- IFetchTokenParams
- IGenerateTokenParams
- IParamBuilder
- IParams
- IParamsBuilder
- IRequestOptions
- ITokenRequestOptions
Version 3.6.0
@esri/arcgis-rest-routing
Routing helpers for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-routing @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
closestFacility,
decompressGeometry,
isFeatureSet,
normalizeLocationsList,
originDestinationMatrix,
serviceArea,
solveRoute,
} from "@esri/arcgis-rest-routing";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-routing@3.6.0/dist/umd/routing.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-routing@3.6.0/dist/umd/routing.umd.min.js" integrity="sha384-D0RNbspRFvx/R0mk2vMppwUM/276BMmNvyNm7MgOTnyTatoKkMKn07V0ZJdNdlXw" crossorigin="anonymous"></script>
- closestFacility
- decompressGeometry
- isFeatureSet
- normalizeLocationsList
- originDestinationMatrix
- serviceArea
- solveRoute
- ARCGIS_ONLINE_CLOSEST_FACILITY_URL
- ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL
- ARCGIS_ONLINE_ROUTING_URL
- ARCGIS_ONLINE_SERVICE_AREA_URL
- IClosestFacilityOptions
- IClosestFacilityResponse
- IEndpointOptions
- IOriginDestinationMatrixOptions
- IOriginDestinationMatrixResponse
- IServiceAreaOptions
- IServiceAreaResponse
- ISolveRouteOptions
- ISolveRouteResponse
Version 3.6.0
@esri/arcgis-rest-service-admin
Service administration helpers for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-service-admin @esri/arcgis-rest-auth@^3.0.0 @esri/arcgis-rest-portal@^3.0.0 @esri/arcgis-rest-request@^3.0.0
Module Import:
import {
addToServiceDefinition,
createFeatureService,
getServiceAdminInfo,
getViewSources,
updateServiceDefinition,
} from "@esri/arcgis-rest-service-admin";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-service-admin@3.6.0/dist/umd/service-admin.umd.min.js"></script>
CDN with SRI:
<script src="https://unpkg.com/@esri/arcgis-rest-service-admin@3.6.0/dist/umd/service-admin.umd.min.js" integrity="sha384-QkPVHnJhPNAAKdroiReihfC3PCY49lzK0KeIJlnDYDF/9HulzTcXX+WXG6yykDAa" crossorigin="anonymous"></script>
- addToServiceDefinition
- createFeatureService
- getServiceAdminInfo
- getViewSources
- updateServiceDefinition
- IAddToServiceDefinitionItemSummary
- IAddToServiceDefinitionOptions
- IAddToServiceDefinitionResult
- ICreateServiceOptions
- ICreateServiceParams
- ICreateServiceResult
- IUpdateServiceDefinitionOptions
- IUpdateServiceDefinitionResult
Version 3.6.0
@esri/arcgis-rest-types
Shared TypeScript types for @esri/arcgis-rest-js
npm install:
npm install @esri/arcgis-rest-types
Module Import:
import {
IUser, IItem
} from "@esri/arcgis-rest-types";
CDN:
<script src="https://unpkg.com/@esri/arcgis-rest-types@3.6.0/dist/umd/types.umd.min.js"></script>
CDN with SRI:
- ElipticArc
- GeometryType
- JsonCurve
- Position
- Position2D
- SpatialRelationship
- Units
- GroupMembership
- Color
- SimpleFillSymbolStyle
- SimpleLineSymbolStyle
- SimpleMarkerSymbolStyle
- SymbolType
- DomainType
- FeatureEditTool
- FieldType
- ICodedValue
- IDomain
- IFeature
- IFeatureSet
- IArc
- IBezierCurve
- ICircularArc
- IEnvelope
- IExtent
- IGeometry
- IHasZM
- ILocation
- IMultipoint
- IOldCircularArc
- IPoint
- IPolygon
- IPolygonWithCurves
- IPolyline
- IPolylineWithCurves
- ISpatialReference
- IGroup
- IGroupAdd
- IFolder
- IItem
- IItemAdd
- IItemUpdate
- IFeatureServiceDefinition
- IServiceInfo
- IServiceNameAvailable
- IViewServiceSource
- IViewServiceSources
- IStatisticDefinition
- IFont
- IMarkerSymbol
- IPictureFillSymbol
- IPictureMarkerSymbol
- IPictureSourced
- ISimpleFillSymbol
- ISimpleLineSymbol
- ISimpleMarkerSymbol
- ISymbol
- ITextSymbol
- IUser
- IApplicationProperties
- IArcGisStreamLayer
- IBaseMap
- IBingLayer
- IBookmark
- IChildLayer
- ICsvLayer
- IDefinitionEditor
- IDefinitionInput
- IDefinitionParameter
- IDrawingInfo
- IEditableLayers
- IEditingInfo
- IEditingProperties
- IEnableable
- IExclusionArea
- IFeatureLayer
- IField
- IFieldFormat
- IFieldInfo
- IGeoRssLayer
- IImageServiceLayer
- IImageVectorLayer
- IKmlLayer
- ILayer
- ILayerDefinition
- ILocationTracking
- ILocationTrackingInfo
- ILod
- IMapLocation
- IMapRangeInfo
- IMapServiceLayer
- IMediaInfo
- IMediaInfoValue
- IOfflineInfo
- IOpenStreetMapLayer
- IOrderByField
- IPagedResponse
- IPagingParams
- IPopupElement
- IPopupExpressionInfo
- IPopupInfo
- IPresentation
- IRange
- IReadOnlyLayers
- IRelatedRecordsInfo
- ISearch
- ISlide
- ISupportsTime
- ITable
- ITemplate
- IThematicGroup
- ITileInfo
- ITiledImageServiceLayer
- ITiledMapServiceLayer
- ITimeSlider
- ITimeSliderProperties
- ITypeInfo
- ITypeInfoDomain
- IVectorTileLayer
- IViewingInfo
- IVisibleLayer
- IVisiblePopup
- IWebMapBackground
- IWebMapTileServiceInfo
- IWebTiledLayer
- IWebmap
- IWidget