GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
EditorViewModel Class
Provides the logic for the Editor widget.
ArcGIS Maps SDK for JavaScript
public class EditorViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IViewModel
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 EditorViewModel
Implements dymaptic.GeoBlazor.Core.Interfaces.IViewModel
Constructors
EditorViewModel() Constructor
Parameterless constructor for use as a Razor Component.
public EditorViewModel();
EditorViewModel(AttachmentsViewModel, FeatureTemplatesViewModel, SketchLabelOptions, IReadOnlyList, SnappingOptions, SketchTooltipOptions, SketchValueOptions) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public EditorViewModel(dymaptic.GeoBlazor.Pro.Components.AttachmentsViewModel? attachmentsViewModel=null, dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? featureTemplatesViewModel=null, dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions? labelOptions=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo>? layerInfos=null, dymaptic.GeoBlazor.Core.Components.SnappingOptions? snappingOptions=null, dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions? tooltipOptions=null, dymaptic.GeoBlazor.Pro.Options.SketchValueOptions? valueOptions=null);
Parameters
attachmentsViewModel AttachmentsViewModel
The AttachmentsViewModel for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
featureTemplatesViewModel FeatureTemplatesViewModel
The FeatureTemplatesViewModel
for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
labelOptions SketchLabelOptions
Options to configure the labels shown next to each segment of the geometry being created or updated.
ArcGIS Maps SDK for JavaScript
layerInfos System.Collections.Generic.IReadOnlyList<EditorLayerInfo>
An array of editing configurations for individual layers.
ArcGIS Maps SDK for JavaScript
snappingOptions dymaptic.GeoBlazor.Core.Components.SnappingOptions
The SnappingOptions for sketching.
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
Properties
EditorViewModel.ActiveWorkflow Property
A property indicating the current active workflow.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelActiveWorkflow? ActiveWorkflow { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelActiveWorkflow
EditorViewModel.AttachmentsViewModel Property
The AttachmentsViewModel for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.AttachmentsViewModel? AttachmentsViewModel { get; set; }
Property Value
EditorViewModel.CanCreate Property
Convenience property that indicates at least one layer supports a create-features workflow.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> CanCreate { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorViewModel.CanUpdate Property
Convenience property that indicates at least one layer supports a update workflow.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> CanUpdate { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorViewModel.EditorItems Property
A predominantly read-only collection of editor items that corresponds to the feature being updated.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.EditorItem>? EditorItems { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<EditorItem>
EditorViewModel.Failures Property
An array of objects containing information specific to any failed editing operations.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorViewModelFailures>? Failures { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<EditorViewModelFailures>
EditorViewModel.FeatureFormViewModel Property
The FeatureFormViewModel
for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel? FeatureFormViewModel { get; set; }
Property Value
EditorViewModel.FeatureTemplatesViewModel Property
The FeatureTemplatesViewModel
for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? FeatureTemplatesViewModel { get; set; }
Property Value
EditorViewModel.HasSketchCreateListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSketchCreateListener { get; }
Property Value
EditorViewModel.HasSketchUpdateListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSketchUpdateListener { get; }
Property Value
EditorViewModel.LabelOptions Property
Options to configure the labels shown next to each segment of the geometry being created or updated.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.SketchLabelOptions? LabelOptions { get; set; }
Property Value
EditorViewModel.LayerInfos Property
An array of editing configurations for individual layers.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo>? LayerInfos { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<EditorLayerInfo>
EditorViewModel.OnSketchCreate Property
Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.EditorViewModelSketchCreateEvent> OnSketchCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<EditorViewModelSketchCreateEvent>
EditorViewModel.OnSketchUpdate Property
Fires when a user starts updating a feature’s geometry, is actively updating a feature’s geometry, and completes updating a feature’s geometry.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.EditorViewModelSketchUpdateEvent> OnSketchUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<EditorViewModelSketchUpdateEvent>
EditorViewModel.SketchViewModel Property
The SketchViewModel
for supporting the editor widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.SketchViewModel? SketchViewModel { get; set; }
Property Value
EditorViewModel.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
EditorViewModel.State Property
The widget’s state.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.EditorViewModelState> State { get; set; }
Property Value
System.Nullable<EditorViewModelState>
EditorViewModel.Syncing Property
Indicates if there is at least one edit request being processed.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Syncing { get; set; }
Property Value
System.Nullable<System.Boolean>
EditorViewModel.TooltipOptions Property
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.SketchTooltipOptions? TooltipOptions { get; set; }
Property Value
EditorViewModel.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
Methods
EditorViewModel.AddToLayerInfos(EditorLayerInfo[]) Method
Asynchronously adds elements to the LayerInfos property.
public System.Threading.Tasks.Task AddToLayerInfos(params dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo[] values);
Parameters
values EditorLayerInfo[]
The elements to add.
Returns
EditorViewModel.CancelWorkflow() Method
Cancels any active workflow.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task CancelWorkflow();
Returns
EditorViewModel.DeleteAssociationFromWorkflow() Method
This is applicable if there is an active update workflow with an active
child workflow.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task DeleteAssociationFromWorkflow();
Returns
EditorViewModel.DeleteFeatureFromWorkflow() Method
This is applicable if there is an active update workflow with an active
child workflow.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task DeleteFeatureFromWorkflow();
Returns
EditorViewModel.GetActiveWorkflow() Method
Asynchronously retrieve the current value of the ActiveWorkflow property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelActiveWorkflow?> GetActiveWorkflow();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelActiveWorkflow>
EditorViewModel.GetAttachmentsViewModel() Method
Asynchronously retrieve the current value of the AttachmentsViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.AttachmentsViewModel?> GetAttachmentsViewModel();
Returns
System.Threading.Tasks.Task<AttachmentsViewModel>
EditorViewModel.GetCanCreate() Method
Asynchronously retrieve the current value of the CanCreate property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetCanCreate();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorViewModel.GetCanUpdate() Method
Asynchronously retrieve the current value of the CanUpdate property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetCanUpdate();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorViewModel.GetEditorItems() Method
Asynchronously retrieve the current value of the EditorItems property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.EditorItem>?> GetEditorItems();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<EditorItem>>
EditorViewModel.GetFailures() Method
Asynchronously retrieve the current value of the Failures property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorViewModelFailures>?> GetFailures();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<EditorViewModelFailures>>
EditorViewModel.GetFeatureFormViewModel() Method
Asynchronously retrieve the current value of the FeatureFormViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel?> GetFeatureFormViewModel();
Returns
System.Threading.Tasks.Task<FeatureFormViewModel>
EditorViewModel.GetFeatureTemplatesViewModel() Method
Asynchronously retrieve the current value of the FeatureTemplatesViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel?> GetFeatureTemplatesViewModel();
Returns
System.Threading.Tasks.Task<FeatureTemplatesViewModel>
EditorViewModel.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>
EditorViewModel.GetLayerInfos() Method
Asynchronously retrieve the current value of the LayerInfos property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo>?> GetLayerInfos();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<EditorLayerInfo>>
EditorViewModel.GetSketchViewModel() Method
Asynchronously retrieve the current value of the SketchViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.SketchViewModel?> GetSketchViewModel();
Returns
System.Threading.Tasks.Task<SketchViewModel>
EditorViewModel.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>
EditorViewModel.GetState() Method
Asynchronously retrieve the current value of the State property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.EditorViewModelState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<EditorViewModelState>>
EditorViewModel.GetSyncing() Method
Asynchronously retrieve the current value of the Syncing property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSyncing();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
EditorViewModel.GetTemplatesForLayer(Layer) Method
Get all of the editing templates associated with a given layer.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelGetTemplatesForLayer[]?> GetTemplatesForLayer(dymaptic.GeoBlazor.Core.Components.Layers.Layer layer);
Parameters
layer dymaptic.GeoBlazor.Core.Components.Layers.Layer
The layer whose templates should be retrieved.
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IEditorViewModelGetTemplatesForLayer[]>
EditorViewModel.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>
EditorViewModel.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>
EditorViewModel.OnJsSketchCreate(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSketchCreate(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
EditorViewModel.OnJsSketchUpdate(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSketchUpdate(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
EditorViewModel.RemoveFromLayerInfos(EditorLayerInfo[]) Method
Asynchronously remove an element from the LayerInfos property.
public System.Threading.Tasks.Task RemoveFromLayerInfos(params dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo[] values);
Parameters
values EditorLayerInfo[]
The elements to remove.
Returns
EditorViewModel.SetAttachmentsViewModel(AttachmentsViewModel) Method
Asynchronously set the value of the AttachmentsViewModel property after render.
public System.Threading.Tasks.Task SetAttachmentsViewModel(dymaptic.GeoBlazor.Pro.Components.AttachmentsViewModel? value);
Parameters
value AttachmentsViewModel
The value to set.
Returns
EditorViewModel.SetFeatureTemplatesViewModel(FeatureTemplatesViewModel) Method
Asynchronously set the value of the FeatureTemplatesViewModel property after render.
public System.Threading.Tasks.Task SetFeatureTemplatesViewModel(dymaptic.GeoBlazor.Pro.Components.FeatureTemplatesViewModel? value);
Parameters
value FeatureTemplatesViewModel
The value to set.
Returns
EditorViewModel.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
EditorViewModel.SetLayerInfos(IReadOnlyList) Method
Asynchronously set the value of the LayerInfos property after render.
public System.Threading.Tasks.Task SetLayerInfos(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.EditorLayerInfo>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<EditorLayerInfo>
The value to set.
Returns
EditorViewModel.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
EditorViewModel.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
EditorViewModel.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
EditorViewModel.StartCreateFeaturesWorkflowAtFeatureCreation(CreateFeaturesCreationInfo) Method
Initiates the CreateFeaturesWorkflow by displaying the panel where feature creation begins.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartCreateFeaturesWorkflowAtFeatureCreation(dymaptic.GeoBlazor.Pro.Model.CreateFeaturesCreationInfo creationInfo);
Parameters
creationInfo CreateFeaturesCreationInfo
An object containing information needed to create a new feature using the Editor widget. This object provides the feature template and layer for creating a new feature.
Returns
EditorViewModel.StartCreateFeaturesWorkflowAtFeatureEdit(Graphic) Method
This method starts the CreateFeaturesWorkflow at the “creating-features” step with the provided feature.
param params.initialFeature The initial feature used when you begin creating features.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartCreateFeaturesWorkflowAtFeatureEdit(dymaptic.GeoBlazor.Core.Components.Graphic initialFeature);
Parameters
initialFeature dymaptic.GeoBlazor.Core.Components.Graphic
The initial feature used when you begin creating features.
ArcGIS Maps SDK for JavaScript
Returns
EditorViewModel.StartCreateFeaturesWorkflowAtFeatureTypeSelection() Method
Initiates the CreateFeaturesWorkflow by displaying the FeatureTemplates panel.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartCreateFeaturesWorkflowAtFeatureTypeSelection();
Returns
EditorViewModel.StartUpdateWorkflowAtFeatureEdit(Graphic) Method
Starts the update workflow at the feature geometry and attribute editing panel.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartUpdateWorkflowAtFeatureEdit(dymaptic.GeoBlazor.Core.Components.Graphic feature);
Parameters
feature dymaptic.GeoBlazor.Core.Components.Graphic
The feature to be updated.
Returns
EditorViewModel.StartUpdateWorkflowAtFeatureSelection() Method
Starts the update workflow using the current selected feature.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartUpdateWorkflowAtFeatureSelection();
Returns
EditorViewModel.StartUpdateWorkflowAtMultipleFeatureSelection(IReadOnlyCollection) Method
Starts the Editor workflow where it waits for multiple features
to be selected.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task StartUpdateWorkflowAtMultipleFeatureSelection(System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Graphic> candidates);
Parameters
candidates System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Graphic>
The selected feature candidates.
Returns
EditorViewModel.ToggleUpdateWorkflow() Method
Toggles the UpdateWorkflow.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task ToggleUpdateWorkflow();
Returns
EditorViewModel.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()