Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: PortalItem
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.arcgis.PortalItem")
Description
(Added at v2.8)
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.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| access | String | Indicates the level of access: private, shared, org, or public. |
| accessInformation | String | Information on the source of the item. |
| avgRating | Number | Average rating. |
| created | Date | The date the item was created. |
| culture | String | The item locale information (language and country). |
| description | String | The detailed description of the item. |
| extent | Object | The bounding rectangle of the item. |
| id | String | The unique id for this item. |
| itemDataUrl | String | The url to the data resource associated with the item. |
| itemUrl | String | The url to the item. |
| licenseInfo | String | Any license information or restrictions. |
| modified | Date | Date the item was last modified. |
| name | String | The name of the item. |
| numComments | Number | Number of comments on the item. |
| numRatings | Number | Number of ratings on the item. |
| numViews | Number | Number of views on the item. |
| owner | String | The username of the user who owns this item. |
| portal | Portal | The portal that contains the item. |
| size | Number | The size of the item. |
| snippet | String | A summary description of the item. |
| spatialReference | String | The item's coordinate system. |
| tags | String[] | User defined tags that describe the item. |
| thumbnailUrl | String | The url to the thumbnail used for the item. |
| title | String | The title for the item. |
| type | String | The gis content type of this item. |
| typeKeywords | String[] | A set of keywords that further describes the type of this item. |
| url | String | The url for the resource represented by the item. |
| userItemUrl | String | The url to the user item. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addComment(comment) | Deferred | Add a comment to the item. |
| addRating(rating) | Deferred | Add a rating to an item that you have access to. |
| deleteComment(comment) | Deferred | Deletes an item comment. |
| deleteRating() | Deferred | Delete a rating that you created for the specified item. |
| getComments() | Deferred | Get the comments associated with the item. |
| getRating() | Deferred | Returns the rating (if any) given to the item. |
| getThumbnailUrl(width?) | String | Get the URL to the thumbnail image for the portal item. |
| updateComment(comment) | Deferred | Updates an item comment. |
Property Details
<String
StringIndicates the level of access: private, shared, org, or public.
<String
StringInformation on the source of the item.
<Number
NumberAverage rating. Uses a weighted average called "Bayesian average".
<Date
DateThe date the item was created.
<String
StringThe item locale information (language and country).
<String
StringThe detailed description of the item.
<Object
ObjectThe bounding rectangle of the item. It is returned as an extent object with the following format:
"extent": [ [
minX,
minY
],
[
maxX,
maxY
]
]
<String
StringThe unique id for this item.
<String
StringThe url to the data resource associated with the item.
<String
StringThe url to the item.
<String
StringAny license information or restrictions.
<Date
DateDate the item was last modified.
<String
StringThe name of the item.
<Number
NumberNumber of comments on the item.
<Number
NumberNumber of ratings on the item.
<Number
NumberNumber of views on the item.
<String
StringThe username of the user who owns this item.
<Portal
PortalThe portal that contains the item.
<Number
NumberThe size of the item.
<String
StringA summary description of the item.
<String
StringThe item's coordinate system.
<String[]
String[]User defined tags that describe the item.
<String
StringThe url to the thumbnail used for the item.
<String
StringThe title for the item. This is the name that is displayed to users and by which they refer to the item. Every item must have a title.
<String
StringThe gis content type of this item. Example types include : "Web Map" and "Web Mapping Application".
<String[]
String[]A set of keywords that further describes the type of this item. Each item is tagged with a set of type keywords that are derived based on its primary type.
<String
StringThe url for the resource represented by the item.
<String
StringThe url to the user item.
Method Details
Add a comment to the item. Only available for authenticated users who have access to the item. Returns a deferred that when resolved provides access to a PortalComment object.
Return type:
DeferredParameters:
< |
Required | The text for the comment. |
Sample:
portalItem.addComment('This is a really cool application.');
Add a rating to an item that you have access to. Only 1 rating can be given to an item per user. If this call is made on an already rated item, the new rating will overwrite the current one. A user cannot rate their own item. Available only to authenticated users. Returns a deferred that when resolved provides access to a PortalRating object.
Return type:
DeferredParameters:
< |
Required | Rating to set for the item. Rating must be a number between 1.0 and 5.0. |
Deletes an item comment. Only available to the authenticated user who created the comment.
Return type:
DeferredParameters:
< |
Required | The PortalComment to delete. |
Delete a rating that you created for the specified item. Returns a deferred that when resolved provides access to a PortalRating object.
Return type:
DeferredGet the comments associated with the item. Returns a deferred that when resolved provides access to an array of PortalComment objects.
Return type:
DeferredSample:
portalItem.getComments().forEach(function(result){
console.log(result.comment);
});
Returns the rating (if any) given to the item. Returns a deferred that when resolved provides access to a PortalRating object.
Return type:
DeferredGet the URL to the thumbnail image for the portal item.
Available width sizes: 200, 400, 800 and 2400. (Added at v3.21)
Available width sizes: 200, 400, 800 and 2400. (Added at v3.21)
Return type:
StringParameters:
< |
Optional | The desired image width. |
Updates an item comment. Only available to the authenticated user who created the comment.
Return type:
DeferredParameters:
< |
Required | A PortalComment that contains the comment updates. |