A base type for items in data stores, such as Portal or a map package. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | LocalItem and PortalItem |
Properties
- accessInformation : string
- created : date
- description : string
- extent : Envelope
- fetchDataStatus : Enums.TaskStatus
- itemId : string
- itemType : Enums.ItemType
- modified : date
- name : string
- snippet : string
- spatialReference : SpatialReference
- tags : list<string>
- termsOfUse : string
- thumbnailUrl : url
- title : string
- typeKeywords : list<string>
- updateItemPropertiesStatus : Enums.TaskStatus
Signals
- accessInformationChanged()
- createdChanged()
- descriptionChanged()
- extentChanged()
- fetchDataStatusChanged()
- itemIdChanged()
- modifiedChanged()
- nameChanged()
- snippetChanged()
- spatialReferenceChanged()
- tagsChanged()
- termsOfUseChanged()
- thumbnailUrlChanged()
- titleChanged()
- typeKeywordsChanged()
- updateItemPropertiesStatusChanged()
Methods
- void fetchData(url filePath)
- void updateItemProperties()
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
See also Layer::item, GeoModel::item, and Basemap::item.
Property Documentation
extent : Envelope |
The extent of this item.
Only applies to certain spatial item types.
Returns the Enums.TaskStatus of a fetchData operation (read-only).
Returns the Enums.ItemType of this item (read-only).
See also Enums.ItemType.
Returns the name of this item (read-only).
Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.
This property was introduced in Esri.ArcGISRuntime 100.5.
spatialReference : SpatialReference |
The spatial reference of this item.
The terms of use for the item, typically in HTML.
It is stored in the "licenseInfo" property in an item's JSON. The access and use constraints can contain HTML markup.
This property was introduced in Esri.ArcGISRuntime 100.4.
The local file URL of the thumbnail image for this item.
An empty URL may be returned the first time this property is accessed. However, accessing the thumbnailUrl property will automatically fetch the thumbnail and notify, with thumbnailUrlChanged, when the thumbnailUrl property changes.
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.
Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.
This property was introduced in Esri.ArcGISRuntime 100.5.
Returns the Enums.TaskStatus of the updateItemProperties method (read-only).
Signal Documentation
Emitted when the accessInformation property changes.
Note: The corresponding handler is onAccessInformationChanged.
Emitted when the created property changes.
Note: The corresponding handler is onCreatedChanged.
Emitted when the description property changes.
Note: The corresponding handler is onDescriptionChanged.
Emitted when the extent property changes.
Note: The corresponding handler is onExtentChanged.
Emitted when the fetchDataStatus property changes.
Note: The corresponding handler is onFetchDataStatusChanged.
Emitted when the itemId property changes.
Note: The corresponding handler is onItemIdChanged.
Emitted when the modified property changes.
Note: The corresponding handler is onModifiedChanged.
Emitted when the name property changes.
Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.
Note: The corresponding handler is onNameChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
Emitted when the snippet property changes.
Note: The corresponding handler is onSnippetChanged.
Emitted when the spatialReference property changes.
Note: The corresponding handler is onSpatialReferenceChanged.
Emitted when the tags property changes.
Note: The corresponding handler is onTagsChanged.
Emitted when the termsOfUse property changes.
Note: The corresponding handler is onTermsOfUseChanged.
This signal was introduced in Esri.ArcGISRuntime 100.4.
Emitted when the thumbnailUrl property changes.
Note: The corresponding handler is onThumbnailUrlChanged.
Emitted when the title property changes.
Note: The corresponding handler is onTitleChanged.
Emitted when the typeKeywords property changes.
Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.
Note: The corresponding handler is onTypeKeywordsChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
Emitted when the updateItemPropertiesStatus property changes.
Note: The corresponding handler is onUpdateItemPropertiesStatusChanged.
Method Documentation
Fetches the data for this item and saves to the specified filePath.
If filePath does not exist, the operation will attempt to create it.
Starts an asynchronous task to update an item's properties.
The updateItemPropertiesStatus property indicates the status of this task.
PortalItem
If the item is a portal item, this method starts an asynchronous task to update properties of the remote PortalItem.
Note: Prior to Esri.ArcGISRuntime 100.4, this method was only available on PortalItem.
LocalItem
If the item is a local item, this method starts an asynchronous task to update the item's properties in a file on the local file system where applicable.
Updating properties can be only done for local items that are unpacked. For example, a mobile map package file (.mmpk) can be unpacked using MobileMapPackageUtility.unpack(). Once unpacked, local items within the package can be updated - see MobileMapPackage.item and for maps use GeoModel::item.
As well as packages, the local item available from an item resource cache can be updated. This is accessed ItemResourceCache.item.
If the package is not unpacked, the task will return an error.
This method was introduced in Esri.ArcGISRuntime 100.4.
See also PortalItem and LocalItem.