ArcGISItem QML Type

  • Esri.ArcGISRuntime
  • ArcGISItem
  • A base type for items in data stores, such as Portal or a map package. More...

    Import Statement: import Esri.ArcGISRuntime
    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.

    See also Layer::item, GeoModel::item, and Basemap::item.

    Property Documentation

    accessInformation : string

    The access information of this item.


    [read-only] 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.


    [read-only] fetchDataStatus : Enums.TaskStatus

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


    itemId : string

    The ID of this item.


    [read-only] itemType : Enums.ItemType

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

    See also Enums.ItemType.


    [read-only] modified : date

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


    [read-only, since Esri.ArcGISRuntime 100.5] 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 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.


    [since Esri.ArcGISRuntime 100.4] 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 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.


    [since Esri.ArcGISRuntime 100.5] 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 property was introduced in Esri.ArcGISRuntime 100.5.


    [read-only] updateItemPropertiesStatus : Enums.TaskStatus

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


    Signal Documentation

    accessInformationChanged()

    Emitted when the accessInformation property changes.

    Note: The corresponding handler is onAccessInformationChanged.


    createdChanged()

    Emitted when the created property changes.

    Note: The corresponding handler is onCreatedChanged.


    descriptionChanged()

    Emitted when the description property changes.

    Note: The corresponding handler is onDescriptionChanged.


    extentChanged()

    Emitted when the extent property changes.

    Note: The corresponding handler is onExtentChanged.


    fetchDataStatusChanged()

    Emitted when the fetchDataStatus property changes.

    Note: The corresponding handler is onFetchDataStatusChanged.


    itemIdChanged()

    Emitted when the itemId property changes.

    Note: The corresponding handler is onItemIdChanged.


    modifiedChanged()

    Emitted when the modified property changes.

    Note: The corresponding handler is onModifiedChanged.


    [since Esri.ArcGISRuntime 100.5] nameChanged()

    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.


    snippetChanged()

    Emitted when the snippet property changes.

    Note: The corresponding handler is onSnippetChanged.


    spatialReferenceChanged()

    Emitted when the spatialReference property changes.

    Note: The corresponding handler is onSpatialReferenceChanged.


    tagsChanged()

    Emitted when the tags property changes.

    Note: The corresponding handler is onTagsChanged.


    [since Esri.ArcGISRuntime 100.4] termsOfUseChanged()

    Emitted when the termsOfUse property changes.

    Note: The corresponding handler is onTermsOfUseChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    thumbnailUrlChanged()

    Emitted when the thumbnailUrl property changes.

    Note: The corresponding handler is onThumbnailUrlChanged.


    titleChanged()

    Emitted when the title property changes.

    Note: The corresponding handler is onTitleChanged.


    [since Esri.ArcGISRuntime 100.5] typeKeywordsChanged()

    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.


    updateItemPropertiesStatusChanged()

    Emitted when the updateItemPropertiesStatus property changes.

    Note: The corresponding handler is onUpdateItemPropertiesStatusChanged.


    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.


    [since Esri.ArcGISRuntime 100.4] 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 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.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.