CustomContent | References | ArcGIS Maps SDK for JavaScript

import CustomContent from "@arcgis/core/popup/content/CustomContent.js";

Inheritance:: CustomContent→Content→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.16

A CustomContent popup element is used to provide a way to customize the popup's content. This content can be a combination of elements such as String, HTMLElement, Widget, or Promise.

See also

Example

// Create the custom content for the CustomContent popup element
// Creates some custom content
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: (event) => {
    // creator function returns either string, HTMLElement, Widget, or Promise
  }
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`CustomContentProperties`

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
`creator`	`PopupTemplateContentCreator \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`destroyer`	`PopupTemplateContentDestroyer \| null \| undefined`
`outFields`	`string[] \| null \| undefined`
`type` readonly	`"custom"`

creator

Property

Type: PopupTemplateContentCreator | null | undefined

The function that is called to create the custom content element. Make certain that outFields is specified within this custom content.

See also

outFields

Examples

// This custom content contains a widget
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: () => {
    home = new Home({
      view: view
    });
  return home;
  }
});

// This custom content returns a promise
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: () => {
      const image = document.createElement("img");
      image.src = "<url to image>";
      image.width = 100;
      return image;
  }
});

// This custom content contains the resulting promise from the query
const customContentQuery = new CustomContent({
 outFields: ["*"],
 creator: (event) => {
   const queryObject = new Query({
     geometry: event.graphic.geometry,
     outFields: ["*"],
     spatialRelationship: "intersects",
     returnGeometry: true
   });
   return query.executeForCount(queryUrl, queryObject).then((count) => {
     return `There are ${count} features that intersect with ${event.graphic.attributes["field_name"]}.`;
   },
   (error) => {
     console.log(error);
   });
 }
});

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

destroyer

Property

Type: PopupTemplateContentDestroyer | null | undefined

The called function to cleanup custom content when it is no longer necessary.

Example

// Destroy the custom content
let customContent = new CustomContent({
  ...
  destroyer: () => {
    // destroy custom content here
  }
});

outFields

Property

Type: string[] | null | undefined

An array of field names used in the PopupTemplate. Use this property to indicate what fields are required to fully render the template's custom content. This is important if setting content via a function since any fields needed for successful rendering should be specified here.

To fetch the values from all fields, use ["*"].

type

readonly Property

Type: "custom"

The type of popup element displayed.

See also

Default value: "custom"

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): CustomContent`
`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

Method

Signature: clone (): CustomContent

Creates a deep clone of the CustomContent class.

Returns: CustomContent
A deep clone of the CustomContent instance.

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.