GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
SketchWidget Class
Sketch widget provides a simple UI for creating and updating graphics on a MapView or
a SceneView.
ArcGIS Maps SDK for JavaScript
public class SketchWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 SketchWidget
Constructors
SketchWidget() Constructor
Parameterless constructor for use as a Razor Component.
public SketchWidget();
SketchWidget(IReadOnlyList, string, Nullable, SketchToolCreateOptions, SketchToolUpdateOptions, string, string, SketchLabelOptions, GraphicsLayer, Nullable, MapView, Nullable, Nullable, SnappingOptions, Nullable, SketchTooltipOptions, SketchValueOptions, SketchViewModel, Nullable, SketchWidgetVisibleElements, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public SketchWidget(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool>? availableCreateTools=null, string? containerId=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CreationMode> creationMode=null, dymaptic.GeoBlazor.Pro.Options.SketchToolCreateOptions? defaultCreateOptions=null, dymaptic.GeoBlazor.Pro.Options.SketchToolUpdateOptions? defaultUpdateOptions=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions? labelOptions=null, dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer? layer=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetLayout> layout=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Scale> scale=null, dymaptic.GeoBlazor.Core.Components.SnappingOptions? snappingOptions=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.ToolbarKind> toolbarKind=null, dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions? tooltipOptions=null, dymaptic.GeoBlazor.Pro.Options.SketchValueOptions? valueOptions=null, dymaptic.GeoBlazor.Pro.Components.SketchViewModel? viewModel=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Pro.Components.SketchWidgetVisibleElements? visibleElements=null, string? widgetId=null);
Parameters
availableCreateTools System.Collections.Generic.IReadOnlyList<AvailableCreateTool>
Property controlling the visibility and order of create tool buttons.
default [“point”, “polyline”, “polygon”, “rectangle”, “circle”]
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.
creationMode System.Nullable<CreationMode>
Defines the default behavior once the create operation is completed.
default “continuous”
ArcGIS Maps SDK for JavaScript
defaultCreateOptions SketchToolCreateOptions
Default create options set for the Sketch widget.
ArcGIS Maps SDK for JavaScript
defaultUpdateOptions SketchToolUpdateOptions
Default update options set for the Sketch widget.
ArcGIS Maps SDK for JavaScript
icon System.String
Icon which represents the widget.
default “pencil”
ArcGIS Maps SDK for JavaScript
label System.String
The Sketch widget’s default label.
ArcGIS Maps SDK for JavaScript
labelOptions SketchLabelOptions
Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
ArcGIS Maps SDK for JavaScript
layer dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer
The GraphicsLayer associated with the Sketch widget.
ArcGIS Maps SDK for JavaScript
layout System.Nullable<SketchWidgetLayout>
Determines the layout/orientation of the Sketch widget.
default “horizontal”
ArcGIS Maps SDK for JavaScript
mapView dymaptic.GeoBlazor.Core.Components.Views.MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
position System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition>
The position of the widget in relation to the map view.
scale System.Nullable<Scale>
Determines the size of widget elements.
default “m”
ArcGIS Maps SDK for JavaScript
snappingOptions dymaptic.GeoBlazor.Core.Components.SnappingOptions
The SnappingOptions for sketching.
ArcGIS Maps SDK for JavaScript
toolbarKind System.Nullable<ToolbarKind>
Controls the appearance of the sketch widget, allowing
the toolbar to adapt its appearance appropriately based on context.
default “floating”
ArcGIS Maps SDK for JavaScript
tooltipOptions SketchTooltipOptions
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
ArcGIS Maps SDK for JavaScript
valueOptions SketchValueOptions
Options to configure how values are displayed and input when creating or updating graphics.
ArcGIS Maps SDK for JavaScript
viewModel SketchViewModel
The view model for the Sketch widget.
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript
visibleElements SketchWidgetVisibleElements
The visible elements that are displayed within the widget.
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
SketchWidget.ActiveTool Property
When creating new graphics (for example after create() has been called),
this property reflects the create tool being used.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ActiveTool> ActiveTool { get; set; }
Property Value
System.Nullable<dymaptic.GeoBlazor.Core.Enums.ActiveTool>
SketchWidget.ActiveTooltip Property
The tooltip currently being displayed for the activeTool.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Model.Tooltip? ActiveTooltip { get; set; }
Property Value
SketchWidget.AvailableCreateTools Property
Property controlling the visibility and order of create tool buttons.
default [“point”, “polyline”, “polygon”, “rectangle”, “circle”]
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool>? AvailableCreateTools { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<AvailableCreateTool>
SketchWidget.CreateGraphic Property
The graphic that is being created.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Graphic? CreateGraphic { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Graphic
SketchWidget.CreationMode Property
Defines the default behavior once the create operation is completed. By default, the user will be able to continuously create graphics with same geometry types.
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CreationMode> CreationMode { get; set; }
Property Value
SketchWidget.DefaultCreateOptions Property
Default create options set for the Sketch widget.
public dymaptic.GeoBlazor.Pro.Options.SketchToolCreateOptions? DefaultCreateOptions { get; set; }
Property Value
SketchWidget.DefaultUpdateOptions Property
Default update options set for the Sketch widget. Update options set on this property will be overwritten if the update options are changed when update() method is called.
public dymaptic.GeoBlazor.Pro.Options.SketchToolUpdateOptions? DefaultUpdateOptions { get; set; }
Property Value
SketchWidget.EventRateLimitInMilliseconds Property
Controls how often the events are fired.
public int EventRateLimitInMilliseconds { get; set; }
Property Value
SketchWidget.GraphicsLayer Property
The GraphicsLayer to which the sketch widget is bound.
public dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer? GraphicsLayer { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer
SketchWidget.GraphicsLayerId Property
Id reference to the editable graphics layer
public System.Guid GraphicsLayerId { get; set; }
Property Value
SketchWidget.LabelOptions Property
Options to configure the labels shown next to each segment of the geometry being created or updated.
public dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions? LabelOptions { get; set; }
Property Value
SketchWidget.Layout Property
Determines the layout/orientation of the Sketch widget.
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetLayout> Layout { get; set; }
Property Value
System.Nullable<SketchWidgetLayout>
SketchWidget.OnCreate Property
Event Listener for Create.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchCreateEvent> OnCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchCreateEvent>
SketchWidget.OnDelete Property
Event Listener for Delete.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchDeleteEvent> OnDelete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchDeleteEvent>
SketchWidget.OnRedo Property
Event Listener for Redo.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchRedoEvent> OnRedo { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchRedoEvent>
SketchWidget.OnSketchEvent Property
Event Callback for handling all sketch Events.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchEvent> OnSketchEvent { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchEvent>
SketchWidget.OnUndo Property
Event Listener for Undo.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchUndoEvent> OnUndo { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchUndoEvent>
SketchWidget.OnUpdate Property
Event Listener for Update.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.SketchUpdateEvent> OnUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SketchUpdateEvent>
SketchWidget.Scale Property
Determines the size of widget elements.
default “m”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Scale> Scale { get; set; }
Property Value
SketchWidget.SnappingOptions Property
The SnappingOptions for sketching.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SnappingOptions? SnappingOptions { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.SnappingOptions
SketchWidget.State Property
The Sketch widget’s state.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetState> State { get; set; }
Property Value
System.Nullable<SketchWidgetState>
SketchWidget.ToolbarKind Property
Controls the appearance of the sketch widget, allowing
the toolbar to adapt its appearance appropriately based on context.
default “floating”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.ToolbarKind> ToolbarKind { get; set; }
Property Value
SketchWidget.TooltipOptions Property
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
public dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions? TooltipOptions { get; set; }
Property Value
SketchWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
SketchWidget.UpdateGraphics Property
An array of graphics that are being updated by the Sketch widget.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>? UpdateGraphics { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Graphic>
SketchWidget.UpdateOnGraphicClick Property
public System.Nullable<bool> UpdateOnGraphicClick { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidget.ValueOptions Property
Options to configure how values are displayed and input when creating or updating graphics.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.SketchValueOptions? ValueOptions { get; set; }
Property Value
SketchWidget.ViewModel Property
The view model for the Sketch widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.SketchViewModel? ViewModel { get; set; }
Property Value
SketchWidget.VisibleElements Property
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.SketchWidgetVisibleElements? VisibleElements { get; set; }
Property Value
Methods
SketchWidget.AddToAvailableCreateTools(AvailableCreateTool[]) Method
Asynchronously adds elements to the AvailableCreateTools property.
public System.Threading.Tasks.Task AddToAvailableCreateTools(params dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool[] values);
Parameters
values AvailableCreateTool[]
The elements to add.
Returns
SketchWidget.Cancel() Method
Cancels the active operation and fires the create or update event. If called in the middle of a create operation, cancel() discards the partially created graphic.
public System.Threading.Tasks.Task Cancel();
Returns
SketchWidget.Complete() Method
Completes the active operation and fires the create or update event and changes the event’s state to complete. If called in the middle of a create operation, complete() finishes the active create operation and keeps the valid geometry.
public System.Threading.Tasks.Task Complete();
Returns
SketchWidget.Create(SketchTool, SketchToolCreateOptions) Method
Create a graphic with the geometry specified in the tool parameter. When the first vertex of the graphic is added, the create event will start firing. The provided tool will become the activeTool.
public System.Threading.Tasks.Task Create(dymaptic.GeoBlazor.Pro.Enums.SketchTool tool, dymaptic.GeoBlazor.Pro.Options.SketchToolCreateOptions options);
Parameters
tool SketchTool
Name of the create tool. Specifies the geometry for the graphic to be created.
Possible Values:”point”|”polyline”|”polygon”|”rectangle”|”circle”
options SketchToolCreateOptions
Options for the graphic to be created.
Returns
SketchWidget.Delete() Method
Deletes the selected graphics used in the update workflow. Calling this method will fire the delete event.
public System.Threading.Tasks.Task Delete();
Returns
SketchWidget.Duplicate() Method
Duplicates current graphics used in the update workflow and automatically adds them to the associated layer
public System.Threading.Tasks.Task Duplicate();
Returns
SketchWidget.GetActiveTool() Method
When creating new graphics (for example after create() has been called), this property reflects the create tool being used. When updating graphics (for example after update() has been called), this property reflects the update tool being used. If no create or update operation is in progress, this is null.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchTool>> GetActiveTool();
Returns
System.Threading.Tasks.Task<System.Nullable<SketchTool>>
SketchWidget.GetActiveTooltip() Method
Asynchronously retrieve the current value of the ActiveTooltip property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.Tooltip?> GetActiveTooltip();
Returns
System.Threading.Tasks.Task<Tooltip>
SketchWidget.GetAvailableCreateTools() Method
Asynchronously retrieve the current value of the AvailableCreateTools property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool>?> GetAvailableCreateTools();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<AvailableCreateTool>>
SketchWidget.GetCreateGraphic() Method
Returns the graphic that is being created.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetCreateGraphic();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic>
SketchWidget.GetCreationMode() Method
Asynchronously retrieve the current value of the CreationMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CreationMode>> GetCreationMode();
Returns
System.Threading.Tasks.Task<System.Nullable<CreationMode>>
SketchWidget.GetDefaultCreateOptions() Method
Asynchronously retrieve the current value of the DefaultCreateOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.SketchToolCreateOptions?> GetDefaultCreateOptions();
Returns
System.Threading.Tasks.Task<SketchToolCreateOptions>
SketchWidget.GetDefaultUpdateOptions() Method
Asynchronously retrieve the current value of the DefaultUpdateOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.SketchToolUpdateOptions?> GetDefaultUpdateOptions();
Returns
System.Threading.Tasks.Task<SketchToolUpdateOptions>
SketchWidget.GetLabelOptions() Method
Asynchronously retrieve the current value of the LabelOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions?> GetLabelOptions();
Returns
System.Threading.Tasks.Task<SketchLabelOptions>
SketchWidget.GetLayer() Method
Asynchronously retrieve the current value of the Layer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer?> GetLayer();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer>
SketchWidget.GetLayout() Method
Asynchronously retrieve the current value of the Layout property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetLayout>> GetLayout();
Returns
System.Threading.Tasks.Task<System.Nullable<SketchWidgetLayout>>
SketchWidget.GetScale() Method
Asynchronously retrieve the current value of the Scale property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Scale>> GetScale();
Returns
System.Threading.Tasks.Task<System.Nullable<Scale>>
SketchWidget.GetSnappingOptions() Method
Asynchronously retrieve the current value of the SnappingOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SnappingOptions?> GetSnappingOptions();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SnappingOptions>
SketchWidget.GetState() Method
Asynchronously retrieve the current value of the State property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<SketchWidgetState>>
SketchWidget.GetToolbarKind() Method
Asynchronously retrieve the current value of the ToolbarKind property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.ToolbarKind>> GetToolbarKind();
Returns
System.Threading.Tasks.Task<System.Nullable<ToolbarKind>>
SketchWidget.GetTooltipOptions() Method
Asynchronously retrieve the current value of the TooltipOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions?> GetTooltipOptions();
Returns
System.Threading.Tasks.Task<SketchTooltipOptions>
SketchWidget.GetUpdateGraphics() Method
An array of graphics that are being updated by the Sketch widget.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic[]?> GetUpdateGraphics();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic[]>
SketchWidget.GetValueOptions() Method
Asynchronously retrieve the current value of the ValueOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.SketchValueOptions?> GetValueOptions();
Returns
System.Threading.Tasks.Task<SketchValueOptions>
SketchWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.SketchViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<SketchViewModel>
SketchWidget.GetVisibleElements() Method
Asynchronously retrieve the current value of the VisibleElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.SketchWidgetVisibleElements?> GetVisibleElements();
Returns
System.Threading.Tasks.Task<SketchWidgetVisibleElements>
SketchWidget.OnJsCreate(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsCreate(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SketchWidget.OnJsDelete(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsDelete(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SketchWidget.OnJsRedo(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsRedo(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SketchWidget.OnJsUndo(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsUndo(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SketchWidget.OnJsUpdate(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsUpdate(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SketchWidget.Redo() Method
Incrementally redo actions recorded in the stack. Calling this method will fire the redo event. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
public System.Threading.Tasks.Task Redo();
Returns
SketchWidget.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.
SketchWidget.RemoveFromAvailableCreateTools(AvailableCreateTool[]) Method
Asynchronously remove an element from the AvailableCreateTools property.
public System.Threading.Tasks.Task RemoveFromAvailableCreateTools(params dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool[] values);
Parameters
values AvailableCreateTool[]
The elements to remove.
Returns
SketchWidget.SetAvailableCreateTools(IReadOnlyList) Method
Asynchronously set the value of the AvailableCreateTools property after render.
public System.Threading.Tasks.Task SetAvailableCreateTools(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Enums.AvailableCreateTool>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<AvailableCreateTool>
The value to set.
Returns
SketchWidget.SetCreationMode(Nullable) Method
Asynchronously set the value of the CreationMode property after render.
public System.Threading.Tasks.Task SetCreationMode(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.CreationMode> value);
Parameters
value System.Nullable<CreationMode>
The value to set.
Returns
SketchWidget.SetDefaultCreateOptions(SketchToolCreateOptions) Method
Asynchronously set the value of the DefaultCreateOptions property after render.
public System.Threading.Tasks.Task SetDefaultCreateOptions(dymaptic.GeoBlazor.Pro.Options.SketchToolCreateOptions? value);
Parameters
value SketchToolCreateOptions
The value to set.
Returns
SketchWidget.SetDefaultUpdateOptions(SketchToolUpdateOptions) Method
Asynchronously set the value of the DefaultUpdateOptions property after render.
public System.Threading.Tasks.Task SetDefaultUpdateOptions(dymaptic.GeoBlazor.Pro.Options.SketchToolUpdateOptions? value);
Parameters
value SketchToolUpdateOptions
The value to set.
Returns
SketchWidget.SetLabelOptions(SketchLabelOptions) Method
Asynchronously set the value of the LabelOptions property after render.
public System.Threading.Tasks.Task SetLabelOptions(dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions? value);
Parameters
value SketchLabelOptions
The value to set.
Returns
SketchWidget.SetLayer(GraphicsLayer) Method
Asynchronously set the value of the Layer property after render.
public System.Threading.Tasks.Task SetLayer(dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Layers.GraphicsLayer
The value to set.
Returns
SketchWidget.SetLayout(Nullable) Method
Asynchronously set the value of the Layout property after render.
public System.Threading.Tasks.Task SetLayout(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchWidgetLayout> value);
Parameters
value System.Nullable<SketchWidgetLayout>
The value to set.
Returns
SketchWidget.SetScale(Nullable) Method
Asynchronously set the value of the Scale property after render.
public System.Threading.Tasks.Task SetScale(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.Scale> value);
Parameters
value System.Nullable<Scale>
The value to set.
Returns
SketchWidget.SetSnappingOptions(SnappingOptions) Method
Asynchronously set the value of the SnappingOptions property after render.
public System.Threading.Tasks.Task SetSnappingOptions(dymaptic.GeoBlazor.Core.Components.SnappingOptions? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.SnappingOptions
The value to set.
Returns
SketchWidget.SetToolbarKind(Nullable) Method
Asynchronously set the value of the ToolbarKind property after render.
public System.Threading.Tasks.Task SetToolbarKind(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.ToolbarKind> value);
Parameters
value System.Nullable<ToolbarKind>
The value to set.
Returns
SketchWidget.SetTooltipOptions(SketchTooltipOptions) Method
Asynchronously set the value of the TooltipOptions property after render.
public System.Threading.Tasks.Task SetTooltipOptions(dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions? value);
Parameters
value SketchTooltipOptions
The value to set.
Returns
SketchWidget.SetValueOptions(SketchValueOptions) Method
Asynchronously set the value of the ValueOptions property after render.
public System.Threading.Tasks.Task SetValueOptions(dymaptic.GeoBlazor.Pro.Options.SketchValueOptions? value);
Parameters
value SketchValueOptions
The value to set.
Returns
SketchWidget.SetViewModel(SketchViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.SketchViewModel? value);
Parameters
value SketchViewModel
The value to set.
Returns
SketchWidget.SetVisibleElements(SketchWidgetVisibleElements) Method
Asynchronously set the value of the VisibleElements property after render.
public System.Threading.Tasks.Task SetVisibleElements(dymaptic.GeoBlazor.Pro.Components.SketchWidgetVisibleElements? value);
Parameters
value SketchWidgetVisibleElements
The value to set.
Returns
SketchWidget.Undo() Method
Incrementally undo actions recorded in the stack. Calling this method will fire the undo event. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
public System.Threading.Tasks.Task Undo();
Returns
SketchWidget.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.
SketchWidget.Update(IEnumerable, SketchToolUpdateOptions) Method
Initializes an update operation for the specified graphic(s) and fires update event.
public System.Threading.Tasks.Task Update(System.Collections.Generic.IEnumerable<dymaptic.GeoBlazor.Core.Components.Graphic> graphics, dymaptic.GeoBlazor.Pro.Options.SketchToolUpdateOptions options);
Parameters
graphics System.Collections.Generic.IEnumerable<dymaptic.GeoBlazor.Core.Components.Graphic>
A graphic or an array of graphics to be updated. Only graphics added to SketchViewModel’s layer property can be updated.
options SketchToolUpdateOptions
Update options for the graphics to be updated.
Returns
SketchWidget.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
SketchWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()