Represents a point in 3 (x,y,z) dimensions. A ShapeFactory module. A point is always defined in the context of a spatial reference. For a geodetic spatial reference, the x and y properties correspond with longitude and latitude on the ellipsoid. For projected spatial references, the x and y properties correspond with the x and y axis in Cartesian space. The z property always corresponds with height.

Hierarchy

Constructors

Accessors

  • get bounds(): Bounds
  • The bounds of this shape. This property is to be treated in a read only manner. An error will be thrown when trying to assign to this property. Note that the bounds property is not immutable. Modifying properties of the bounds property may corrupt your data.

    Returns Bounds

  • get coordinateType(): CoordinateType
  • The coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.

    Returns CoordinateType

  • get focusPoint(): Point
  • The focus point of this shape. This property is read only. An error will be thrown when trying to assign to this property. This property contains an object but should be treated with value semantics: changes to the shape will not be reflected in the focusPoint that was retrieved from this Polygon before the modification.

    Returns Point

  • get reference(): null | CoordinateReference
  • The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

    Returns null | CoordinateReference

  • get x(): number
  • The x coordinate of the Point. For a point that is defined in a geodetic spatial reference this property returns the longitude. Assigning to the x property of a point with a geodetic spatial reference will normalize the coordinate to the interval [-180, 180]. E.g. if you assign a value or 380 to the x property, it will be normalized to 20;

    Returns number

  • set x(value): void
  • Parameters

    • value: number

    Returns void

  • get y(): number
  • The y coordinate of the Point. For a point that is defined in a geodetic spatial reference this property returns the latitude. Assigning to the y property of a point with a geodetic spatial reference will normalize the coordinate to the interval [-90, 90]. E.g. if you assign a value of 100 to the y property, it will be normalized to 90;

    Returns number

  • set y(value): void
  • Parameters

    • value: number

    Returns void

  • get z(): number
  • The z coordinate of the Point. The z coordinate typically corresponds with height.

    Returns number

  • set z(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Determines whether a given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

    Parameters

    • x: number | Point | Bounds

      The point for which containment must be checked. If a 3D point is passed to this function, it will be treated as a 2D point: the z coordinate (height) will be ignored. The reference of this point must be the same reference as this Shape

    • Optional y: number

    Returns boolean

    true when the given point is contained in this shape

    Throws

    Point with another spatial reference

    Deprecated

    Please use contains2DPoint instead.

  • Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

    Parameters

    • x: number

      The x coordinate of the point for which containment must be checked

    • y: number

      The y coordinate of the point for which containment must be checked

    Returns boolean

    true when the given point is contained in this shape

    Throws

    Point with another spatial reference

  • Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

    Parameters

    • point: Point

      The point for which containment must be checked.

    Returns boolean

    true when the given point is contained in this shape

    Throws

    Point with another spatial reference

  • Makes a deep clone of this shape.

    Returns Point

    a copy of this shape

  • Indicates whether this shape is equal to another.

    Parameters

    • otherShape: Shape

      the other shape this shape is compared with.

    Returns boolean

    true if both shapes are equal, false otherwise.

  • Moves this Point to another location. The passed x and y will become the x and y coordinates of this point. The z coordinate of this Point remains unmodified.

    Parameters

    • xOrPoint: number | Point

      x coordinate value or a Point instance

    • Optional y: number

      y coordinate value

    Returns void

  • Moves this Point to another location. The passed x and y will become the x and y coordinates of this point. The z coordinate of this Point remains unmodified.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

  • Moves this Point to another location. This Point will be moved to the same location of the Point that was passed. The z coordinate of the point that was passed will be ignored.

    Parameters

    Returns void

    Throws

    InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this Point.

  • Moves this Point to another location. The passed x,y and z coordinates will become the x, y and z coordinates of this point.

    Parameters

    • xOrPoint: number | Point

      x coordinate value or a Point instance.

    • Optional y: number

      y coordinate value

    • Optional z: number

      z coordinate value

    Returns void

  • Moves this Point to the given x, y and z coordinates.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    • z: number

      z coordinate value

    Returns void

  • Moves this point to the same location of the given Point.

    Parameters

    Returns void

    Throws

    InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this Point.

  • Converts the shape to a string. This functionality is for debugging purposes only. Results of toString cannot be used to uniquely identify a shape instance.

    Parameters

    • Optional excludeType: boolean

    Returns string

  • Translates this Point from its current position over the given translation vector to another location. This method can be called with an x, y and optionally a z value. If the z coordinate is not specified, the translation will only affect the x and y coordinate.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    • Optional z: number

      z coordinate value, may be omitted.

    Returns void

  • Translates the shape over the given vector in 2D space.

    Parameters

    • x: number

      The x coordinate of the translation vector

    • y: number

      The y coordinate of the translation vector

    Returns void

  • Translates this Point from its current position over the given translation vector to another location.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    • z: number

      z coordinate value

    Returns void