CustomContent | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

CustomContent Constructor new CustomContent(properties)

Parameter

properties Object

optional

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

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
PopupTemplateContentCreator\|PopupTemplateContent\|Promise<PopupTemplateContent>	The function that is called to create the custom content element.	CustomContent
String	The name of the class.	Accessor
PopupTemplateContentDestroyer	The called function to cleanup custom content when it is no longer necessary.	CustomContent
String []	An array of field names used in the PopupTemplate.	CustomContent
String	The type of popup element displayed.	CustomContent

Property Details

creator Property creator PopupTemplateContentCreator |PopupTemplateContent |Promise<PopupTemplateContent>

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 Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

destroyer Property destroyer PopupTemplateContentDestroyer

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 outFields String[]

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 Property type Stringreadonly

The type of popup element displayed.

For CustomContent the type is always "custom".

Default Value:"custom"

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
CustomContent	Creates a deep clone of the CustomContent class.	CustomContent
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	CustomContent
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	CustomContent

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){CustomContent}

Creates a deep clone of the CustomContent class.

Returns

Type	Description
CustomContent	A deep clone of the CustomContent instance.

fromJSON Method fromJSON(json){*}static

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.

Parameter

json Object

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

Type	Description
*	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method toJSON(){Object}

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

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

PopupTemplateContent Type Definition PopupTemplateContent String |HTMLElement |Widget |null |undefined

Custom element content.

PopupTemplateContentCreator Type Definition PopupTemplateContentCreator(event){PopupTemplateContent |Promise<PopupTemplateContent>}

The function that is called to create the custom content element.

Parameter

event PopupTemplateCreatorEvent

optional

The event that contains the Graphic used to represent the feature.

Returns

Type	Description
PopupTemplateContent \| Promise<PopupTemplateContent>	The created custom content element.

PopupTemplateContentDestroyer Type Definition PopupTemplateContentDestroyer(event)

The function that is called to destroy the custom content element.

Parameter

event PopupTemplateCreatorEvent

optional

The event that contains the Graphic used to represent the feature.

PopupTemplateCreatorEvent Type Definition PopupTemplateCreatorEvent

The event that contains the Graphic used to represent the feature.

Property: graphic Graphic

The Graphic used to represent the feature.