GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
SupportingWidgetSketch Class
An object containing properties specific for customizing the Sketch widget.
public class SupportingWidgetSketch : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 SupportingWidgetSketch
Constructors
SupportingWidgetSketch(object, SimpleMarkerSymbol, SimpleFillSymbol, SimpleLineSymbol) Constructor
An object containing properties specific for customizing the Sketch widget.
public SupportingWidgetSketch(object? defaultUpdateOptions, dymaptic.GeoBlazor.Core.Components.Symbols.SimpleMarkerSymbol? markerSymbol=null, dymaptic.GeoBlazor.Core.Components.Symbols.SimpleFillSymbol? polygonSymbol=null, dymaptic.GeoBlazor.Core.Components.Symbols.SimpleLineSymbol? polylineSymbol=null);
Parameters
defaultUpdateOptions System.Object
An object containing the defaultUpdateOptions for the Sketch widget.
markerSymbol dymaptic.GeoBlazor.Core.Components.Symbols.SimpleMarkerSymbol
The marker symbol used to symbolize any point feature updates.
polygonSymbol dymaptic.GeoBlazor.Core.Components.Symbols.SimpleFillSymbol
The polygon symbol used to symbolize any polygon feature updates.
polylineSymbol dymaptic.GeoBlazor.Core.Components.Symbols.SimpleLineSymbol
The polygon symbol used to symbolize any polygon feature updates.
Properties
SupportingWidgetSketch.DefaultUpdateOptions Property
An object containing the defaultUpdateOptions for the Sketch widget.
public object? DefaultUpdateOptions { get; set; }
Property Value
SupportingWidgetSketch.MarkerSymbol Property
The marker symbol used to symbolize any point feature updates.
public dymaptic.GeoBlazor.Core.Components.Symbols.SimpleMarkerSymbol? MarkerSymbol { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Symbols.SimpleMarkerSymbol
SupportingWidgetSketch.PolygonSymbol Property
The polygon symbol used to symbolize any polygon feature updates.
public dymaptic.GeoBlazor.Core.Components.Symbols.SimpleFillSymbol? PolygonSymbol { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Symbols.SimpleFillSymbol
SupportingWidgetSketch.PolylineSymbol Property
The polygon symbol used to symbolize any polygon feature updates.
public dymaptic.GeoBlazor.Core.Components.Symbols.SimpleLineSymbol? PolylineSymbol { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Symbols.SimpleLineSymbol
Methods
SupportingWidgetSketch.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.
SupportingWidgetSketch.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.
SupportingWidgetSketch.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