PortalItemData | References | ArcGIS Maps SDK for JavaScript

import PortalItemData from "@arcgis/core/layers/support/PortalItemData.js";

const PortalItemData = await $arcgis.import("@arcgis/core/layers/support/PortalItemData.js");

Inheritance: PortalItemData→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

beta

Provides an ArcGIS portal item as the data source for a ParquetLayer or a GeospatialPDFLayer.

Examples

import ParquetLayer from "@arcgis/core/layers/ParquetLayer.js";
import PortalItemData from "@arcgis/core/layers/support/PortalItemData.js";

// Replace the placeholder ID with a portal item containing Parquet data.
const layer = new ParquetLayer({
  data: new PortalItemData({
    portalItem: {
      id: "6ab6f959c1684eb5a54db91644a89747",
    },
  }),
});

import GeospatialPDFLayer from "@arcgis/core/layers/GeospatialPDFLayer.js";
import PortalItemData from "@arcgis/core/layers/support/PortalItemData.js";

// Replace the placeholder ID with a portal item whose URL resolves to a geospatial PDF.
const layer = new GeospatialPDFLayer({
  data: new PortalItemData({
    portalItem: {
      id: "0d8613492b1e4598a5edb111f05be7fd",
    },
  }),
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	PortalItemDataProperties	Properties used to initialize the data source.

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
portalItem	PortalItem
type readonly	"portal-item"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

portalItem

autocast Property

Type: PortalItem

The portal item that provides the layer's data source. The item's content must be compatible with the consuming layer, such as Parquet data for ParquetLayer or a geospatial PDF for GeospatialPDFLayer. Set this to a PortalItem instance or its properties; a plain object such as { id: "item-id" } is autocast to a PortalItem. Set the item's portal when referencing content outside the default portal.

type

readonly Property

Type: "portal-item"

The type of data source.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	any	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.