Constructor options for a PointListCreateHandle

2022.1

interface PointListCreateHandleConstructorOptions {
    freehand?: boolean;
    maximumPointCount?: number;
    minimumPointCount?: number;
    moveConstraint?: ON_TERRAIN | ON_CLOSEST_SURFACE;
}

Properties

freehand?: boolean

Indicates whether to allow drawing shapes in "freehand" mode. When this is enabled, the user can click / tap near the last created point and drag to draw a shape. Multiple points will be inserted while the mouse is being dragged.

When this is disabled, the user can only create (single) points by clicking / tapping the map.

true
maximumPointCount?: number

The maximum number of points that should be allowed during editing. If no maximum is defined, this is -1.

minimumPointCount?: number

The minimum number of points that should be allowed during editing. If no minimum is defined, this defaults to 0.

moveConstraint?: ON_TERRAIN | ON_CLOSEST_SURFACE

The EditMoveConstraint to use when placing points. Use this to control whether points are created on terrain or on the closest surface.

EditMoveConstraint.ON_CLOSEST_SURFACE

2026.0