Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/popup/content/CustomContent"], function(CustomContent) { /* code goes here */ });
Class: esri/popup/content/CustomContent
Inheritance: CustomContent Content Accessor
Since: ArcGIS API 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: (function(graphic)) {
    // 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.
NameTypeSummaryClass
PopupTemplateContentCreator

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

more details
more detailsCustomContent
String

The name of the class.

more details
more detailsAccessor
PopupTemplateContentDestroyer

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

more details
more detailsCustomContent
String[]

An array of field names used in the PopupTemplate.

more details
more detailsCustomContent
String

The type of popup element displayed.

more details
more detailsCustomContent

Property Details

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

Examples:
// This custom content contains a widget
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: function() {
    home = new Home({
      view: view
    });
  return home;
  }
});
// This custom content returns a promise
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: function() {
    promiseUtils.after(5).then(() => {
      const image = document.createElement("img");
      image.src = "<url to image>";
      image.width = 100;
      return image;
   });
  }
});
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: function() {
    // 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 PopupTemplate. 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

NameReturn TypeSummaryClass
CustomContent

Creates a deep clone of the CustomContent class.

more details
more detailsCustomContent
*

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

more details
more detailsCustomContent
Object

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

more details
more detailsCustomContent

Method Details

clone(){CustomContent}

Creates a deep clone of the CustomContent class.

Returns:
TypeDescription
CustomContentA 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 a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

Type Definitions

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

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

Parameter:
graphic Graphic

The Graphic used to represent the feature.

Returns:
TypeDescription
String | HTMLElement | Widget | PromiseThe created custom content element.
PopupTemplateContentDestroyer(graphic)

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

Parameter:
graphic Graphic

The Graphic used to represent the feature.

API Reference search results

NameTypeModule
Loading...