dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Widgets

PopupWidget Class

The Popup widget allows users to view content from feature attributes.
ArcGIS Maps SDK for JavaScript

public class PopupWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 PopupWidget

Implements IGoTo

Constructors

PopupWidget() Constructor

Parameterless constructor for use as a Razor Component.

public PopupWidget();

PopupWidget(IReadOnlyList, Nullable, Nullable, string, Nullable, Nullable, PopupDockOptions, IReadOnlyList, GoToOverride, Nullable, Nullable, Nullable, string, Nullable, string, Point, MapView, Nullable, string, Nullable, string, string, PopupViewModel, Nullable, PopupVisibleElements, Widget, string) Constructor

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

public PopupWidget(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>? actions=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.PopupAlignment> alignment=null, System.Nullable<bool> autoCloseEnabled=null, string? containerId=null, System.Nullable<bool> defaultPopupTemplateEnabled=null, System.Nullable<bool> dockEnabled=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupDockOptions? dockOptions=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>? features=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, System.Nullable<int> headingLevel=null, System.Nullable<bool> highlightEnabled=null, System.Nullable<Microsoft.AspNetCore.Components.ElementReference> htmlContent=null, string? icon=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialDisplayMode> initialDisplayMode=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Geometries.Point? location=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, string? promises=null, System.Nullable<int> selectedFeatureIndex=null, string? stringContent=null, string? title=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupVisibleElements? visibleElements=null, dymaptic.GeoBlazor.Core.Components.Widgets.Widget? widgetContent=null, string? widgetId=null);

Parameters

actions System.Collections.Generic.IReadOnlyList<ActionBase>

Collection of action or action toggle objects.
ArcGIS Maps SDK for JavaScript

alignment System.Nullable<PopupAlignment>

Position of the popup in relation to the selected feature.
default “auto”
ArcGIS Maps SDK for JavaScript

autoCloseEnabled System.Nullable<System.Boolean>

This closes the popup when the View camera or Viewpoint changes.
default false
ArcGIS Maps SDK for JavaScript

containerId System.String

The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.

defaultPopupTemplateEnabled System.Nullable<System.Boolean>

Enables automatic creation of a popup template for layers that have popups enabled but no
popupTemplate defined.
default false
ArcGIS Maps SDK for JavaScript

dockEnabled System.Nullable<System.Boolean>

Indicates whether the placement of the popup is docked to the side of the view.
default false
ArcGIS Maps SDK for JavaScript

dockOptions PopupDockOptions

Docking the popup allows for a better user experience, particularly when opening
popups in apps on mobile devices.
ArcGIS Maps SDK for JavaScript

features System.Collections.Generic.IReadOnlyList<Graphic>

An array of features associated with the popup.
ArcGIS Maps SDK for JavaScript

goToOverride GoToOverride(GoToOverrideParameters)

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript

headingLevel System.Nullable<System.Int32>

Indicates the heading level to use for the title of the popup.
default 2
ArcGIS Maps SDK for JavaScript

highlightEnabled System.Nullable<System.Boolean>

Highlight the selected popup feature using the highlights
set on the MapView or the highlights
set on the SceneView.
default true
ArcGIS Maps SDK for JavaScript

htmlContent System.Nullable<Microsoft.AspNetCore.Components.ElementReference>

The content of the popup.
ArcGIS Maps SDK for JavaScript

icon System.String

Icon displayed in the widget’s button.
default “popup”
ArcGIS Maps SDK for JavaScript

initialDisplayMode System.Nullable<InitialDisplayMode>

Indicates whether to initially display a list of features, or the content for one feature.
default “feature”
ArcGIS Maps SDK for JavaScript

label System.String

The widget’s default label.
ArcGIS Maps SDK for JavaScript

location Point

Point used to position the popup.
ArcGIS Maps SDK for JavaScript

mapView MapView

If the Widget is defined outside of the MapView, this link is required to connect them together.

position System.Nullable<OverlayPosition>

The position of the widget in relation to the map view.

promises System.String

An array of pending Promises that have not yet been fulfilled.
ArcGIS Maps SDK for JavaScript

selectedFeatureIndex System.Nullable<System.Int32>

Index of the feature that is selected.
ArcGIS Maps SDK for JavaScript

stringContent System.String

The content of the popup.
ArcGIS Maps SDK for JavaScript

title System.String

The title of the popup.
ArcGIS Maps SDK for JavaScript

viewModel PopupViewModel

This is a class that contains all the logic
(properties and methods) that controls this widget’s behavior.
ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript

visibleElements PopupVisibleElements

The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript

widgetContent Widget

The content of the popup.
ArcGIS Maps SDK for JavaScript

widgetId System.String

The unique ID assigned to the widget when the widget is created.
ArcGIS Maps SDK for JavaScript

Properties

PopupWidget.Actions Property

Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a zoom-to action styled with a magnifying glass icon. When this icon is clicked, the view zooms in four LODs and centers on the selected feature.

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>? Actions { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<ActionBase>

PopupWidget.Active Property

Indicates if the widget is active when it is visible and is not waiting for results.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Active { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.Alignment Property

Position of the popup in relation to the selected feature. The default behavior is to display above the feature and adjust if not enough room. If needing to explicitly control where the popup displays in relation to the feature, choose an option besides auto.

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.PopupAlignment> Alignment { get; set; }

Property Value

System.Nullable<PopupAlignment>

PopupWidget.AutoCloseEnabled Property

This closes the popup when the View camera or Viewpoint changes.

public System.Nullable<bool> AutoCloseEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.AutoOpenEnabled Property

This property indicates to the Popup that it needs to allow or disallow the click event propagation. Use view.popup.autoOpenEnabled = false; when needing to stop the click event propagation.
DefaultValue: true

public System.Nullable<bool> AutoOpenEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.Collapsed Property

Indicates whether the popup displays its content. If true, only the header displays.

public System.Nullable<bool> Collapsed { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.CollapseEnabled Property

Indicates whether to enable collapse functionality for the popup.
DefaultValue: true

public System.Nullable<bool> CollapseEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.CurrentDockPosition Property

Dock position in the View.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.CurrentDockPosition> CurrentDockPosition { get; set; }

Property Value

System.Nullable<CurrentDockPosition>

PopupWidget.DefaultPopupTemplateEnabled Property

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.
Automatic popup templates are supported for layers that support the createPopupTemplate method. (Supported for
FeatureLayer, GeoJSONLayer, OGCFeatureLayer, SceneLayer, CSVLayer, PointCloudLayer, StreamLayer, and ImageryLayer).

public System.Nullable<bool> DefaultPopupTemplateEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.DockEnabled Property

Indicates whether the placement of the popup is docked to the side of the view.
Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices.
When a popup is “dockEnabled” it means the popup no longer points to the selected feature or the location assigned
to it. Rather it is attached to a side, the top, or the bottom of the view.
See DockOptions to override default options related to docking the popup.

public System.Nullable<bool> DockEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.DockOptions Property

Docking the popup allows for a better user experience, particularly when opening
popups in apps on mobile devices.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupDockOptions? DockOptions { get; set; }

Property Value

PopupDockOptions

PopupWidget.FeatureCount Property

The number of selected features available to the popup.
default 0
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> FeatureCount { get; set; }

Property Value

System.Nullable<System.Int32>

PopupWidget.Features Property

An array of features associated with the popup.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>? Features { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Graphic>

PopupWidget.GoToOverride Property

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Functions.GoToOverride? GoToOverride { get; set; }

Implements GoToOverride

Property Value

GoToOverride(GoToOverrideParameters)

PopupWidget.HasGoToOverride Property

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

public bool HasGoToOverride { get; }

Implements HasGoToOverride

Property Value

System.Boolean

PopupWidget.HeadingLevel Property

Indicates the heading level to use for the title of the popup. By default, the title is rendered as a level 2 heading (e.g. <h2>Popup title</h2>). Depending on the widget’s placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
DefaultValue:2

public System.Nullable<int> HeadingLevel { get; set; }

Property Value

System.Nullable<System.Int32>

PopupWidget.HighlightEnabled Property

Highlight the selected popup feature using the highlightOptions set on the MapView or the highlightOptions set on the SceneView.

public System.Nullable<bool> HighlightEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.HtmlContent Property

The content of the popup.
ArcGIS Maps SDK for JavaScript

public System.Nullable<Microsoft.AspNetCore.Components.ElementReference> HtmlContent { get; set; }

Property Value

System.Nullable<Microsoft.AspNetCore.Components.ElementReference>

PopupWidget.InitialDisplayMode Property

Indicates whether to initially display a list of features, or the content for one feature.
default “feature”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialDisplayMode> InitialDisplayMode { get; set; }

Property Value

System.Nullable<InitialDisplayMode>

PopupWidget.Location Property

Point used to position the popup.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Geometries.Point? Location { get; set; }

Property Value

Point

PopupWidget.MaxInlineActions Property

Defines the maximum icons displayed at one time in the action area.
DefaultValue: 3

public System.Nullable<int> MaxInlineActions { get; set; }

Property Value

System.Nullable<System.Int32>

PopupWidget.OnTriggerAction Property

Event Listener for TriggerAction.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.PopupTriggerActionEvent> OnTriggerAction { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<PopupTriggerActionEvent>

PopupWidget.Promises Property

An array of pending Promises that have not yet been fulfilled.
ArcGIS Maps SDK for JavaScript

public string? Promises { get; set; }

Property Value

System.String

PopupWidget.SelectedDrillInFeature Property

The feature that the widget has drilled into.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Graphic? SelectedDrillInFeature { get; set; }

Property Value

Graphic

PopupWidget.SelectedFeature Property

The selected feature accessed by the popup.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Graphic? SelectedFeature { get; set; }

Property Value

Graphic

PopupWidget.SelectedFeatureIndex Property

Index of the feature that is selected.
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> SelectedFeatureIndex { get; set; }

Property Value

System.Nullable<System.Int32>

PopupWidget.SelectedFeatureWidget Property

Returns a reference to the current Feature that the Popup is using.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Interfaces.IFeatureWidget? SelectedFeatureWidget { get; set; }

Property Value

IFeatureWidget

PopupWidget.SpinnerEnabled Property

Indicates whether to display a spinner at the popup location prior to its display when it has pending promises.

public System.Nullable<bool> SpinnerEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

PopupWidget.StringContent Property

The html string content of the popup. When set directly on the Popup, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see Content.

public string? StringContent { get; set; }

Property Value

System.String

PopupWidget.Title Property

The title of the popup. This can be set generically on the popup no matter the features that are selected. If the selected feature has a PopupTemplate, then the title set in the corresponding template is used here.

public string? Title { get; set; }

Property Value

System.String

PopupWidget.Type Property

The type of widget

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

Property Value

WidgetType

PopupWidget.ViewModel Property

This is a class that contains all the logic
(properties and methods) that controls this widget’s behavior.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel? ViewModel { get; set; }

Property Value

PopupViewModel

PopupWidget.VisibleElements Property

The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupVisibleElements? VisibleElements { get; set; }

Property Value

PopupVisibleElements

PopupWidget.WidgetContent Property

The content of the popup.
ArcGIS Maps SDK for JavaScript

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

Property Value

Widget

Methods

PopupWidget.AddToFeatures(Graphic[]) Method

Asynchronously adds elements to the Features property.

public System.Threading.Tasks.Task AddToFeatures(params dymaptic.GeoBlazor.Core.Components.Graphic[] values);

Parameters

values Graphic[]

The elements to add.

Returns

System.Threading.Tasks.Task

PopupWidget.Blur() Method

Use this method to remove focus from the Widget.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Blur();

Returns

System.Threading.Tasks.Task

PopupWidget.Clear() Method

Removes promises, features, content, title and location from the Popup.

public System.Threading.Tasks.Task Clear();

Returns

System.Threading.Tasks.Task

PopupWidget.Close() Method

Closes the popup by setting its visible property to false. Users can alternatively close the popup by directly setting the visible property to false.

public System.Threading.Tasks.Task Close();

Returns

System.Threading.Tasks.Task

PopupWidget.FetchFeatures() Method

Use this method to return feature(s) at a given screen location. These features are fetched from all of the LayerViews in the view. In order to use this, a layer must already have an associated PopupTemplate and have its popupEnabled. These features can then be used within a custom Popup or Feature widget experience.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic[]?> FetchFeatures();

Returns

System.Threading.Tasks.Task<Graphic[]>

PopupWidget.Focus() Method

Use this method to give focus to the Widget if the widget is able to be focused.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Focus();

Returns

System.Threading.Tasks.Task

PopupWidget.GetActive() Method

Asynchronously retrieve the current value of the Active property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetActive();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetAlignment() Method

Asynchronously retrieve the current value of the Alignment property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.PopupAlignment>> GetAlignment();

Returns

System.Threading.Tasks.Task<System.Nullable<PopupAlignment>>

PopupWidget.GetAutoCloseEnabled() Method

Asynchronously retrieve the current value of the AutoCloseEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetAutoCloseEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetCollapsed() Method

Asynchronously retrieve the current value of the Collapsed property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetCollapsed();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetCurrentDockPosition() Method

Asynchronously retrieve the current value of the CurrentDockPosition property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.CurrentDockPosition>> GetCurrentDockPosition();

Returns

System.Threading.Tasks.Task<System.Nullable<CurrentDockPosition>>

PopupWidget.GetDefaultPopupTemplateEnabled() Method

Asynchronously retrieve the current value of the DefaultPopupTemplateEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetDefaultPopupTemplateEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetDockEnabled() Method

Asynchronously retrieve the current value of the DockEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetDockEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetDockOptions() Method

Asynchronously retrieve the current value of the DockOptions property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupDockOptions?> GetDockOptions();

Returns

System.Threading.Tasks.Task<PopupDockOptions>

PopupWidget.GetFeatureCount() Method

The number of selected features available to the popup.

public System.Threading.Tasks.Task<System.Nullable<int>> GetFeatureCount();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

PopupWidget.GetFeatures() Method

Asynchronously retrieve the current value of the Features property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>?> GetFeatures();

Returns

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

PopupWidget.GetHeadingLevel() Method

Asynchronously retrieve the current value of the HeadingLevel property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetHeadingLevel();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

PopupWidget.GetHighlightEnabled() Method

Asynchronously retrieve the current value of the HighlightEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetHighlightEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetHtmlContent() Method

Asynchronously retrieve the current value of the HtmlContent property.

public System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>> GetHtmlContent();

Returns

System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>>

PopupWidget.GetInitialDisplayMode() Method

Asynchronously retrieve the current value of the InitialDisplayMode property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialDisplayMode>> GetInitialDisplayMode();

Returns

System.Threading.Tasks.Task<System.Nullable<InitialDisplayMode>>

PopupWidget.GetLocation() Method

Asynchronously retrieve the current value of the Location property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Point?> GetLocation();

Returns

System.Threading.Tasks.Task<Point>

PopupWidget.GetPromises() Method

Asynchronously retrieve the current value of the Promises property.

public System.Threading.Tasks.Task<string?> GetPromises();

Returns

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

PopupWidget.GetSelectedDrillInFeature() Method

Asynchronously retrieve the current value of the SelectedDrillInFeature property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetSelectedDrillInFeature();

Returns

System.Threading.Tasks.Task<Graphic>

PopupWidget.GetSelectedFeature() Method

The selected feature accessed by the popup. The content of the Popup is determined based on the PopupTemplate assigned to this feature.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetSelectedFeature();

Returns

System.Threading.Tasks.Task<Graphic>

PopupWidget.GetSelectedFeatureIndex() Method

Index of the feature that is selected. When features are set, the first index is automatically selected.

public System.Threading.Tasks.Task<System.Nullable<int>> GetSelectedFeatureIndex();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

PopupWidget.GetSelectedFeatureWidget() Method

Asynchronously retrieve the current value of the SelectedFeatureWidget property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IFeatureWidget?> GetSelectedFeatureWidget();

Returns

System.Threading.Tasks.Task<IFeatureWidget>

PopupWidget.GetStringContent() Method

Asynchronously retrieve the current value of the StringContent property.

public System.Threading.Tasks.Task<string?> GetStringContent();

Returns

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

PopupWidget.GetTitle() Method

Asynchronously retrieve the current value of the Title property.

public System.Threading.Tasks.Task<string?> GetTitle();

Returns

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

PopupWidget.GetViewModel() Method

Asynchronously retrieve the current value of the ViewModel property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel?> GetViewModel();

Returns

System.Threading.Tasks.Task<PopupViewModel>

PopupWidget.GetVisibility() Method

Index of the feature that is selected. When features are set, the first index is automatically selected.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetVisibility();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

PopupWidget.GetVisibleElements() Method

Asynchronously retrieve the current value of the VisibleElements property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupVisibleElements?> GetVisibleElements();

Returns

System.Threading.Tasks.Task<PopupVisibleElements>

PopupWidget.GetWidgetContent() Method

Asynchronously retrieve the current value of the WidgetContent property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Widgets.Widget?> GetWidgetContent();

Returns

System.Threading.Tasks.Task<Widget>

PopupWidget.Next() Method

Selects the feature at the next index in relation to the selected feature.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel?> Next();

Returns

System.Threading.Tasks.Task<PopupViewModel>

PopupWidget.OnJsGoToOverride(IJSStreamReference) Method

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

public System.Threading.Tasks.Task OnJsGoToOverride(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Implements OnJsGoToOverride(IJSStreamReference)

Returns

System.Threading.Tasks.Task

PopupWidget.OnJsTriggerAction(IJSStreamReference) Method

JS-invokable method for triggering actions.

public System.Threading.Tasks.Task OnJsTriggerAction(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

PopupWidget.Open(PopupOpenOptions) Method

Opens the popup at the given location with content defined either explicitly with content
or driven from the PopupTemplate of input features.
param options.title Sets the title of the popup.
param options.location Sets the popup’s location, which is the geometry used to position the popup.
param options.features Sets the popup’s features, which populate the title and content of the popup based on each graphic’s PopupTemplate.
param options.featureMenuOpen *Since:4.5 This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to true allows the user to scroll through the list of features. This value will only be honored if initialDisplayMode is set to feature.
param options.collapsed *Since:4.5 When true, indicates that only the popup header will display.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Open(dymaptic.GeoBlazor.Core.Options.PopupOpenOptions options);

Parameters

options PopupOpenOptions

Defines the location and content of the popup when opened.

  • options.content: Sets the content of the popup.
  • options.fetchFeatures: When true, indicates the popup should fetch the content of this feature and display it. If no PopupTemplate exists, a default template is created for the layer if defaultPopupTemplateEnabled = true. In order for this option to work, there must be a valid view and location set.
  • options.promises: Sets pending promises on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of Graphics.
  • options.updateLocationEnabled: When true indicates the popup should update its location for each paginated feature based on the selected feature’s geometry.
  • options.shouldFocus: *Since:4.23 When true, indicates that the focus should be on the popup after it has been opened.

Returns

System.Threading.Tasks.Task

PopupWidget.Previous() Method

Selects the feature at the previous index in relation to the selected feature.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel?> Previous();

Returns

System.Threading.Tasks.Task<PopupViewModel>

PopupWidget.RemoveFromFeatures(Graphic[]) Method

Asynchronously remove an element from the Features property.

public System.Threading.Tasks.Task RemoveFromFeatures(params dymaptic.GeoBlazor.Core.Components.Graphic[] values);

Parameters

values Graphic[]

The elements to remove.

Returns

System.Threading.Tasks.Task

PopupWidget.Reposition() Method

Positions the popup on the view.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Reposition();

Returns

System.Threading.Tasks.Task

PopupWidget.SetAlignment(Nullable) Method

Asynchronously set the value of the Alignment property after render.

public System.Threading.Tasks.Task SetAlignment(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PopupAlignment> value);

Parameters

value System.Nullable<PopupAlignment>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetAutoCloseEnabled(Nullable) Method

Asynchronously set the value of the AutoCloseEnabled property after render.

public System.Threading.Tasks.Task SetAutoCloseEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetContent(string) Method

Sets the string content of the popup.

public System.Threading.Tasks.Task SetContent(string stringContent);

Parameters

stringContent System.String

Returns

System.Threading.Tasks.Task

PopupWidget.SetDefaultPopupTemplateEnabled(Nullable) Method

Asynchronously set the value of the DefaultPopupTemplateEnabled property after render.

public System.Threading.Tasks.Task SetDefaultPopupTemplateEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetDockEnabled(Nullable) Method

Asynchronously set the value of the DockEnabled property after render.

public System.Threading.Tasks.Task SetDockEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetDockOptions(PopupDockOptions) Method

Asynchronously set the value of the DockOptions property after render.

public System.Threading.Tasks.Task SetDockOptions(dymaptic.GeoBlazor.Core.Components.Popups.PopupDockOptions? value);

Parameters

value PopupDockOptions

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetFeatures(IReadOnlyList) Method

Asynchronously set the value of the Features property after render.

public System.Threading.Tasks.Task SetFeatures(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Graphic>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetHeadingLevel(Nullable) Method

Asynchronously set the value of the HeadingLevel property after render.

public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetHighlightEnabled(Nullable) Method

Asynchronously set the value of the HighlightEnabled property after render.

public System.Threading.Tasks.Task SetHighlightEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetHtmlContent(Nullable) Method

Asynchronously set the value of the HtmlContent property after render.

public System.Threading.Tasks.Task SetHtmlContent(System.Nullable<Microsoft.AspNetCore.Components.ElementReference> value);

Parameters

value System.Nullable<Microsoft.AspNetCore.Components.ElementReference>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetInitialDisplayMode(Nullable) Method

Asynchronously set the value of the InitialDisplayMode property after render.

public System.Threading.Tasks.Task SetInitialDisplayMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialDisplayMode> value);

Parameters

value System.Nullable<InitialDisplayMode>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetLocation(Point) Method

Asynchronously set the value of the Location property after render.

public System.Threading.Tasks.Task SetLocation(dymaptic.GeoBlazor.Core.Components.Geometries.Point? value);

Parameters

value Point

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetPromises(string) Method

Asynchronously set the value of the Promises property after render.

public System.Threading.Tasks.Task SetPromises(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetSelectedClusterBoundaryFeatureSymbol(Symbol) Method

Override the default symbol of the displayed cluster extent. Only applies when a PopupTemplate is set on a FeatureReductionCluster instance.

public System.Threading.Tasks.Task SetSelectedClusterBoundaryFeatureSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol symbol);

Parameters

symbol Symbol

Returns

System.Threading.Tasks.Task

PopupWidget.SetSelectedFeatureIndex(Nullable) Method

Asynchronously set the value of the SelectedFeatureIndex property after render.

public System.Threading.Tasks.Task SetSelectedFeatureIndex(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetStringContent(string) Method

Asynchronously set the value of the StringContent property after render.

public System.Threading.Tasks.Task SetStringContent(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetTitle(string) Method

Asynchronously set the value of the Title property after render.

public System.Threading.Tasks.Task SetTitle(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetViewModel(PopupViewModel) Method

Asynchronously set the value of the ViewModel property after render.

public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.Popups.PopupViewModel? value);

Parameters

value PopupViewModel

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetVisibleElements(PopupVisibleElements) Method

Asynchronously set the value of the VisibleElements property after render.

public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Core.Components.Popups.PopupVisibleElements? value);

Parameters

value PopupVisibleElements

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.SetWidgetContent(Widget) Method

Asynchronously set the value of the WidgetContent property after render.

public System.Threading.Tasks.Task SetWidgetContent(dymaptic.GeoBlazor.Core.Components.Widgets.Widget? value);

Parameters

value Widget

The value to set.

Returns

System.Threading.Tasks.Task

PopupWidget.TriggerAction(int) Method

Triggers the trigger-action event and executes the action
at the specified index in the actions array.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task TriggerAction(int actionIndex);

Parameters

actionIndex System.Int32

The index of the action to execute.

Returns

System.Threading.Tasks.Task

PopupWidget.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()