GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
SketchWidgetVisibleElements Class
The visible elements that are displayed within the widget. ArcGIS Maps SDK for JavaScript
public class SketchWidgetVisibleElements : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 SketchWidgetVisibleElements
Constructors
SketchWidgetVisibleElements() Constructor
Parameterless constructor for use as a Razor Component.
public SketchWidgetVisibleElements();
SketchWidgetVisibleElements(CreateTools, Nullable, Nullable, Nullable, Nullable, SelectionTools, Nullable, Nullable, SnappingControlsElements, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public SketchWidgetVisibleElements(dymaptic.GeoBlazor.Pro.Components.CreateTools? createTools=null, System.Nullable<bool> deleteButton=null, System.Nullable<bool> duplicateButton=null, System.Nullable<bool> labelsToggle=null, System.Nullable<bool> selectionCountLabel=null, dymaptic.GeoBlazor.Pro.Components.SelectionTools? selectionTools=null, System.Nullable<bool> settingsMenu=null, System.Nullable<bool> snappingControls=null, dymaptic.GeoBlazor.Pro.Components.SnappingControlsElements? snappingControlsElements=null, System.Nullable<bool> tooltipsToggle=null, System.Nullable<bool> undoRedoMenu=null);
Parameters
createTools CreateTools
The available sketch tools within the widget.
deleteButton System.Nullable<System.Boolean>
Indicates whether to display the ‘delete’ button while a graphic is selected. Default is true. Do not hide this button without giving users on touch devices another way to delete selected geometries.
duplicateButton System.Nullable<System.Boolean>
Indicates whether to display the ‘duplicate’ button while a graphic is selected. Default is true.
labelsToggle System.Nullable<System.Boolean>
Indicates whether to display the sketch labels toggle. Default value is true.
selectionCountLabel System.Nullable<System.Boolean>
Indicates whether to display a label indicating the length of the currently selected feature set.
selectionTools SelectionTools
The available selection tools within the widget. Known Limitation: Rectangle and lasso selection is only supported when working with a MapView.
settingsMenu System.Nullable<System.Boolean>
Indicates whether to display the settings menu. Currently this menu contains snapping options. Default value is true.
snappingControls System.Nullable<System.Boolean>
Indicates whether to display the SnappingControls widget. Default is true.
snappingControlsElements SnappingControlsElements
The available SnappingControls elements within the widget.
tooltipsToggle System.Nullable<System.Boolean>
Indicates whether to display the tooltips toggle. Default value is true.
undoRedoMenu System.Nullable<System.Boolean>
Indicates whether to display the undo/redo menu within the widget. Default is true.
Properties
SketchWidgetVisibleElements.CreateTools Property
The available sketch tools within the widget.
public dymaptic.GeoBlazor.Pro.Components.CreateTools? CreateTools { get; set; }
Property Value
SketchWidgetVisibleElements.DeleteButton Property
Indicates whether to display the ‘delete’ button while a graphic is selected. Default is true. Do not hide this button without giving users on touch devices another way to delete selected geometries.
public System.Nullable<bool> DeleteButton { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.DuplicateButton Property
Indicates whether to display the ‘duplicate’ button while a graphic is selected. Default is true.
public System.Nullable<bool> DuplicateButton { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.LabelsToggle Property
Indicates whether to display the sketch labels toggle. Default value is true.
public System.Nullable<bool> LabelsToggle { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.SelectionCountLabel Property
Indicates whether to display a label indicating the length of the currently selected feature set.
public System.Nullable<bool> SelectionCountLabel { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.SelectionTools Property
The available selection tools within the widget.
public dymaptic.GeoBlazor.Pro.Components.SelectionTools? SelectionTools { get; set; }
Property Value
SketchWidgetVisibleElements.SettingsMenu Property
Indicates whether to display the settings menu. Currently this menu contains snapping options. Default value is true.
public System.Nullable<bool> SettingsMenu { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.SnappingControls Property
Indicates whether to display the SnappingControls widget. Default is true.
public System.Nullable<bool> SnappingControls { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.SnappingControlsElements Property
The available SnappingControls elements within the widget.
public dymaptic.GeoBlazor.Pro.Components.SnappingControlsElements? SnappingControlsElements { get; set; }
Property Value
SketchWidgetVisibleElements.TooltipsToggle Property
Indicates whether to display the tooltips toggle. Default value is true.
public System.Nullable<bool> TooltipsToggle { get; set; }
Property Value
System.Nullable<System.Boolean>
SketchWidgetVisibleElements.UndoRedoMenu Property
Indicates whether to display the undo/redo menu within the widget. Default is true.
public System.Nullable<bool> UndoRedoMenu { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
SketchWidgetVisibleElements.GetCreateTools() Method
Asynchronously retrieve the current value of the CreateTools property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.CreateTools?> GetCreateTools();
Returns
System.Threading.Tasks.Task<CreateTools>
SketchWidgetVisibleElements.GetDeleteButton() Method
Asynchronously retrieve the current value of the DeleteButton property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDeleteButton();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetDuplicateButton() Method
Asynchronously retrieve the current value of the DuplicateButton property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDuplicateButton();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetLabelsToggle() Method
Asynchronously retrieve the current value of the LabelsToggle property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLabelsToggle();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetSelectionCountLabel() Method
Asynchronously retrieve the current value of the SelectionCountLabel property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSelectionCountLabel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetSelectionTools() Method
Asynchronously retrieve the current value of the SelectionTools property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.SelectionTools?> GetSelectionTools();
Returns
System.Threading.Tasks.Task<SelectionTools>
SketchWidgetVisibleElements.GetSettingsMenu() Method
Asynchronously retrieve the current value of the SettingsMenu property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSettingsMenu();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetSnappingControls() Method
Asynchronously retrieve the current value of the SnappingControls property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSnappingControls();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetSnappingControlsElements() Method
Asynchronously retrieve the current value of the SnappingControlsElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.SnappingControlsElements?> GetSnappingControlsElements();
Returns
System.Threading.Tasks.Task<SnappingControlsElements>
SketchWidgetVisibleElements.GetTooltipsToggle() Method
Asynchronously retrieve the current value of the TooltipsToggle property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetTooltipsToggle();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.GetUndoRedoMenu() Method
Asynchronously retrieve the current value of the UndoRedoMenu property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetUndoRedoMenu();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SketchWidgetVisibleElements.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 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.
SketchWidgetVisibleElements.SetCreateTools(CreateTools) Method
Asynchronously set the value of the CreateTools property after render.
public System.Threading.Tasks.Task SetCreateTools(dymaptic.GeoBlazor.Pro.Components.CreateTools? value);
Parameters
value CreateTools
The value to set.
Returns
SketchWidgetVisibleElements.SetDeleteButton(Nullable) Method
Asynchronously set the value of the DeleteButton property after render.
public System.Threading.Tasks.Task SetDeleteButton(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetDuplicateButton(Nullable) Method
Asynchronously set the value of the DuplicateButton property after render.
public System.Threading.Tasks.Task SetDuplicateButton(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetLabelsToggle(Nullable) Method
Asynchronously set the value of the LabelsToggle property after render.
public System.Threading.Tasks.Task SetLabelsToggle(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetSelectionCountLabel(Nullable) Method
Asynchronously set the value of the SelectionCountLabel property after render.
public System.Threading.Tasks.Task SetSelectionCountLabel(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetSelectionTools(SelectionTools) Method
Asynchronously set the value of the SelectionTools property after render.
public System.Threading.Tasks.Task SetSelectionTools(dymaptic.GeoBlazor.Pro.Components.SelectionTools? value);
Parameters
value SelectionTools
The value to set.
Returns
SketchWidgetVisibleElements.SetSettingsMenu(Nullable) Method
Asynchronously set the value of the SettingsMenu property after render.
public System.Threading.Tasks.Task SetSettingsMenu(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetSnappingControls(Nullable) Method
Asynchronously set the value of the SnappingControls property after render.
public System.Threading.Tasks.Task SetSnappingControls(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetSnappingControlsElements(SnappingControlsElements) Method
Asynchronously set the value of the SnappingControlsElements property after render.
public System.Threading.Tasks.Task SetSnappingControlsElements(dymaptic.GeoBlazor.Pro.Components.SnappingControlsElements? value);
Parameters
value SnappingControlsElements
The value to set.
Returns
SketchWidgetVisibleElements.SetTooltipsToggle(Nullable) Method
Asynchronously set the value of the TooltipsToggle property after render.
public System.Threading.Tasks.Task SetTooltipsToggle(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.SetUndoRedoMenu(Nullable) Method
Asynchronously set the value of the UndoRedoMenu property after render.
public System.Threading.Tasks.Task SetUndoRedoMenu(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SketchWidgetVisibleElements.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.
SketchWidgetVisibleElements.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components