DWVv0.37.0

DrawPreview

Source: drawPreview.js:51

Draw preview class.


Constructor

new DrawPreview(app: App): DrawPreview

Parameters

  • app (App) — The application.

Instance Methods

setOptions(options: object)

Parameters

  • options (object) — Shape factory map (name → constructor).

setFeatures(features: object)

Parameters

  • features (object) — Live features (shape, colour, meta, …).

hasShape(name: string): boolean

Parameters

  • name (string) — Shape id.

Returns

  • boolean — True if registered.

tryBeginPlacement(layerGroup: LayerGroup): boolean

Create draw layer if needed and start factory placement (no vertex yet).

Parameters

Returns

  • boolean — True if placement can proceed (layer ready).

getNPoints(): number | undefined

Get the current shape number of points.

Returns

  • number | undefined — The number of points or undefined.

resetPlacement()

Clear temporary preview and tap session (Escape / cancel).

getCannotCreateReason(layerGroup: LayerGroup): string

Get the reason why a shape cannot be created.

Parameters

Returns

  • string — The reason.

onNewPoints(tmpPoints: Array.<Point2D>, layerGroup: LayerGroup)

Handle new points.

Parameters

  • tmpPoints (Array.<Point2D>) — Display points.
  • layerGroup (LayerGroup) — Layer group.

onFinalPoints( finalPoints: Array.<Point2D>, layerGroup: LayerGroup, )

Handle final points.

Parameters

  • finalPoints (Array.<Point2D>) — Display points.
  • layerGroup (LayerGroup) — Layer group.