Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISItem QML Type

A base type for items in data stores like Portal or a map package. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Inherited By:

LocalItem and PortalItem

Properties

Signals

Methods

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

accessInformation : string

The access information of this item.


created : date

Returns the time this item was created (read-only).


description : string

The description of this item.


extent : Envelope

The extent of this item.

Only applies to certain spatial item types.


fetchDataStatus : Enums.TaskStatus

Returns the Enums.TaskStatus of a fetchData operation (read-only).


itemId : string

The ID of this item.


itemType : Enums.ItemType

Returns the Enums.ItemType of this item (read-only).

See also Enums.ItemType.


modified : date

Returns the time this item was last modified (read-only).


name : string

Returns the name of this item (read-only).

Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.

This QML property was introduced in Esri.ArcGISRuntime 100.5.


snippet : string

The snippet of this item.


spatialReference : SpatialReference

The spatial reference of this item.


tags : list<string>

The tags of this item.


termsOfUse : string

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 QML property was introduced in Esri.ArcGISRuntime 100.4.


thumbnailUrl : url

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.


title : string

The title of this item.


typeKeywords : list<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.

Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.

This QML property was introduced in Esri.ArcGISRuntime 100.5.


updateItemPropertiesStatus : Enums.TaskStatus

Returns the Enums.TaskStatus of the updateItemProperties method (read-only).


Signal Documentation

accessInformationChanged()

Emitted when the accessInformation property changes.


createdChanged()

Emitted when the created property changes.


descriptionChanged()

Emitted when the description property changes.


extentChanged()

Emitted when the extent property changes.


fetchDataStatusChanged()

Emitted when the fetchDataStatus property changes.


itemIdChanged()

Emitted when the itemId property changes.


modifiedChanged()

Emitted when the modified property changes.


nameChanged()

Emitted when the name property changes.

Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.

This QML signal was introduced in Esri.ArcGISRuntime 100.5.


snippetChanged()

Emitted when the snippet property changes.


spatialReferenceChanged()

Emitted when the spatialReference property changes.


tagsChanged()

Emitted when the tags property changes.


termsOfUseChanged()

Emitted when the termsOfUse property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.4.


thumbnailUrlChanged()

Emitted when the thumbnailUrl property changes.


titleChanged()

Emitted when the title property changes.


typeKeywordsChanged()

Emitted when the typeKeywords property changes.

Note: Prior to Esri.ArcGISRuntime 100.5, this method was only available on PortalItem.

This QML signal was introduced in Esri.ArcGISRuntime 100.5.


updateItemPropertiesStatusChanged()

Emitted when the updateItemPropertiesStatus property changes.


Method Documentation

void fetchData(url filePath)

Fetches the data for this item and saves to the specified filePath.

If filePath does not exist, the operation will attempt to create it.


void updateItemProperties()

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 Map::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 QML method was introduced in Esri.ArcGISRuntime 100.4.

See also PortalItem and LocalItem.



Feedback on this topic?