ESM: import CustomContent from "@arcgis/core/popup/content/CustomContent.js";
CDN: const CustomContent = await $arcgis.import("@arcgis/core/popup/content/CustomContent.js");
Class: @arcgis/core/popup/content/CustomContent
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.
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
}
}); new CustomContent(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsThe function that is called to create the custom content element. Make certain that outFields is specified within this custom content.
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);
});
}
});Inherited
Property declaredClass Stringreadonly
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
}
});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".
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Creates a deep clone of the CustomContent class.
Returns
Type Description CustomContent A deep clone of the CustomContent instance.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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");The function that is called to create the custom content element.
Returns
PopupTemplateContentDestroyer(event)
The function that is called to destroy the custom content element.
PopupTemplateCreatorEvent
The event that contains the Graphic used to represent the feature.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4