Options
All
  • Public
  • Public/Protected
  • All
Menu

A Circular arc is a high level interface for a Shape that represents a general circular arc in the 2D space. Each circular arc realizes this interface.

A circular arc cannot be instantiated directly. For more information please refer to CircularArcByCenterPoint, CircularArcBy3Points, and CircularArcByBulge.

Hierarchy

Implements

Overview

Accessors

bounds

center

  • The center point of the circle defining the circular arc. This field is read-only.

    Please use move2DToCoordinates or move2DToPoint to move the center point to a new position.

    Returns Point

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

  • The end point of the circular arc. This is the point that is defined by the radius of the arc and the arc's angle.

    Returns Point

focusPoint

  • get focusPoint(): Point

radius

  • get radius(): number
  • set radius(value: number): void
  • The radius of the circle defining the circular arc.

    Returns number

  • The radius of the circle defining the circular arc.

    Parameters

    • value: number

    Returns any

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

startAzimuth

  • get startAzimuth(): number
  • set startAzimuth(value: number): void
  • The start angle. It is defined as an azimuth: in degrees, positive clockwise, starting up/north.

    Returns number

  • The start angle. It is defined as an azimuth: in degrees, positive clockwise, starting up/north.

    Parameters

    • value: number

    Returns any

startPoint

  • get startPoint(): Point
  • The start point of the circular arc. This is the point that is defined by the radius of the arc and the start angle of the arc.

    Returns Point

sweepAngle

  • get sweepAngle(): number
  • set sweepAngle(v: number): void
  • The angle over which the arc extends. It is defined in degrees, positive clockwise.

    Returns number

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

    Parameters

    • v: number

    Returns any

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

    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

Abstract equals

  • (otherShape: Shape): boolean
  • 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.

move2DToCoordinates

  • (x: number, y: number): void
  • Translates this shape so that its center point ends up at the specified position.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

move2DToPoint

  • Translates this shape so that its center point ends up at the specified position.

    throws

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

    Parameters

    Returns void

toString

  • (): string

Abstract translate2D

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

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