Class MPPoint

MPPoint is a representation of latitude and longitude coordinates packaged with a Z-axis representation in floorIndex.

Export

MPPoint

Hierarchy (View Summary)

Constructors

constructor

Properties

floorIndex? latitude longitude multiPolygon point polygon

Accessors

position type

Methods

angleBetween contains distanceTo getArea toJson toJSON create

Constructors

constructor

  • new MPPoint(latitude: number, longitude: number, floorIndex?: number): MPPoint

    Creates an instance of MPPoint.

    Parameters

    • latitude: number

      The position of the point on the latitudal axis (N/S).

    • longitude: number

      The position of the point on the longitudal axis (E/W).

    • OptionalfloorIndex: number = 0

      The floor index of the point, Will default to 0 if not provided.

    Returns MPPoint

Properties

Optional ReadonlyfloorIndex

floorIndex?: number

Optional index that defines what floor this point is placed on.

If 0 it is placed on the ground floor, or outside.

Readonlylatitude

latitude: number

Latitude coordinate.

Readonlylongitude

longitude: number

Longitude coordinate.

Static ReadonlymultiPolygon

multiPolygon: string = "MultiPolygon"

Typename for MPMultiPolygon.

Static

Static Readonlypoint

point: string = "Point"

Typename for MPPoint.

Static

Static Readonlypolygon

polygon: string = "Polygon"

Typename for MPPolygon.

Static

Accessors

position

  • get position(): MPPoint

    MPGeometry override, returns this object.

    Returns MPPoint

type

  • get type(): string

    Get the type of the point. see MPGeometry#point.

    Returns string

Methods

angleBetween

  • angleBetween(other: MPPoint): Promise<number>

    Calculates the angle between this point and another [MPPoint] in degrees from north.

    Parameters

    Returns Promise<number>

    Async

contains

  • contains(point: MPPoint): Promise<boolean>

    Checks whether a point is contained within the geometry.

    Parameters

    Returns Promise<boolean>

    Async

distanceTo

  • distanceTo(other: MPPoint): Promise<number>

    Calculates the shortest distance to another point from this point.

    Parameters

    Returns Promise<number>

    Async

getArea

  • getArea(): Promise<number>

    MPGeometry override, resolves to a non-zero value.

    Returns Promise<number>

    Async

toJson

  • toJson(): string

    Stringifies the geometry to JSON.

    Returns string

toJSON

  • toJSON(): MPPointParams

    Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

    Returns MPPointParams

Staticcreate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods