Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EditorViewModel

Hierarchy

Index

Properties

Readonly activeWorkflow

activeWorkflow: CreateWorkflow | UpdateWorkflow

A property indicating the current active workflow.

Read more...

allowedWorkflows

allowedWorkflows: string[]

An array of string values which specifies what end users are allowed to edit.

Read more...

Readonly canCreate

canCreate: boolean

Convenience property that reads whether there are any editable layers that support the create workflow.

Read more...

Readonly canUpdate

canUpdate: boolean

Convenience property that reads whether there are any editable layers that support the update workflow.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly editableItems

editableItems: Collection<EditableItem>

A collection of editable item objects that match the feature being updated.

Read more...

Readonly failures

An array of objects containing information specific to any failed editing operations.

Read more...

featureFormViewModel

featureFormViewModel: FeatureFormViewModel

The FeatureFormViewModel for supporting the editor widget.

Read more...

featureTemplatesViewModel

featureTemplatesViewModel: FeatureTemplatesViewModel

The FeatureTemplatesViewModel for supporting the editor widget.

Read more...

initialized

initialized: boolean

layerInfos

layerInfos: LayerInfo[]

An array of editing configurations for individual layers.

Read more...

sketchViewModel

sketchViewModel: SketchViewModel

The SketchViewModel for supporting the editor widget.

Read more...

snappingOptions

snappingOptions: SnappingOptions

The SnappingOptions for editing.

Read more...

Readonly state

state: "adding-attachment" | "awaiting-feature-creation-info" | "awaiting-feature-to-create" | "awaiting-feature-to-update" | "awaiting-update-feature-candidate" | "disabled" | "editing-attachment" | "editing-existing-feature" | "editing-new-feature" | "ready"

The widget's state.

Read more...

Readonly syncing

syncing: boolean

When true, there is at least one edit request being processed.

Read more...

view

A reference to the MapView or SceneView.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EditorViewModel

cancelWorkflow

  • cancelWorkflow(): Promise<void>
  • Cancels any active workflow.

    Read more...

    Returns Promise<void>

deleteFeatureFromWorkflow

  • deleteFeatureFromWorkflow(): Promise<void>
  • This is applicable if there is an active update workflow.

    Read more...

    Returns Promise<void>

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EditorViewModel

  • Parameters

    Returns EditorViewModel

startCreateWorkflowAtFeatureCreation

  • startCreateWorkflowAtFeatureCreation(creationInfo: CreationInfo): Promise<void>
  • Initiates the create workflow by displaying the panel where feature creation begins.

    Read more...

    Parameters

    Returns Promise<void>

startCreateWorkflowAtFeatureEdit

  • startCreateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>
  • This method starts the Editor workflow where it waits for the feature to be selected.

    Read more...

    Parameters

    Returns Promise<void>

startCreateWorkflowAtFeatureTypeSelection

  • startCreateWorkflowAtFeatureTypeSelection(): Promise<void>
  • Initiates the create workflow by displaying the FeatureTemplates panel.

    Read more...

    Returns Promise<void>

startUpdateWorkflowAtFeatureEdit

  • startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>
  • Starts the update workflow at the feature geometry and attribute editing panel.

    Read more...

    Parameters

    Returns Promise<void>

startUpdateWorkflowAtFeatureSelection

  • startUpdateWorkflowAtFeatureSelection(): Promise<void>
  • Starts the update workflow using the current selected feature.

    Read more...

    Returns Promise<void>

startUpdateWorkflowAtMultipleFeatureSelection

  • startUpdateWorkflowAtMultipleFeatureSelection(): Promise<void>
  • Starts the Editor workflow where it waits for multiple features to be selected.

    Read more...

    Returns Promise<void>

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc