Options
All
  • Public
  • Public/Protected
  • All
Menu

A GeoBuffer represents all points whose distance to the base shape is less than or equal to a certain distance.

A buffer is an area around a given shape, adding a fixed width to the shape.

The contour of the buffer is a polygon in which each exterior point lies at a fixed distance from the line segments of the base shape.

The supported base shapes are polylines and polygons.

For open base shapes (polylines), it is possible specify a CAP_BUTT end style (see EndCapStyle enumeration) that cuts off the buffer at the start and end of the base shape.

Hierarchy

Implements

Overview

Accessors

baseShape

  • get baseShape(): Shape
  • set baseShape(baseShape: Shape): void
  • The base shape of this buffer.

    Returns Shape

  • The base shape of this buffer.

    Parameters

    Returns any

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 | null

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

endCapStyle

  • The end cap style of this buffer, which defines the representation of the contour at the endings of thebase shape. This is a member of the EndCapStyle enumeration. By default CAP_ROUND is used.

    Returns EndCapStyle

  • The end cap style of this buffer, which defines the representation of the contour at the endings of thebase shape. This is a member of the EndCapStyle enumeration. By default CAP_ROUND is used.

    Parameters

    Returns any

focusPoint

  • get focusPoint(): Point | null

reference

  • The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

    Returns CoordinateReference | null

type

width

  • get width(): number
  • set width(width: number): void
  • The width of this buffer, expressed in meters and measured from the line segments of the base shape to the contour. The width must be positive.

    Returns number

  • The width of this buffer, expressed in meters and measured from the line segments of the base shape to the contour. The width must be positive.

    Parameters

    • width: number

    Returns any

Methods

contains2D

  • 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).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    deprecated

    Please use contains2DPoint instead.

    Parameters

    • x: Point | number | 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

Abstract contains2DCoordinates

  • (x: number, y: number): boolean
  • 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).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    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

contains2DPoint

  • (point: Point): boolean
  • 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).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    Parameters

    • point: Point

      The point for which containment must be checked.

    Returns boolean

    true when the given point is contained in this shape

Abstract copy

equals

  • (aGeoBuffer: Shape): boolean

toString

  • (): string

translate2D

  • (x: number, y: number): void

Static isSupportedBaseShape

  • (shape: Shape): boolean
  • Tests whether the given shape can be used as a base shape for a GeoBuffer.

    Currently GeoBuffer supports Polyline and Polygon as base shape.

    Parameters

    • shape: Shape

      The shape to be tested.

    Returns boolean

    Whether the shape is a possible base shape.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method