GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components.Popups

CustomPopupContent Class

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.Popups.CustomPopupContent.html”>GeoBlazor Docs</a> A `CustomContent` popup element is used to provide a way to customize the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html”>popup’s</a> content. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html”>ArcGIS Maps SDK for JavaScript</a>

public class CustomPopupContent : dymaptic.GeoBlazor.Core.Components.Popups.PopupContent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Popups.PopupContent 🡒 CustomPopupContent

Constructors

CustomPopupContent() Constructor

Parameterless constructor for use as a Razor Component.

public CustomPopupContent();

CustomPopupContent(PopupTemplateContentDestroyer, IReadOnlyList<string>, PopupTemplateContentCreator) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public CustomPopupContent(dymaptic.GeoBlazor.Pro.Functions.PopupTemplateContentDestroyer? destroyer=null, System.Collections.Generic.IReadOnlyList<string>? outFields=null, dymaptic.GeoBlazor.Pro.Functions.PopupTemplateContentCreator? creatorFunction=null);

Parameters

destroyer PopupTemplateContentDestroyer(PopupTemplateCreatorEvent)

The called function to cleanup custom content when it is no longer necessary. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#destroyer”>ArcGIS Maps SDK for JavaScript</a>

outFields System.Collections.Generic.IReadOnlyList<System.String>

An array of field names used in the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html”>PopupTemplate</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#outFields”>ArcGIS Maps SDK for JavaScript</a>

creatorFunction PopupTemplateContentCreator(PopupTemplateCreatorEvent)

The function that is called to create the custom content element. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#creator”>ArcGIS Maps SDK for JavaScript</a>

Properties

CustomPopupContent.CreatorFunction Property

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.Popups.CustomPopupContent.html#custompopupcontentpopuptemplatecontentcreator-property”>GeoBlazor Docs</a> The function that is called to create the custom content element. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#creator”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Pro.Functions.PopupTemplateContentCreator? CreatorFunction { get; set; }

Property Value

PopupTemplateContentCreator(PopupTemplateCreatorEvent)

CustomPopupContent.Destroyer Property

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.Popups.CustomPopupContent.html#custompopupcontentdestroyer-property”>GeoBlazor Docs</a> The called function to cleanup custom content when it is no longer necessary. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#destroyer”>ArcGIS Maps SDK for JavaScript</a>

public dymaptic.GeoBlazor.Pro.Functions.PopupTemplateContentDestroyer? Destroyer { get; set; }

Property Value

PopupTemplateContentDestroyer(PopupTemplateCreatorEvent)

CustomPopupContent.HasContentCreatorFunction Property

A convenience property that signifies whether a custom CreatorFunction function was registered.

public bool HasContentCreatorFunction { get; }

Property Value

System.Boolean

CustomPopupContent.HasDestroyerFunction Property

A convenience property that signifies whether a custom Destroyer function was registered.

public bool HasDestroyerFunction { get; }

Property Value

System.Boolean

CustomPopupContent.OutFields Property

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.Popups.CustomPopupContent.html#custompopupcontentoutfields-property”>GeoBlazor Docs</a> An array of field names used in the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html”>PopupTemplate</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html#outFields”>ArcGIS Maps SDK for JavaScript</a>

public System.Collections.Generic.IReadOnlyList<string>? OutFields { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<System.String>

CustomPopupContent.Type Property

The type of Popup Content

public override dymaptic.GeoBlazor.Core.Enums.PopupContentType Type { get; }

Property Value

dymaptic.GeoBlazor.Core.Enums.PopupContentType

CustomPopupContent.WidgetContent Property

Widget child content.

public dymaptic.GeoBlazor.Core.Components.Widgets.Widget? WidgetContent { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Widgets.Widget

Methods

CustomPopupContent.AddToOutFields(string[]) Method

Asynchronously adds elements to the OutFields property.

public System.Threading.Tasks.Task AddToOutFields(params string[] values);

Parameters

values System.String[]

The elements to add.

Returns

System.Threading.Tasks.Task

CustomPopupContent.GetOutFields() Method

Asynchronously retrieve the current value of the OutFields property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetOutFields();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>

CustomPopupContent.OnJsDestroyer(PopupTemplateCreatorEvent) Method

JS-invokable method that triggers the Destroyer function. Should not be called by consuming code.

public System.Threading.Tasks.Task OnJsDestroyer(dymaptic.GeoBlazor.Pro.Events.PopupTemplateCreatorEvent destroyerEvent);

Parameters

destroyerEvent PopupTemplateCreatorEvent

Returns

System.Threading.Tasks.Task

CustomPopupContent.OnJsPopupTemplateContentCreator(IJSStreamReference) Method

JS-invokable method that triggers the CreatorFunction function. Should not be called by consuming code.

public System.Threading.Tasks.Task<string?> OnJsPopupTemplateContentCreator(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task<System.String>

CustomPopupContent.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child dymaptic.GeoBlazor.Core.Components.MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

dymaptic.GeoBlazor.Core.Exceptions.InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.

CustomPopupContent.RemoveFromOutFields(string[]) Method

Asynchronously remove an element from the OutFields property.

public System.Threading.Tasks.Task RemoveFromOutFields(params string[] values);

Parameters

values System.String[]

The elements to remove.

Returns

System.Threading.Tasks.Task

CustomPopupContent.SetOutFields(IReadOnlyList<string>) Method

Asynchronously set the value of the OutFields property after render.

public System.Threading.Tasks.Task SetOutFields(System.Collections.Generic.IReadOnlyList<string>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<System.String>

The value to set.

Returns

System.Threading.Tasks.Task

CustomPopupContent.UnregisterChildComponent(MapComponent) Method

Undoes the “Registration” of a child with its parent.

public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child dymaptic.GeoBlazor.Core.Components.MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.