Class ArcAbstract

An elliptical arc is a Shape that represents a general elliptical arc in the 2D space.

The elliptical arc is defined by:

An elliptical arc cannot be instantiated directly. It must be instantiated using createArc.

Hierarchy

Constructors

constructor

Accessors

a b bounds center coordinateType endPoint focusPoint reference rotationAzimuth startAzimuth startPoint sweepAngle type

Methods

contains2D contains2DCoordinates contains2DPoint copy equals move2DToCoordinates move2DToPoint toString translate2D

Constructors

constructor

Accessors

a

  • get a(): number

  • The semi major axis of the ellipse defining the arc, in meters.

    Returns number

  • set a(value): void

  • Parameters

    • value: number

    Returns void

b

  • get b(): number

  • The semi minor axis of the ellipse defining the arc, in meters. This field is mutable.

    Returns number

  • set b(value): void

  • Parameters

    • value: number

    Returns void

bounds

  • 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

center

  • get center(): Point

  • The center point of the ellipse defining the arc.

    Returns Point

Abstract 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

endPoint

  • get endPoint(): Point

  • The end point of the arc. This field is read-only.

    Returns Point

focusPoint

  • get focusPoint(): Point

  • The focus point of the arc. This field is read-only.

    Returns 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

rotationAzimuth

  • get rotationAzimuth(): number

  • The rotation angle of the ellipse defining the arc. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

    The value is normalized to the range -180° .. 180°.

    Returns number

  • set rotationAzimuth(value): void

  • Parameters

    • value: number

    Returns void

startAzimuth

  • get startAzimuth(): number

  • The start angle. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

    Returns number

  • set startAzimuth(value): void

  • Parameters

    • value: number

    Returns void

startPoint

  • get startPoint(): Point

  • The start point of the arc. This field is read-only.

    Returns Point

sweepAngle

  • get sweepAngle(): number

  • The angle over which the arc extends. It is defined in degrees, clockwise. This field is mutable.

    Returns number

  • set sweepAngle(value): void

  • Parameters

    • value: number

    Returns void

type

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

    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.

Abstract 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

Abstract copy

  • Makes a deep clone of this shape.

    Returns Arc

    a copy of this shape

equals

  • Indicates whether this shape is equal to another.

    Parameters

    • aArc: Shape

      the other shape this shape is compared with.

    Returns boolean

    true if both shapes are equal, false otherwise.

move2DToCoordinates

  • Moves the center point of this arc to another location. The passed x and y coordinates are expressed in the reference of this arc. The passed coordinates will become the coordinates of the center point of this arc.

    Parameters

    • x: number

      the x coordinate of the point.

    • y: number

      the y coordinate of the point.

    Returns void

move2DToPoint

  • Moves this center point of this arc to another location. The center point of this arc will be moved to the location of the passed point. The reference of the passed point must match the reference of the shape.

    Parameters

    • point: Point

      the point to move the arc's center point to.

    Returns void

    Throws

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

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

Abstract translate2D

  • 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

Settings

Member Visibility

Theme