require(["esri/portal/PortalItem"], function(PortalItem) { /* code goes here */ });
Class: esri/portal/PortalItem
Inheritance: PortalItem Accessor
Since: ArcGIS API 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

new PortalItem(properties)

Parameter:
properties Object
optional

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

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

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

more details
more detailsPortalItem
String

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

more details
more detailsPortalItem
Number

Average rating.

more details
more detailsPortalItem
Date

The date the item was created.

more details
more detailsPortalItem
String

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

more details
more detailsPortalItem
String

The name of the class.

more details
more detailsAccessor
String

The detailed description of the item.

more details
more detailsPortalItem
Extent

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

more details
more detailsPortalItem
String

The unique id for the item.

more details
more detailsPortalItem
Boolean

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

more details
more detailsPortalItem
String

Indicates whether an item can be updated and deleted.

more details
more detailsPortalItem
String

The URL to the item.

more details
more detailsPortalItem
String

Information on license or restrictions related to the item.

more details
more detailsPortalItem
Boolean

Indicates whether the item's resources have loaded from the portal.

more details
more detailsPortalItem
Error

The Error object returned if an error occurred while loading.

more details
more detailsPortalItem
String

Represents the status of a load operation.

more details
more detailsPortalItem
Object[]

A list of warnings which occurred while loading.

more details
more detailsPortalItem
Date

The date the item was last modified.

more details
more detailsPortalItem
String

The name of the item.

more details
more detailsPortalItem
Number

Number of comments on the item.

more details
more detailsPortalItem
Number

Number of ratings on the item.

more details
more detailsPortalItem
Number

Number of views on the item.

more details
more detailsPortalItem
String

The username of the user who owns this item.

more details
more detailsPortalItem
Portal

The portal that contains the item.

more details
more detailsPortalItem
Number

The size of the item (in bytes).

more details
more detailsPortalItem
String

A summary description of the item.

more details
more detailsPortalItem
String[]

User defined tags that describe the item.

more details
more detailsPortalItem
String

The URL to the thumbnail used for the item.

more details
more detailsPortalItem
String

The title for the item.

more details
more detailsPortalItem
String

The GIS content type of this item.

more details
more detailsPortalItem
String[]

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

more details
more detailsPortalItem
String

The service URL of this item.

more details
more detailsPortalItem

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.

avgRatingNumber

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

createdDate

The date the item was created.

cultureString

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

declaredClassStringreadonly inherited

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.

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 ValueDescription
adminThe item can be updated or deleted.
updateThe item can be updated, but not deleted.
nullThe 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.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe 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.

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.

sizeNumber

The size of the item (in bytes).

snippetString

A summary description of the item.

User defined tags that describe the item.

thumbnailUrlStringreadonly

The URL to the thumbnail used for the item.

See also:

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.

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

NameReturn TypeSummaryClass
Promise<PortalRating>

Adds a rating to an accessible item.

more details
more detailsPortalItem
Promise

An instance of this class is a Promise.

more details
more detailsPortalItem

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

more details
more detailsPortalItem
Promise

Deletes a rating for the specified item.

more details
more detailsPortalItem
Promise

Requests a PortalItem in the format specified in responseType.

more details
more detailsPortalItem
Promise<PortalRating>

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

more details
more detailsPortalItem
Promise<PortalItem[]>

Gets all the related items of a certain relationship type for the portal item.

more details
more detailsPortalItem
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsPortalItem
String

Get the URL to the thumbnail image for the item.

more details
more detailsPortalItem
Boolean

An instance of this class is a Promise.

more details
more detailsPortalItem
Boolean

An instance of this class is a Promise.

more details
more detailsPortalItem
Boolean

An instance of this class is a Promise.

more details
more detailsPortalItem
Promise

Loads the resources referenced by this class.

more details
more detailsPortalItem
Promise

An instance of this class is a Promise.

more details
more detailsPortalItem
Promise

An instance of this class is a Promise.

more details
more detailsPortalItem
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsPortalItem
Promise<PortalItem>

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

more details
more detailsPortalItem
Promise<PortalItem>

Updates the item's thumbnail on the portal.

more details
more detailsPortalItem

Method Details

addRating(rating){Promise<PortalRating>}

Adds a rating to an accessible item.

Parameter:

Rating to set for the item. Rating must be a number between 1.0 and 5.0.

Returns:
TypeDescription
Promise< PortalRating>When resolved, a PortalRating is returned.

always(callbackOrErrback){Promise}

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()

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

deleteRating(){Promise}

Deletes a rating for the specified item.

Returns:
TypeDescription
PromiseResolved when the rating successfully deletes.

fetchData(responseType){Promise}

Requests a PortalItem in the format specified in responseType.

Parameter:
responseType String
optional

The format of the response.

Default Value: json
Known Values: json | xml | text | blob | array-buffer | document

Returns:
TypeDescription
PromiseWhen resolved, returns the requested data.

fetchRating(){Promise<PortalRating>}

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

Returns:
TypeDescription
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:
TypeDescription
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:
TypeDescription
*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:
TypeDescription
StringThe URL to the thumbnail image.

isFulfilled(){Boolean}

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise 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:
TypeDescription
PromiseResolves when the resources have loaded.

otherwise(errback){Promise}

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns 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.then(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
});

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:
TypeDescription
ObjectThe 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:

Optional. The component used to stream the data represented by the item to the client.

Returns:
TypeDescription
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:
TypeDescription
Promise< PortalItem>Resolves when the portal item's thumbnail has been updated.

API Reference search results

NameTypeModule

There were no match results from your search criteria.