LuciadRIA (2026.0.05)
    Preparing search index...

    Class ShapeAbstract

    Shape interface. Each shape realizes this interface. Use ShapeFactory methods to create shape instances, like a Point, Polyline, Polygon, and other types.

    Hierarchy (View Summary)

    Implements

    Constructors

    Accessors

    • get bounds(): Bounds | null

      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

    • get focusPoint(): Point | null

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

    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

      • Optionaly: number

      Returns boolean

      true when the given point is contained in this shape

      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

    • 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

      InvalidReferenceError when a point has another spatial reference

    • Makes a deep clone of this shape.

      Returns Shape

      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.

    • 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

    • 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