map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface Measurement2DModel

    A model, providing access to the current measurement state. It is available as service measurement-2d.Model.

    See Measurement2DModelProperties for documentation of class members.

    interface Measurement2DModel {
        area: string;
        distance: string;
        geometry: Polyline | Polygon;
        mode: Measurement2DMode;
        perimeter: string;
        rawArea: number;
        rawDistance: number;
        rawPerimeter: number;
        state: Measurement2DState;
        unit:
            | "imperial"
            | "metric"
            | "square-millimeters"
            | "square-centimeters"
            | "square-decimeters"
            | "square-meters"
            | "square-kilometers"
            | "square-inches"
            | "square-feet"
            | "square-yards"
            | "square-miles"
            | "square-nautical-miles"
            | "square-us-feet"
            | "acres"
            | "ares"
            | "hectares"
            | "millimeters"
            | "centimeters"
            | "decimeters"
            | "meters"
            | "kilometers"
            | "inches"
            | "feet"
            | "yards"
            | "miles"
            | "nautical-miles"
            | "us-feet";
    }

    Hierarchy (View Summary)

    Index

    Properties

    area distance geometry mode perimeter rawArea rawDistance rawPerimeter state unit

    Properties

    area: string

    Locale specific representation of the area including the unit. Available if the mode is set to area.

    distance: string

    Locale specific representation of the length including the unit. Available if the mode is set to distance.

    geometry: Polyline | Polygon

    The measurement geometry. Available if the mode is set to area or distance. If mode is area, the geometry is a polygon. If mode is distance, the geometry is a polyline.

    mode: Measurement2DMode

    Measurement mode.

    perimeter: string

    Locale specific representation of the perimeter including the unit. Available if the mode is set to area.

    rawArea: number

    Area always in square meter. Available if the mode is set to area.

    rawDistance: number

    Distance always in meters. Available if the mode is set to distance.

    rawPerimeter: number

    Perimeter always in meters. Available if the mode is set to area.

    state: Measurement2DState

    Measurement state.

    unit:
        | "imperial"
        | "metric"
        | "square-millimeters"
        | "square-centimeters"
        | "square-decimeters"
        | "square-meters"
        | "square-kilometers"
        | "square-inches"
        | "square-feet"
        | "square-yards"
        | "square-miles"
        | "square-nautical-miles"
        | "square-us-feet"
        | "acres"
        | "ares"
        | "hectares"
        | "millimeters"
        | "centimeters"
        | "decimeters"
        | "meters"
        | "kilometers"
        | "inches"
        | "feet"
        | "yards"
        | "miles"
        | "nautical-miles"
        | "us-feet"

    Measurement unit is either unit system (metric, imperial) or a specific unit. Available if the mode is set to area or distance.

    Settings

    Member Visibility

    On This Page

    Properties