Handle to insert a point on a line segment of a point list (Polygon).

This handle is intended to be used in the composite PointListInsertHandle.

The default implementation draws an icon based on EditHandleStyles.handleIconStyle, but smaller. The user can drag this handle to insert a new point on the segment. The newly inserted point is immediately moved in the same drag gesture.

Since

2022.1

Hierarchy

Constructors

Accessors

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

    Returns boolean

  • set active(active): void
  • Parameters

    • active: boolean

    Returns void

  • get index(): number
  • The index where the point will be inserted.

    Returns number

  • get inserted(): boolean
  • Indicates whether this handle has already inserted the point in the point list.

    I.e. the user started dragging the handle.

    Returns boolean

  • get pointToInsert(): Point
  • The point to insert in the point list.

    This is also where the handle draws an icon.

    Returns Point

  • 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

  • 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

  • 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

  • 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