CustomContent

AMD: require(["esri/popup/content/CustomContent"], (CustomContent) => { /* code goes here */ });
ESM: import CustomContent from "@arcgis/core/popup/content/CustomContent";
Class: esri/popup/content/CustomContent
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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
PopupTemplateContentCreator

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

more details
CustomContent
String

The name of the class.

more details
Accessor
PopupTemplateContentDestroyer

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

more details
CustomContent
String[]

An array of field names used in the PopupTemplate.

more details
CustomContent
String

The type of popup element displayed.

more details
CustomContent

Property Details

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

See also
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 Stringreadonly inherited

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

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 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 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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
CustomContent

Creates a deep clone of the CustomContent class.

more details
CustomContent
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
CustomContent
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
CustomContent

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){CustomContent}

Creates a deep clone of the CustomContent class.

Returns
Type Description
CustomContent A deep clone of the CustomContent instance.
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(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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(){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

PopupTemplateContentCreator(event){String|HTMLElement|Widget|Promise}

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

Parameter
optional

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

Returns
Type Description
String | HTMLElement | Widget | Promise The created custom content element.
PopupTemplateContentDestroyer(event)

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

Parameter
optional

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

PopupTemplateCreatorEvent

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

Property
graphic Graphic

The Graphic used to represent the feature.

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