Property Overview

Property Details

accessString

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

accessInformationString

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

applicationProxiesObject[]readonly

Since: ArcGIS API 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.

Properties:

sourceUrl String The URL of the premium map service layer.

proxyUrl String The proxy URL for the source URL.

proxyId String The proxy ID registered in ArcGIS Online or ArcGIS Enterprise Portal.

avgRatingNumber

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

categoriesString[]

Since: ArcGIS API for JavaScript 4.8

An array of organization categories that are set on the item.

createdDate

The date the item was created.

cultureString

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

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

descriptionString

The detailed description of the item.

extentExtent

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

groupCategoriesString[]

Since: ArcGIS API 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.

idString

The unique id for the item.

isLayerBooleanreadonly

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

Example:

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

itemControlStringreadonly

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.

itemUrlStringreadonly

The URL to the item.

licenseInfoString

Information on license or restrictions related to the item.

loadedBooleanreadonly

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

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly

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

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

modifiedDate

The date the item was last modified.

nameString

The name of the item.

numCommentsNumber

Number of comments on the item.

numRatingsNumber

Number of ratings on the item.

numViewsNumber

Number of views on the item.

ownerString

The username of the user who owns this item.

portalPortalautocast

The portal that contains the item. Defaults to the value in config.portalUrl (e.g. https://www.arcgis.com). Suggested to use config.portalUrl instead of this property.

screenshotsString[]

Since: ArcGIS API 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".

Default Value:null

sizeNumber

The size of the item (in bytes).

snippetString

A summary description of the item.

tagsString[]

User defined tags that describe the item.

thumbnailUrlStringreadonly

The URL to the thumbnail used for the item.

See also:

• getThumbnailUrl()

titleString

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.

typeString

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";

typeKeywordsString[]

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

urlString

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.

Method Overview

Method Details

addRating(rating){Promise<PortalRating>}

Adds a rating to an accessible item.

Parameter:

rating Number|PortalRating Rating to set for the item. Rating must be a number between 1.0 and 5.0.

Returns:

Type	Description
Promise<PortalRating>	When resolved, a PortalRating is returned.

cancelLoad()

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

deleteRating(){Promise}

Deletes a rating for the specified item.

Returns:

Type	Description
Promise	Resolved when the rating successfully deletes.

fetchData(responseType){Promise}

Requests a PortalItem in the format specified in responseType.

Parameter:

responseType String optional Default Value: json The format of the response. Possible Values: json | xml | text | blob | array-buffer | document

Returns:

Type	Description
Promise	When resolved, returns the requested data.

fetchRating(){Promise<PortalRating>}

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

Returns:

Type	Description
Promise<PortalRating>	When resolved, a PortalRating is returned.

fetchRelatedItems(params){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:

params Object See the object specifications table below for the parameters that may be passed as properties in this object. Specification: relationshipType String The type of relationship between the two items. See Relationship types for a complete listing of types. direction String optional The direction of the relationship. Can either be forward (from origin to destination) or reverse (from destination to origin). Possible Values: forward | reverse

Returns:

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

Example:

var queryParam = {
   relationshipType: "Service2Data"
};

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

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

Parameter:

json Object 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:

Type	Description
*	Returns a new instance of this class.

getThumbnailUrl(width){String}

Since: ArcGIS API for JavaScript 4.4

Get the URL to the thumbnail image for the item.

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

Parameter:

width Number optional The desired image width.

Returns:

Type	Description
String	The URL to the thumbnail image.

isFulfilled(){Boolean}

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:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

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

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}

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

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load(){Promise}

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.

Returns:

Type	Description
Promise	Resolves when the resources have loaded.

toJSON(){Object}

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

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

update(params){Promise<PortalItem>}

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

Parameters:

params Object optional See the object specifications table below for the parameters that may be passed as properties in this object. Specification: data String|Object Optional. The component used to stream the data represented by the item to the client.

Returns:

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

updateThumbnail(params){Promise<PortalItem>}

Since: ArcGIS API for JavaScript 4.5

Updates the item's thumbnail on the portal.

Parameters:

params Object See the object specification table below for the parameters that may be passed as properties in this object. Specification: thumbnail Blob|String A URL, Data URI, Blob, or File. The accepted formats are GIF, JPG, and PNG.

Returns:

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

when(callback, errback){Promise}

Since: ArcGIS API for JavaScript 4.6

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

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var 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
});