Class DrawTool

Enables the user to draw on the map.

// example of Giro3D instantiation
const instance = new Instance(viewerDiv, options)
const map = new Map('myMap', { extent });
instance.add(map);

// Add our tool
const drawTool = new DrawTool(instance);

// Start and wait for result
drawTool.startAsAPromise()
   .then((polygon) => {
       // Use generated polygon as GeoJSON
   })
// Or use events
drawTool.addEventListener('end', (polygon) => {
    // Use generated polygon as GeoJSON
})
drawTool.start();

Hierarchy

Constructors

constructor

Accessors

drawObject mode state

Methods

addPointAt continue deletePoint dispose edit editAsAPromise end insertPointAt pause reset setOptions start startAsAPromise toCoordinates toGeoJSON update updatePointAt

Constructors

constructor

Accessors

drawObject

mode

state

Methods

addPointAt

continue

deletePoint

dispose

edit

editAsAPromise

  • editAsAPromise(geometry): Promise<Geometry>

  • Edits a GeoJSON geometry and returns a promise.

    Fires DrawToolEventMap.start event at start.

    Parameters

    • geometry: Geometry | Drawing

      GeoJSON geometry or Drawing instance to edit. If passing a Drawing, this tool takes full ownership over it, and will destroy it when done.

    Returns Promise<Geometry>

    Promise resolving to the GeoJSON geometry drawn

end

insertPointAt

pause

  • pause(): void

  • Pauses current drawing so click events are not captured. This is useful when the user is currently interacting with the camera.

    Returns void

reset

setOptions

start

startAsAPromise

toCoordinates

  • toCoordinates(): [number, number, number][]

  • Gets the current coordinates of the shape being drawn. In case of polygons, ensures the shape is closed.

    Returns null if the state is DrawToolState.READY or if the shape is empty.

    Returns [number, number, number][]

    Array of 3D coordinates

toGeoJSON

  • toGeoJSON(): Geometry

  • Gets the current GeoJSON geometry corresponding to the shape being drawn. In case of polygons, ensures the shape is closed.

    Returns null if the state is DrawToolState.READY or if the shape is empty.

    Returns Geometry

    GeoJSON geometry object

update

updatePointAt

Settings

Member Visibility

On This Page

constructordrawObjectmodestateaddPointAtcontinuedeletePointdisposeediteditAsAPromiseendinsertPointAtpauseresetsetOptionsstartstartAsAPromisetoCoordinatestoGeoJSONupdateupdatePointAt