layout: default title: ExpandWidget parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
ExpandWidget Class
The Expand widget acts as a clickable button for opening a widget.
ArcGIS Maps SDK for JavaScript
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.CollapseIcon Property
Calcite icon used to style the Expand button when the content can be collapsed.
public string? CollapseIcon { get; set; }
Property Value
ExpandWidget.CollapseTooltip Property
Tooltip to display to indicate Expand widget can be collapsed.
public string? CollapseTooltip { get; set; }
Property Value
ExpandWidget.Expanded Property
Indicates whether the widget is currently expanded or not.
public System.Nullable<bool> Expanded { get; set; }
Property Value
System.Nullable<System.Boolean>
ExpandWidget.ExpandIcon Property
Calcite icon used when the widget is collapsed. Will automatically use the content’s icon if it has one.
public string? ExpandIcon { get; set; }
Property Value
ExpandWidget.ExpandTooltip Property
Tooltip to display to indicate Expand widget can be expanded
public string? ExpandTooltip { get; set; }
Property Value
ExpandWidget.HtmlContent Property
The custom HTML content to display within the expanded Expand widget.
public string? HtmlContent { get; set; }
Property Value
Remarks
You can now define custom HTML inline in Razor markup inside an Expand widget, instead of using this parameter.
ExpandWidget.Mode Property
The mode in which the widget displays.
public dymaptic.GeoBlazor.Core.Components.Widgets.Mode Mode { get; set; }
Property Value
ExpandWidget.WidgetContent Property
The content to display within the expanded Expand widget.
public dymaptic.GeoBlazor.Core.Components.Widgets.Widget? WidgetContent { get; set; }
Property Value
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.WidgetType Property
The type of widget
public override string WidgetType { get; }
Property Value
Methods
ExpandWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync 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
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.
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
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.