Class ShapeList

A ShapeList is a Shape that consists of a finite number of other shapes in a given order. A ShapeList must be instantiated by using createShapeList.

Hierarchy

Constructors

constructor

Accessors

bounds coordinateType focusPoint reference shapeCount type

Methods

addShape contains2D contains2DCoordinates contains2DPoint copy equals getShape removeShape toString translate2D

Constructors

Private constructor

Accessors

bounds

  • get bounds(): null | 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 null | Bounds

coordinateType

  • 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

focusPoint

  • get focusPoint(): null | 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 null | Point

reference

  • 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

shapeCount

  • get shapeCount(): number

  • returns the amount of shapes in this ShapeList

    Returns number

type

Methods

addShape

  • Add a shape to the end of the ShapeList or at the given index.

    Parameters

    • shapeOrIndex: number | Shape

      index The index at which the shape must be inserted into the list. It must be between 0 and the length of the shapelist. Or the shape that must be added at the end of the ShapeList.

    • Optional maybeShape: Shape

      The shape that must be inserted at the given index.

    Returns void

    Throws

    InvalidReferenceError If the shape's reference does not correspond with the spatial reference of the ShapeList.

    Throws

    ProgrammingError If the index passed is smaller than zero or larger than the length of the list.

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

    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.

contains2DCoordinates

  • 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

contains2DPoint

  • 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

copy

equals

  • Returns true if every shape in this shape list is equal to the shape at the same index in the other shape list.

    Parameters

    • shapelist: Shape

      a shapelist to compare to this list

    Returns boolean

    true if equal, false otherwise

getShape

  • Get the shape from this ShapeList at the given index. If the index is larger or equal than pointCount, undefined will be returned.

    Parameters

    • index: number

    Returns Shape

    the shape at the index or undefined.

removeShape

  • Remove the shape at the given index from the ShapeList

    Parameters

    • index: number

      The index of the shape that must be removed.

    Returns void

    Throws

    ProgrammingError If the index is not defined ( 0 <= index < pointCount )

toString

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

    Returns string

translate2D

  • Translates all the shapes in this shapelistshape over the given vector in 2D space.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

Settings

Member Visibility

Theme