This controller enables creating a new shape on the map. To specify the layer in which the object should be created, override the onChooseLayer method callback.

If you want to change the way creation behaves, check out the Customizing creation and editing guide.

Hierarchy (view full)

Constructors

Accessors

  • get cursor(): null | string
  • The CSS cursor to use on the map, for this controller. If null, the map will fall back to the previous cursor that was set on the map.

    Note that changing this cursor will update the cursor on the map's DOM node. When using multiple controllers (e.g. in a CompositeController), the controller that updates the cursor last (to a non-null value), will override any other non-null cursors of active controllers on the map.

    Returns null | string

    See

    Map.cursorManager

    Since

    2022.1

  • set cursor(cssCursor): void
  • Parameters

    • cssCursor: null | string

    Returns void

  • get map(): null | Map
  • The map on which this controller is currently active or null if this controller is not currently active. This property is read-only.

    Returns null | Map

  • set map(_value): void
  • Parameters

    • _value: null | Map

    Returns void

Methods

  • Finishes the creation process.

    This calls the onObjectCreated hook. The creation controller stays active. To deactivate, call:

    map.controller = null.
    

    Returns void

    Since

    2024.0

  • Return the maximum number of points that should be created.

    Returns number

    The maximum number of points to create.

  • Return the minimum number of points that should be created.

    Returns number

    The minimum number of points to create.

  • Call this method to indicate that the controller's appearance has changed. Calling this method ensures the onDraw will be called during the next rendering pass.

    Returns void

  • Callback that is invoked when this controller is activated on a map. This method allows controller implementations to perform setup work.

    Parameters

    • map: Map

      the map on which the controller has been activated

    Returns void

  • This method is called when this controller needs to determine in which layer an object should be created. This method can be overridden to choose a specific layer. If this method returns null then the object creation will not be started. This controller will remain the active controller though.

    The default implementation of this method iterates over the layers of the map view from top to bottom and returns the first layer that is an instance of FeatureLayer and that is editable and visible.

    Parameters

    • map: Map

      the map

    Returns null | FeatureLayer

    the layer to create objects for or null

  • Callback that is invoked when this controller is deactivated on a map. This method allows controller implementations to perform cleanup work. This method must return either any resolved value or a promise to indicate completion of deactivation. This allows controller implementation to perform asynchronous deactivation work. During the period between this method being called and the resolution of the deactivation promise, this controller will no longer receive input events, but will still get the opportunity to draw itself.

    Parameters

    • aMapView: Map

      the map on which the controller has been deactivated

    Returns void | Promise<void>

    a concrete value to indicate immediate deactivation or a deactivation promise.

  • Callback that allows controller implementations to perform custom drawing on the map. Controller shapes and icons are drawn on top of all other content in the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.

    Parameters

    • aGeoCanvas: GeoCanvas

      the GeoCanvas on which the controller can draw shapes.

    Returns void

  • Callback that allows controller implementations to draw labels on the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.

    Parameters

    • aLabelCanvas: LabelCanvas

      the LabelCanvas on which the controller can draw labels.

    Returns void

  • Called when a gesture event has been received. This method must return a HandleEventResult value to indicate if the event was handled or not, If this method returns EVENT_IGNORED, the map will be given the opportunity to perform default gesture event behaviour. If default event handling is not desired, this method should return EVENT_HANDLED. (See the Controller class description for the default behavior.)

    Parameters

    Returns HandleEventResult

    the gesture event handling result.

  • Called when a key event has been received. This method must return a HandleEventResult value to indicate if the event was handled or not, If this method returns EVENT_IGNORED, the map will be given the opportunity to perform default key event behaviour. If default event handling is not desired, this method should return EVENT_HANDLED. (See the Controller class description for the default behavior.)

    Parameters

    • keyEvent: KeyEvent

      The key event to be handled. Note that this is a KeyEvent and not a DOMEvent. You can access the corresponding DOMEvent through KeyEvent.domEvent.

    Returns HandleEventResult

    The key event handling result.

  • Called when a complete object has been created.

    The default implementation of this method adds the created object to the model of the given layer. When the return is true, the controller will deactivate immediately. When the return is a Promise, the controller will deactivate when the promise is resolved or when the promise is rejected.

    Parameters

    Returns void | Promise<void>

    When a Promise is returned, the controller will deactivate when the promise is resolved or when the promise is rejected. When no Promise is returned, the controller will deactivate immediately.

  • Restarts the creation process.

    The feature that is currently being created is not added to the layer's model.

    Returns void

    Since

    2024.0

  • Set the minimum and maximum number of points that should be created using this controller. Once the maximum number of points is reached, the controller will automatically disable itself. Note that this method should be called before the creation controller is activated on the map, subsequent calls to this method will be ignored.

    Parameters

    • aMinimumPointCount: number

      The minimum number of points that should be created. Has to be positive.

    • aMaximumPointCount: number

      The maximum number of points that should be created. Set to -1 if not specified.

    Returns void

Events

"Restarted" event

"EditShape" event

  • on("EditShape", callback: ((event) => void)) : Handle
  • An event that fires whenever the user edited the shape. EditShape

    Parameters

    • event: "EditShape"
    • callback: ((event) => void)

    Returns Handle

    Since

    2022.1

"Invalidated" event

  • on("Invalidated", callback: (() => void)) : Handle
  • Parameters

    • event: "Invalidated"
    • callback: (() => void)
        • (): void
        • Returns void

    Returns Handle

    See

    Controller.on Invalidated

"Activated" event

  • on("Activated", callback: ((map) => void)) : Handle
  • Parameters

    • event: "Activated"
    • callback: ((map) => void)
        • (map): void
        • Parameters

          Returns void

    Returns Handle

    See

    Controller.on Activated

"Deactivated" event

  • on("Deactivated", callback: ((map) => void)) : Handle
  • Parameters

    • event: "Deactivated"
    • callback: ((map) => void)
        • (map): void
        • Parameters

          Returns void

    Returns Handle

    See

    Controller.on Deactivated