A handle that is used to create a single Point.

After clicking or tapping once, the Point is moved to the clicked location.

See

PointEditor

Since

2022.1

Hierarchy (view full)

Constructors

Accessors

  • get active(): boolean
  • Indicates whether the handle is active.

    Returns boolean

  • set active(active): void
  • Parameters

    • active: boolean

    Returns void

  • get snapPoint(): null | Point
  • The point to snap to.

    This is used to paint a snap icon.

    Typically, this is set by subclasses, for example in PointDragHandle.drag.

    Returns null | Point

  • set snapPoint(p): void
  • Parameters

    Returns void

Methods

  • Called whenever the point is dragged to a new location.

    By default, this delegates to the drag function that was passed into the constructor.

    Parameters

    • point: Point

      The new location of the point, in model coordinates.

    • event: GestureEvent

      The gesture event that caused the drag.

    • context: EditContext

      The edit context

    Returns void

  • Returns the cursor for this point handle.

    • if the handle is active, this returns "grab".
    • if the handle is inactive, but the mouse interacts with the point, this returns "pointer".
    • otherwise, null is returned.

    Parameters

    Returns null | string

  • Returns the model point that this handle corresponds to.

    By default, this delegates to the getPoint function that was passed into the constructor.

    Returns Point

  • Checks whether the given input event interacts with the point handle.

    By default, this returns true if the mouse or finger is within a certain distance of the point. A larger distance is used for touch events than for mouse events.

    Parameters

    Returns boolean

  • Invalidates this edit handle.

    This will cause onDraw and onDrawLabel to be called again.

    Use this if you need to update the visualization of the handle. For example, the handle has changed style and onDraw needs to be re-evaluated.

    Returns void

    Since

    2024.0.02

  • Populates a context menu with entries.

    For example, a handle for a point in a polyline might add a "Delete point" context menu entry.

    Parameters

    • event: GestureEvent

      the input event that triggered opening the context menu.

    • context: EditContext

      the edit context

    • contextMenu: ContextMenu

      the context menu to add entries to.

    • onDone: (() => void)

      a callback that needs to be called when a menu action is performed. Call this at the end of the ContextMenuItem.action implementation.

        • (): void
        • Returns void

    Returns void

  • This method allows the handle to draw labels on the map.

    For example, you can use this to show coordinates of points, or the current radius of a circle on top of an edit handle.

    The default implementation draws nothing.

    Parameters

    Returns void

  • Indicates whether the feature being created or edited, should be painted by the controller. The feature is painted using the layer's painter.

    For handles used in editing, this is typically always true. For handles used in creation, this typically returns false in the early steps of the creation process. For example, when the user is still choosing a location for a point (before the first click).

    Parameters

    Returns boolean

    Since

    2024.0

  • Called when (another) handle changes the feature or shape, as indicated by the "EditShape" event.

    This handle can update its own state, based on the changed shape.

    For example, a PointListInsertHandle just inserted a point in a polyline. The PointListTranslateHandle uses the update to recalculate new sub-handles, based on the new polyline (with the extra point).

    The default implementation does nothing.

    Returns void

  • Transform a view point to model coordinates.

    The default implementation transforms the view point to a model coordinate on terrain. It also moves the point's Z to 0.

    Parameters

    • viewPoint: Point

      The view point to transform to model coordinates

    • context: EditContext

      The edit context

    Returns null | Point

    Since

    2023.1

Events

"EditShape" event

  • on("EditShape", callback: ((event) => void)) : Handle
  • An event that is emitted whenever this handle changes the shape of a feature.

    EditShape

    Parameters

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

    Returns Handle

"Invalidated" event

  • on("Invalidated", callback: (() => void)) : Handle
  • An event that is emitted whenever this handle is invalidated.

    Invalidated

    Parameters

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

    Returns Handle