Class default

Interaction dedicated to measure length.

See our live example: ../examples/measure.html

Hierarchy

  • Measure
    • default

Constructors

constructor

Properties

continueMsg displayHelpTooltip_ format helpTooltipElement_ helpTooltipOverlay_ sketchFeature source spherical startMsg tolerance

Methods

computeLineSegmentIntersection createDrawInteraction getDrawInteraction getTooltipElement handleMeasure linestringGeometryFunction setMap

Constructors

constructor

Properties

continueMsg

continueMsg: Element | HTMLSpanElement

displayHelpTooltip_

displayHelpTooltip_: boolean

Whether or not to display any tooltip

format

format: unitPrefix

The format function

helpTooltipElement_

helpTooltipElement_: HTMLElement

The help tooltip element.

helpTooltipOverlay_

helpTooltipOverlay_: Overlay

Overlay to show the help messages.

sketchFeature

sketchFeature: Feature<Geometry>

The sketch feature.

source

source: VectorSource<any>

The snapping source

spherical

spherical: boolean

startMsg

startMsg: Element

The message to show when user is about to start drawing.

tolerance

tolerance: number

The snapping tolerance in pixels.

Methods

computeLineSegmentIntersection

  • Compute the intersection between 2 segments.

    Returns

    The intersection point, undefined if there is no intersection point or lines are coincident.

    Parameters

    • line1: number[][]

      The coordinates of the first line.

    • line2: number[][]

      The coordinates of the second line.

    Returns number[]

createDrawInteraction

  • Returns

    The interaction

    Parameters

    • style: StyleLike

      The sketchStyle used for the drawing interaction.

    • source: VectorSource<LineString>

      Vector source.

    Returns Draw | default

getDrawInteraction

  • Returns

    The draw interaction.

    Returns DrawAzimut | Draw | default

getTooltipElement

  • Get a reference to the tooltip element.

    Returns

    Tooltip Element.

    Returns Element

handleMeasure

  • Function implemented in inherited classes to compute measurement, determine where to place the tooltip and determine which help message to display.

    Parameters

    • callback: ((arg0: string, arg1: Coordinate) => void)

      The function to be called.

        • (arg0: string, arg1: Coordinate): void

        • Parameters

          • arg0: string
          • arg1: Coordinate

          Returns void

    Returns void

linestringGeometryFunction

  • Create a linestringGeometryFunction that will create a line string with segments snapped to π/4 angle. Use this with the draw interaction and type: 'LineString'.

    Returns

    Geometry.

    Parameters

    • coordinates: number[][]

      Coordinates.

    • Optional opt_geometry: SimpleGeometry

      Geometry.

    Returns SimpleGeometry

setMap

Settings

Member Visibility

Theme

Generated using TypeDoc