Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalItem

Hierarchy

Index

Properties

access

access: "public" | "private" | "org" | "shared"

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

Read more...

accessInformation

accessInformation: string

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

Read more...

apiKey

apiKey: string

An authorization string used to access the portal item.

Read more...

Readonly applicationProxies

applicationProxies: PortalItemApplicationProxies[]

Contains an array of objects containing proxy information for premium platform services.

Read more...

avgRating

avgRating: number

Average rating.

Read more...

categories

categories: string[]

An array of organization categories that are set on the item.

Read more...

created

created: Date

The date the item was created.

Read more...

culture

culture: string

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

Read more...

declaredClass

declaredClass: string

description

description: string

The detailed description of the item.

Read more...

destroyed

destroyed: boolean

extent

extent: Extent

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

Read more...

groupCategories

groupCategories: string[]

An array of group categories set on the item.

Read more...

id

id: string

The unique id for the item.

Read more...

initialized

initialized: boolean

Readonly isLayer

isLayer: boolean

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

Read more...

Readonly itemControl

itemControl: "update" | "admin" | "null"

Indicates whether an item can be updated and deleted.

Read more...

Readonly itemUrl

itemUrl: string

The URL to the item.

Read more...

licenseInfo

licenseInfo: string

Information on license or restrictions related to the item.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

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

Read more...

modified

modified: Date

The date the item was last modified.

Read more...

name

name: string

The name of the item.

Read more...

numComments

numComments: number

Number of comments on the item.

Read more...

numRatings

numRatings: number

Number of ratings on the item.

Read more...

numViews

numViews: number

Number of views on the item.

Read more...

owner

owner: string

The username of the user who owns this item.

Read more...

ownerFolder

ownerFolder: string

The ID of the folder in which the owner has stored the item.

Read more...

portal

portal: Portal

The portal that contains the item.

Read more...

screenshots

screenshots: string[]

An array of string URLs.

Read more...

size

size: number

The size of the item (in bytes).

Read more...

snippet

snippet: string

A summary description of the item.

Read more...

sourceJSON

sourceJSON: any

The JSON used to create the property values when the PortalItem is loaded.

Read more...

tags

tags: string[]

User defined tags that describe the item.

Read more...

Readonly thumbnailUrl

thumbnailUrl: string

The URL to the thumbnail used for the item.

Read more...

title

title: string

The title for the item.

Read more...

type

type: string

The GIS content type of this item.

Read more...

typeKeywords

typeKeywords: string[]

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

Read more...

url

url: string

The service URL of this item.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): PortalItem
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalItem

addRating

  • Adds a rating to an accessible item.

    Read more...

    Parameters

    Returns Promise<PortalRating>

addResource

cancelLoad

  • cancelLoad(): void
  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

clone

  • Creates a clone of this object.

    Read more...

    Returns PortalItem

deleteRating

  • deleteRating(): Promise<any>
  • Deletes a rating for the specified item.

    Read more...

    Returns Promise<any>

destroy

  • destroy(): void
  • Destroys the portal item, and any associated resources, including its associated portal.

    Read more...

    Returns void

fetchData

  • fetchData(responseType?: "blob" | "xml" | "text" | "json" | "array-buffer" | "document", options?: PortalItemFetchDataOptions): Promise<any>
  • Requests a PortalItem in the format specified in responseType.

    Read more...

    Parameters

    • Optional responseType: "blob" | "xml" | "text" | "json" | "array-buffer" | "document"
    • Optional options: PortalItemFetchDataOptions

    Returns Promise<any>

fetchRating

fetchRelatedItems

fetchResources

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getThumbnailUrl

  • getThumbnailUrl(width?: number): string
  • Get the URL to the thumbnail image for the item.

    Read more...

    Parameters

    • Optional width: number

    Returns string

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

removeAllResources

removeResource

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalItem

  • Parameters

    Returns PortalItem

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

update

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

    Read more...

    Parameters

    Returns Promise<PortalItem>

updateThumbnail

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc