GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
SupportingWidgetFeatureTemplates Class
An object containing properties specific for customizing the FeatureTemplates widget.
public class SupportingWidgetFeatureTemplates : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 SupportingWidgetFeatureTemplates
Constructors
SupportingWidgetFeatureTemplates() Constructor
Parameterless constructor for use as a razor component
public SupportingWidgetFeatureTemplates();
SupportingWidgetFeatureTemplates(string, SupportingWidgetVisibleElements) Constructor
An object containing properties specific for customizing the FeatureTemplates widget.
public SupportingWidgetFeatureTemplates(string? groupBy=null, dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetVisibleElements? visibleElements=null);
Parameters
groupBy
System.String
Aids in managing various template items and how they display within the widget. Please refer to groupBy API reference for additional information.
visibleElements
SupportingWidgetVisibleElements
Holds a single value, “filter”.
Properties
SupportingWidgetFeatureTemplates.GroupBy Property
Aids in managing various template items and how they display within the widget. Please refer to groupBy API reference for additional information.
public string? GroupBy { get; set; }
Property Value
SupportingWidgetFeatureTemplates.VisibleElements Property
Holds a single value, “filter”.
public dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetVisibleElements? VisibleElements { get; set; }
Property Value
SupportingWidgetVisibleElements
Methods
SupportingWidgetFeatureTemplates.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
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.
SupportingWidgetFeatureTemplates.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
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.
SupportingWidgetFeatureTemplates.ValidateRequiredChildren() Method
When a dymaptic.GeoBlazor.Core.Components.Views.MapView is prepared to render, this will check to make sure that all properties with the dymaptic.GeoBlazor.Core.Attributes.RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredChildElementException
The consumer needs to provide the missing child component
dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components