PortalItem | References | ArcGIS Maps SDK for JavaScript

import PortalItem from "@arcgis/core/portal/PortalItem.js";

Inheritance:: PortalItem→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

An item (a unit of content) in the Portal. Each item has a unique identifier and a well known URL that is independent of the user owning the item. An item may have associated binary or textual data which is available via the item data resource. View the ArcGIS portal API REST documentation for the item for more details.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`PortalItemProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Example

// Typical usage
let item = new PortalItem({
  id: "affa021c51944b5694132b2d61fe1057"
});
item.load();

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`access`	`"private" \| "shared" \| "org" \| "public"`
`accessInformation`	`string \| null \| undefined`
`apiKey`	`string \| null \| undefined`
`applicationProxies` readonly	`ApplicationProxy[] \| null \| undefined`
`avgRating`	`number \| null \| undefined`
`categories`	`string[] \| null \| undefined`
`classification`	`Record<string, any> \| null \| undefined`
`created`	`Date \| null \| undefined`
`culture`	`string \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`description`	`string \| null \| undefined`
`extent`	`Extent \| null \| undefined`
`groupCategories`	`string[] \| null \| undefined`
`id`	`string \| null \| undefined`
`isLayer` readonly	`boolean`
`isOrgItem` readonly	`boolean`
`itemControl` readonly	`"admin" \| "update" \| "null" \| null \| undefined`
`itemPageUrl` readonly	`string \| null \| undefined`
`itemUrl` readonly	`string \| null \| undefined`
`licenseInfo`	`string \| null \| undefined`
`loaded` readonly	`boolean`
`loadError` readonly inherited	`EsriError \| null \| undefined`	LoadableMixin
`loadStatus` readonly inherited	`"not-loaded" \| "loading" \| "failed" \| "loaded"`	LoadableMixin
`loadWarnings` readonly inherited	`any[]`	LoadableMixin
`modified`	`Date \| null \| undefined`
`name`	`string \| null \| undefined`
`numComments`	`number \| null \| undefined`
`numRatings`	`number \| null \| undefined`
`numViews`	`number \| null \| undefined`
`owner`	`string \| null \| undefined`
`ownerFolder`	`string \| null \| undefined`
`portal`	`Portal`
`screenshots`	`string[] \| null \| undefined`
`size`	`number \| null \| undefined`
`snippet`	`string \| null \| undefined`
`sourceJSON`	`any`
`tags`	`string[] \| null \| undefined`
`thumbnailUrl` readonly	`string \| null \| undefined`
`title`	`string \| null \| undefined`
`type`	`string \| null \| undefined`
`typeKeywords`	`string[]`
`url`	`string \| null \| undefined`

access

Property

Type: "private" | "shared" | "org" | "public"

Indicates the level of access to this item: private, shared, org, or public.

accessInformation

Property

Type: string | null | undefined

Information on the source of the item and its copyright status.

apiKey

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.20

An authorization string used to access the portal item. Set this property when the portal item is secured and configured with API key authentication. This property will append the API key to all requests made to the portal item resources. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage.

See also

Item access privileges

Example

const portalItem = new PortalItem({
  id: "caa9bd9da1f4487cb4989824053bb847",
  // Set an API key to access a secure portal item configured with API key authentication.
  apiKey: "APIKEY"
});

applicationProxies

readonly Property

Type: ApplicationProxy[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

Contains an array of objects containing proxy information for premium platform services. This is most widely seen in registered applications that work with premium and subscriber services, e.g. routing and analysis services.

avgRating

Property

Type: number | null | undefined

Average rating. Uses a weighted average called "Bayesian average."

classification

Property

Type: Record<string, any> | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

The classification information for the item.

created

autocast Property

Type: Date | null | undefined

The date the item was created.

culture

Property

Type: string | null | undefined

The item's locale information (language and country).

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

description

Property

Type: string | null | undefined

The detailed description of the item.

extent

autocast Property

Type: Extent | null | undefined

The geographic extent, or bounding rectangle, of the item.

groupCategories

Property

Type: string[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

An array of group categories set on the item. This varies slightly from categories as it only returns categories in the group content returned from PortalGroup.queryItems().

id

Property

Type: string | null | undefined

The unique id for the item. You can typically find the id for an item in its url.

Example

// to access the portal item at this url
// http://www.arcgis.com/home/item.html?id=d7892b3c13b44391992ecd42bfa92d01
let item = new PortalItem({
  id: "d7892b3c13b44391992ecd42bfa92d01"
});

isLayer

readonly Property

Type: boolean

Indicates whether a layer can be created from this item using Layer.fromPortalItem().

Example

if (item.isLayer) {
  Layer.fromPortalItem({
    portalItem: item
  }).then(addLayerToMap);
}

isOrgItem

readonly Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.26

Indicates whether this item and the user whose credential was used to fetch this item belong to the same ArcGIS Enterprise Portal or ArcGIS Online Organization.

Default value: false

itemControl

readonly Property

Type: "admin" | "update" | "null" | null | undefined

Indicates whether an item can be updated and deleted.

Possible Value	Description
admin	The item can be updated or deleted.
update	The item can be updated, but not deleted.
null	The item cannot be updated nor deleted.

itemPageUrl

readonly Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.25

The URL to the Item page on the portal.

itemUrl

readonly Property

Type: string | null | undefined

The URL to the item.

licenseInfo

Property

Type: string | null | undefined

Information on license or restrictions related to the item.

loaded

readonly Property

Type: boolean

Indicates whether the item's resources have loaded from the portal. When true, all the properties of the object can be accessed.

Default value: false

loadError

readonlyinherited Property

Type: EsriError | null | undefined

Inherited from: LoadableMixin

The Error object returned if an error occurred while loading.

loadStatus

readonlyinherited Property

Type: "not-loaded" | "loading" | "failed" | "loaded"

Inherited from: LoadableMixin

Represents the status of a load() operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default value: "not-loaded"

loadWarnings

readonlyinherited Property

Type: any[]

Inherited from: LoadableMixin

A list of warnings which occurred while loading.

modified

autocast Property

Type: Date | null | undefined

The date the item was last modified.

name

Property

Type: string | null | undefined

The name of the item.

numComments

Property

Type: number | null | undefined

Number of comments on the item.

numRatings

Property

Type: number | null | undefined

Number of ratings on the item.

numViews

Property

Type: number | null | undefined

Number of views on the item.

owner

Property

Type: string | null | undefined

The username of the user who owns this item.

ownerFolder

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.12

The ID of the folder in which the owner has stored the item. This is only returned to the item owner or the org administrator.

portal

autocast Property

Type: Portal

The portal that contains the item. It uses Portal.getDefault(). This, in turn, obtains the URL from Config. It's suggested to use Config instead of this property. If needing to work with multiple portal instances, either set the portal's Portal.url directly within the PortalItem or create separate portal instances before passing them into the PortalItem.portal property. Both examples are shown below.

Layer.fromPortalItem({
  portalItem: {
    id: "e691172598f04ea8881cd2a4adaa45ba",
    // autocastable to Portal
    portal: {
      url: "https://thePortalUrl"
    }
  }
});

let portalA = new Portal({
  url: "https://www.exampleA.com/arcgis" // First instance
});

let portalB = new Portal({
  url: "https://www.exampleB.com/arcgis" // Second instance
});

let item = new PortalItem({
  id: "e691172598f04ea8881cd2a4adaa45ba",
  portal: portalA // This loads the first portal instance set above
});

item.load();

screenshots

Property

Type: string[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

An array of string URLs. These URLs should point to screenshots (i.e. screen captures) associated with an application.

An example value could be something similar to "screenshots/Basic.png".

size

Property

Type: number | null | undefined

The size of the item (in bytes).

snippet

Property

Type: string | null | undefined

A summary description of the item.

sourceJSON

Property

Type: any

Since: ArcGIS Maps SDK for JavaScript 4.13

The JSON used to create the property values when the PortalItem is loaded. Although most commonly used properties are exposed on the PortalItem class directly, this provides access to all information returned by the portal item. This property is useful if working in an application built using an older version of the API which requires access to a portal's item properties from a more recent version.

See also

ArcGIS REST API - Item

thumbnailUrl

readonly Property

Type: string | null | undefined

The URL to the thumbnail used for the item.

See also

getThumbnailUrl()

title

Property

Type: string | null | undefined

The title for the item. This is the name that is displayed to users and used to refer to the item. Every item must have a title.

type

Property

Type: string | null | undefined

The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See the ArcGIS REST API Items and Items Types Reference to get an understanding of the item type hierarchy.

Examples

portalItem.type = "Web Map";

portalItem.type = "Web Mapping Application";

typeKeywords

Property

Type: string[]

Type keywords that describe the type of content of this item.

url

Property

Type: string | null | undefined

The service URL of this item. Only certain layer item types such as "Feature Service", "Map Service", "Image Service", "Scene Service", "WMS" and "KML" have service URLs.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`addRating`	`addRating(rating: number \| PortalRating): Promise<PortalRating \| null \| undefined>`
`addResource`	`addResource(resource: PortalItemResource, content: Blob, options?: PortalItemResourceAddOrUpdateOptions): Promise<PortalItemResource>`
`cancelLoad` inherited	`cancelLoad(): this`	LoadableMixin
`clone`	`clone(): PortalItem`
`deleteRating`	`deleteRating(): Promise<void>`
`destroy`	`destroy(): void`
`fetchData`	`fetchData<T>(responseType?: RequestOptions["responseType"], options?: AbortOptions \| null \| undefined): Promise<T>`
`fetchRating`	`fetchRating(options?: AbortOptions): Promise<PortalRating \| null \| undefined>`
`fetchRelatedItems`	`fetchRelatedItems(params: FetchRelatedItemsParameters, options?: AbortOptions \| null \| undefined): Promise<PortalItem[]>`
`fetchResources`	`fetchResources(params?: FetchResourcesParameters, options?: AbortOptions \| null \| undefined): Promise<FetchResourcesResult>`
`getThumbnailUrl`	`getThumbnailUrl(width?: number): string \| null \| undefined`
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`load` inherited	`load(options?: AbortOptions \| null \| undefined): Promise<this>`	LoadableMixin
`reload`	`reload(): Promise<PortalItem>`
`removeAllResources`	`removeAllResources(options?: AbortOptions): Promise<void>`
`removeResource`	`removeResource(resource: PortalItemResource, options?: AbortOptions): Promise<void>`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin
`update`	`update(params?: ItemUpdateParameters): Promise<PortalItem>`
`updateThumbnail`	`updateThumbnail(params: PortalItemUpdateThumbnailParameters): Promise<PortalItem>`
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

addRating

Method

Signature: addRating (rating: number | PortalRating): Promise<PortalRating | null | undefined>

Adds a rating to an accessible item.

Parameters

Parameter	Type	Description	Required
rating	`number \| PortalRating`	Rating to set for the item. Rating must be a number between 1.0 and 5.0.

Returns: Promise<PortalRating | null | undefined>
When resolved, a PortalRating is returned.

addResource

Method

Signature: addResource (resource: PortalItemResource, content: Blob, options?: PortalItemResourceAddOrUpdateOptions): Promise<PortalItemResource>

Since: ArcGIS Maps SDK for JavaScript 4.16

Adds a new resource to the portal item.

See also

ArcGIS REST API - Add Resources

Parameters

Parameter	Type	Description
resource	`PortalItemResource`	The resource to add to the portal item.
content	`Blob`	The resource content.
options	`PortalItemResourceAddOrUpdateOptions`	An object wih the following properties.

Returns: Promise<PortalItemResource>
When resolved, returns the PortalItemResource.

Example

// The following snippet assumes you have an existing portal item instance
// that you are allowed to modify

// An example of an object that we would like to store as a resource
const definition = { type: "world", description: "A world definition" };

const resource = new PortalItemResource({ path: "definitions/world.json" });

// Resource content is always passed as a blob. Define a blob that contains our definition
// in JSON encoding
const content = new Blob([JSON.stringify(definition)], { type: "application/json" });

portalItem.addResource(resource, content)
  .then(function () {
    console.log("Successfully added resource", resource.url);
  })
  .catch(function (error) {
    console.error("Failed to add resource", error);
  });

cancelLoad

inherited Method

Signature: cancelLoad (): this

Inherited from: LoadableMixin

Cancels a load() operation if it is already in progress.

Returns: this

clone

Method

Signature: clone (): PortalItem

Since: ArcGIS Maps SDK for JavaScript 4.12

Creates a clone of this object. It is a deep clone except for the portal property.

Returns: PortalItem
A clone of the PortalItem instance that invoked this method.

deleteRating

Method

Signature: deleteRating (): Promise<void>

Deletes a rating for the specified item.

Returns: Promise<void>
Resolved when the rating successfully deletes.

destroy

Method

Signature: destroy (): void

Since: ArcGIS Maps SDK for JavaScript 4.17

Destroys the portal item, and any associated resources, including its associated portal. These can no longer be used once the portal item has been destroyed. To prevent these objects from being destroyed, remove them from the portal item before calling destroy().

// unset the portal from the portal item so that it is not destroyed
const portal = portalItem.portal;
portalItem.portal = null;

// destroy the portal item and any remaining associated resources
portalItem.destroy();

See also

Returns: void

fetchData

Method

Signature: fetchData <T>(responseType?: RequestOptions["responseType"], options?: AbortOptions | null | undefined): Promise<T>

Type parameters: <T>

Requests a PortalItem in the format specified in responseType.

Parameters

Parameter	Type	Description	Required
responseType	`RequestOptions["responseType"]`	= json - The format of the response.
options	`AbortOptions \| null \| undefined`	An object with the following properties.

Returns: Promise
When resolved, returns the requested data.

fetchRating

Method

Signature: fetchRating (options?: AbortOptions): Promise<PortalRating | null | undefined>

Returns the rating (if any) given to the item.

Parameters

Parameter	Type	Description	Required
options	`AbortOptions`	An object with the following properties.

Returns: Promise<PortalRating | null | undefined>
When resolved, a PortalRating is returned.

fetchRelatedItems

Method

Signature: fetchRelatedItems (params: FetchRelatedItemsParameters, options?: AbortOptions | null | undefined): Promise<PortalItem[]>

Gets all the related items of a certain relationship type for the portal item. An optional direction can be specified if the direction of the relationship is ambiguous. Otherwise, the service will try to infer it.

Parameters

Parameter	Type	Description	Required
params	`FetchRelatedItemsParameters`	See the object specifications table below for the parameters that may be passed as properties in this object.
options	`AbortOptions \| null \| undefined`	An object with the following properties.

Returns: Promise<PortalItem[]>
When resolved, resolves to an array of the related PortalItem.

Example

let queryParam = {
   relationshipType: "Service2Data"
};

portalItem.fetchRelatedItems(queryParam).then(function(results){
   console.log("related portal item", results);
});

fetchResources

Method

Signature: fetchResources (params?: FetchResourcesParameters, options?: AbortOptions | null | undefined): Promise<FetchResourcesResult>

Since: ArcGIS Maps SDK for JavaScript 4.16

Retrieves references to all the portal item resources.

See also

ArcGIS REST API- Item Resources

Parameters

Parameter	Type	Description	Required
params	`FetchResourcesParameters`	The fetch parameters used to retrieve portal item resources.
options	`AbortOptions \| null \| undefined`	Additional options with the following properties.

Returns: Promise<FetchResourcesResult>
Resolves with an object containing the item resources.

Example

portalItem.fetchResources().then(function(result) {
   console.log("next start index: ", result.nextStart);

   result.resources.forEach(function(item) {
     console.log("resource:", item.resource.path, "size:", item.size);
   });
});

getThumbnailUrl

Method

Signature: getThumbnailUrl (width?: number): string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.4

Get the URL to the thumbnail image for the item.

Available width sizes: 200, 400, 800 and 2400.

Parameters

Parameter	Type	Description	Required
width	`number`	The desired image width.

Returns: string | null | undefined
The URL to the thumbnail image.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

load

inherited Method

Signature: load (options?: AbortOptions | null | undefined): Promise<this>

Inherited from: LoadableMixin

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad() can abort it.

Parameters

Parameter	Type	Description	Required
options	`AbortOptions \| null \| undefined`	Additional options.

Returns: Promise<this>
Resolves when the resources have loaded.

reload

Method

Signature: reload (): Promise<PortalItem>

Since: ArcGIS Maps SDK for JavaScript 4.14

Reloads a loaded item's properties from the portal.

Returns: Promise<PortalItem>
Resolves when the portal item's properties have been reloaded.

removeAllResources

Method

Signature: removeAllResources (options?: AbortOptions): Promise<void>

Since: ArcGIS Maps SDK for JavaScript 4.16

Removes all the resources from the portal item.

See also

ArcGIS REST API - Remove Resources

Parameters

Parameter	Type	Description	Required
options	`AbortOptions`	An object with the following properties.

Returns: Promise<void>
Resolves when all the resources have been removed successfully.

removeResource

Method

Signature: removeResource (resource: PortalItemResource, options?: AbortOptions): Promise<void>

Since: ArcGIS Maps SDK for JavaScript 4.16

Removes a resource from the portal item.

See also

ArcGIS REST API - Remove Resources

Parameters

Parameter	Type	Description	Required
resource	`PortalItemResource`	The resource to remove from the portal item.
options	`AbortOptions`	An object wih the following properties.

Returns: Promise<void>
Resolves when the remove operation has completed.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

update

Method

Signature: update (params?: ItemUpdateParameters): Promise<PortalItem>

Updates the item's properties to the portal, and optionally its data.

Parameters

Parameter	Type	Description	Required
params	`ItemUpdateParameters`	See the object specifications table below for the parameters that may be passed as properties in this object.

Returns: Promise<PortalItem>
Resolves when the portal item's properties have been updated.

updateThumbnail

Method

Signature: updateThumbnail (params: PortalItemUpdateThumbnailParameters): Promise<PortalItem>

Since: ArcGIS Maps SDK for JavaScript 4.5

Updates the item's thumbnail on the portal.

Parameters

Parameter	Type	Description	Required
params	`PortalItemUpdateThumbnailParameters`	See the object specification table below for the parameters that may be passed as properties in this object.

Returns: Promise<PortalItem>
Resolves when the portal item's thumbnail has been updated.

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

Since: ArcGIS Maps SDK for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled executes when the instance of the class loads. The onRejected executes if the instance of the class fails to load.

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});