Skip to main content Link Search Menu Expand Document (external link)

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Widgets

ExpandWidget Class

The Expand widget acts as a clickable button for opening a widget.
ArcGIS JS API

public class ExpandWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget

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

Properties

ExpandWidget.AutoCollapse Property

Automatically collapses the expand widget instance when the view’s viewpoint updates.

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

Property Value

System.Nullable<System.Boolean>

ExpandWidget.CloseOnEsc Property

When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.

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

Property Value

System.Nullable<System.Boolean>

ExpandWidget.CollapseIconClass Property

Icon font used to style the Expand button when collapsed.

public string? CollapseIconClass { get; set; }

Property Value

System.String

ExpandWidget.CollapseTooltip Property

Tooltip to display to indicate Expand widget can be collapsed.

public string? CollapseTooltip { get; set; }

Property Value

System.String

ExpandWidget.Content Property

The content to display within the expanded Expand widget.

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

Property Value

Widget

Remarks

If adding a Slider, HistogramRangeSlider, or TimeSlider as content to the Expand widget, the container or parent container of the widget must have a width set in CSS for it to render inside the Expand widget.

ExpandWidget.ExpandIconClass Property

Icon font used to style the Expand button when expanded.

public string? ExpandIconClass { get; set; }

Property Value

System.String

ExpandWidget.ExpandTooltip Property

Tooltip to display to indicate Expand widget can be expanded.

public string? ExpandTooltip { get; set; }

Property Value

System.String

ExpandWidget.WidgetType Property

The type of widget

public override string WidgetType { get; }

Property Value

System.String

Methods

ExpandWidget.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnAfterRenderAsync(System.Boolean) to “Register” the current component with it’s parent.

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

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

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

ExpandWidget.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 MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task