Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Point

The Point class is a type of GeometryObject representing a single point on a map.

example


var pointGeometryObject = { type: 'Point', coordinates: [-82.44140625,29.200123477644982] };
var point=new Point(pointGeometryObject);

Hierarchy

  • Point

Implements

Index

Constructors

constructor

  • Parameters

    Returns Point

  • Parameters

    • Optional geoJSON: GeometryObject

      is an optional GeometryObject to use for the coordinates property of this Point.

    Returns Point

  • Parameters

    • Optional geoJSON: GeometryObject

      is an optional GeometryObject to use for the coordinates property of this Point.

    Returns Point

Properties

bbox

  • get bbox(): number[]
  • Retrieves an array of numbers that represent the bounding box of the Point.

    Returns number[]

coordinates

coordinates: Position = [0, 0]

The coordinates property is a single Position.

default

[0,0]

Private terraPrimitive

Private turfFeature

  • Construct a Turf Feature from this Point.

    Returns Feature

    the [[turf.Feature]] of this Point.

type

  • get type(): string
  • The type property of a geometry as a string ('Point').

    Returns string

Methods

buffer

  • buffer(geometryMeasure: GeometryMeasure): GeometryObject
  • buffer(geometryMeasure: GeometryMeasure): GeometryObject
  • buffer(geometryMeasure: GeometryMeasure): GeometryObject
  • Buffers the geometry of this Point by the GeometryMeasure given as an input parameter.

    Parameters

    Returns GeometryObject

    a new GeometryObject

  • Buffers the geometry of this Point by the GeometryMeasure given as an input parameter.

    Parameters

    • geometryMeasure: GeometryMeasure

    Returns GeometryObject

    a new GeometryObject

  • Buffers the geometry of this Point by the GeometryMeasure given as an input parameter.

    Parameters

    • geometryMeasure: GeometryMeasure

    Returns GeometryObject

    a new GeometryObject

contains

  • contains(geometryObject: GeometryObject): boolean
  • contains(geometryObject: GeometryObject): boolean
  • contains(geometryObject: GeometryObject): boolean
  • See if this Point contains the GeometryObject given as the input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point contains the GeometryObject given as the input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point contains the GeometryObject given as the input parameter.

    Parameters

    Returns boolean

    a boolean

disjoint

  • disjoint(geometryObject: GeometryObject): boolean
  • disjoint(geometryObject: GeometryObject): boolean
  • disjoint(geometryObject: GeometryObject): boolean
  • See if this Point does not intersect the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point does not intersect the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point does not intersect the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

equals

  • equals(geometryObject: GeometryObject): boolean
  • equals(geometryObject: GeometryObject): boolean
  • equals(geometryObject: GeometryObject): boolean
  • See if a GeometryObject given as an input parameter is equal to this Point.

    Parameters

    Returns boolean

    a boolean

  • See if a GeometryObject given as an input parameter is equal to this Point.

    Parameters

    Returns boolean

    a boolean

  • See if a GeometryObject given as an input parameter is equal to this Point.

    Parameters

    Returns boolean

    a boolean

intersects

  • intersects(geometryObject: GeometryObject): boolean
  • intersects(geometryObject: GeometryObject): boolean
  • intersects(geometryObject: GeometryObject): boolean
  • See if this Point intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

midpoint

  • midpoint(pt: Point): Point
  • midpoint(pt: Point): Point
  • midpoint(pt: Point): Point
  • find the midpoint between this Point and the GeometryObject given as an input parameter.

    Parameters

    Returns Point

    the Point that is midway between the two

  • find the midpoint between this Point and the GeometryObject given as an input parameter.

    Parameters

    • pt: Point

    Returns Point

    the Point that is midway between the two

  • find the midpoint between this Point and the GeometryObject given as an input parameter.

    Parameters

    • pt: Point

    Returns Point

    the Point that is midway between the two

setx

  • setx(value: number): void
  • setx(value: number): void
  • setx(value: number): void
  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

sety

  • sety(value: number): void
  • sety(value: number): void
  • sety(value: number): void
  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Parameters

    • value: number

    Returns void

toWkt

  • toWkt(): string
  • toWkt(): string
  • toWkt(): string
  • Convert this Point to well-known text representation.

    Returns string

    the well-known text representation this Point.

  • Convert this Point to well-known text representation.

    Returns string

    the well-known text representation this Point.

  • Convert this Point to well-known text representation.

    Returns string

    the well-known text representation this Point.

touches

  • touches(geometryObject: GeometryObject): boolean
  • touches(geometryObject: GeometryObject): boolean
  • touches(geometryObject: GeometryObject): boolean
  • See if a GeometryObject given as an input parameter touches this Point.

    Parameters

    Returns boolean

    a boolean

  • See if a GeometryObject given as an input parameter touches this Point.

    Parameters

    Returns boolean

    a boolean

  • See if a GeometryObject given as an input parameter touches this Point.

    Parameters

    Returns boolean

    a boolean

within

  • within(geometryObject: GeometryObject): boolean
  • within(geometryObject: GeometryObject): boolean
  • within(geometryObject: GeometryObject): boolean
  • See if this Point is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this Point is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

x

  • x(): number
  • x(): number
  • x(): number
  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Returns number

  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Returns number

  • The x property is the 'X' or 'longitudinal' coordinate. It is the x in the x,y coordinate defining this Point.

    Returns number

y

  • y(): number
  • y(): number
  • y(): number
  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Returns number

  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Returns number

  • The y property is the 'Y' or 'latitudinal' coordinate. It is the y in the x,y coordinate defining this Point.

    Returns number

Static createFromWkt

  • createFromWkt(wkt: string): Point
  • createFromWkt(wkt: string): Point
  • createFromWkt(wkt: string): Point
  • Static method for creating a Point from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a Point.

    Returns Point

    a Point parsed from the well-known text.

  • Static method for creating a Point from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a Point.

    Returns Point

    a Point parsed from the well-known text.

  • Static method for creating a Point from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a Point.

    Returns Point

    a Point parsed from the well-known text.