// 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
});

Property Overview

Property Details

creator PopupTemplateContentCreator

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: 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.

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: 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 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

Method Details

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 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:

Type	Description
*	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:

Type	Description
Object	The 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:

Type	Description
String | HTMLElement | Widget | Promise	The 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.