GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
EditorWidgetVisibleElements Class
The visible elements that are displayed within the widget.
ArcGIS Maps SDK for JavaScript
public class EditorWidgetVisibleElements : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 EditorWidgetVisibleElements
Constructors
EditorWidgetVisibleElements() Constructor
Parameterless constructor for use as a Razor Component.
public EditorWidgetVisibleElements();
EditorWidgetVisibleElements(Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, VisibleElementsSnappingControlsElements, 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 EditorWidgetVisibleElements(System.Nullable<bool> createFeaturesSection=null, System.Nullable<bool> editFeaturesSection=null, System.Nullable<bool> flow=null, System.Nullable<bool> labelsToggle=null, System.Nullable<bool> settingsMenu=null, System.Nullable<bool> sketch=null, System.Nullable<bool> snappingControls=null, dymaptic.GeoBlazor.Pro.Components.VisibleElementsSnappingControlsElements? snappingControlsElements=null, System.Nullable<bool> tooltipsToggle=null, System.Nullable<bool> undoRedoButtons=null);
Parameters
createFeaturesSection System.Nullable<System.Boolean>
Since 4.28.
ArcGIS Maps SDK for JavaScript
editFeaturesSection System.Nullable<System.Boolean>
Since 4.28.
ArcGIS Maps SDK for JavaScript
flow System.Nullable<System.Boolean>
labelsToggle System.Nullable<System.Boolean>
Since 4.29.
ArcGIS Maps SDK for JavaScript
settingsMenu System.Nullable<System.Boolean>
Since 4.30.
ArcGIS Maps SDK for JavaScript
sketch System.Nullable<System.Boolean>
snappingControls System.Nullable<System.Boolean>
Indicates whether to display the SnappingControls widget.
ArcGIS Maps SDK for JavaScript
snappingControlsElements VisibleElementsSnappingControlsElements
The available SnappingControls elements within the widget.
ArcGIS Maps SDK for JavaScript
tooltipsToggle System.Nullable<System.Boolean>
Since 4.29.
ArcGIS Maps SDK for JavaScript
undoRedoButtons System.Nullable<System.Boolean>
Properties
EditorWidgetVisibleElements.CreateFeaturesSection Property
Since 4.28.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> CreateFeaturesSection { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.EditFeaturesSection Property
Since 4.28.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> EditFeaturesSection { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.Flow Property
public System.Nullable<bool> Flow { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.LabelsToggle Property
Since 4.29.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> LabelsToggle { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.SettingsMenu Property
Since 4.30.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> SettingsMenu { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.Sketch Property
public System.Nullable<bool> Sketch { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.SketchTooltipControls Property
Indicates whether to display tooltips while sketching. Default value is true.
public System.Nullable<bool> SketchTooltipControls { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.SnappingControls Property
Indicates whether snapping controls will be displayed. Default value is true.
public System.Nullable<bool> SnappingControls { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.SnappingControlsElement Property
The elements contained within the snapping controls.
public dymaptic.GeoBlazor.Pro.Components.SnappingControlsElement? SnappingControlsElement { get; set; }
Property Value
EditorWidgetVisibleElements.SnappingControlsElements Property
The available SnappingControls elements within the widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.VisibleElementsSnappingControlsElements? SnappingControlsElements { get; set; }
Property Value
VisibleElementsSnappingControlsElements
EditorWidgetVisibleElements.TooltipsToggle Property
Since 4.29.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> TooltipsToggle { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorWidgetVisibleElements.UndoRedoButtons Property
public System.Nullable<bool> UndoRedoButtons { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
EditorWidgetVisibleElements.GetCreateFeaturesSection() Method
Asynchronously retrieve the current value of the CreateFeaturesSection property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetCreateFeaturesSection();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorWidgetVisibleElements.GetEditFeaturesSection() Method
Asynchronously retrieve the current value of the EditFeaturesSection property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetEditFeaturesSection();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorWidgetVisibleElements.GetFlow() Method
Asynchronously retrieve the current value of the Flow property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetFlow();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorWidgetVisibleElements.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>>
EditorWidgetVisibleElements.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>>
EditorWidgetVisibleElements.GetSketch() Method
Asynchronously retrieve the current value of the Sketch property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSketch();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorWidgetVisibleElements.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>>
EditorWidgetVisibleElements.GetSnappingControlsElements() Method
Asynchronously retrieve the current value of the SnappingControlsElements property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.VisibleElementsSnappingControlsElements?> GetSnappingControlsElements();
Returns
System.Threading.Tasks.Task<VisibleElementsSnappingControlsElements>
EditorWidgetVisibleElements.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>>
EditorWidgetVisibleElements.GetUndoRedoButtons() Method
Asynchronously retrieve the current value of the UndoRedoButtons property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetUndoRedoButtons();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorWidgetVisibleElements.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.
EditorWidgetVisibleElements.SetCreateFeaturesSection(Nullable) Method
Asynchronously set the value of the CreateFeaturesSection property after render.
public System.Threading.Tasks.Task SetCreateFeaturesSection(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
EditorWidgetVisibleElements.SetEditFeaturesSection(Nullable) Method
Asynchronously set the value of the EditFeaturesSection property after render.
public System.Threading.Tasks.Task SetEditFeaturesSection(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
EditorWidgetVisibleElements.SetFlow(Nullable) Method
Asynchronously set the value of the Flow property after render.
public System.Threading.Tasks.Task SetFlow(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
EditorWidgetVisibleElements.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
EditorWidgetVisibleElements.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
EditorWidgetVisibleElements.SetSketch(Nullable) Method
Asynchronously set the value of the Sketch property after render.
public System.Threading.Tasks.Task SetSketch(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
EditorWidgetVisibleElements.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
EditorWidgetVisibleElements.SetSnappingControlsElements(VisibleElementsSnappingControlsElements) Method
Asynchronously set the value of the SnappingControlsElements property after render.
public System.Threading.Tasks.Task SetSnappingControlsElements(dymaptic.GeoBlazor.Pro.Components.VisibleElementsSnappingControlsElements? value);
Parameters
value VisibleElementsSnappingControlsElements
The value to set.
Returns
EditorWidgetVisibleElements.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
EditorWidgetVisibleElements.SetUndoRedoButtons(Nullable) Method
Asynchronously set the value of the UndoRedoButtons property after render.
public System.Threading.Tasks.Task SetUndoRedoButtons(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
EditorWidgetVisibleElements.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.
EditorWidgetVisibleElements.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()