Options
All
  • Public
  • Public/Protected
  • All
Menu

ArcBand interface. An arc band is a Shape that represents a general circular arc band in the 2D space.

The arc band is defined by:

An arc band cannot be instantiated directly. It must be instantiated using createArcBand.

Hierarchy

Implements

Overview

Accessors

bounds

center

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(): Point

maxRadius

  • get maxRadius(): number
  • set maxRadius(maxRadius: number): void
  • The maximum radius of this arc band, in meters. This field is mutable.

    Returns number

  • The maximum radius of this arc band, in meters. This field is mutable.

    Parameters

    • maxRadius: number

    Returns any

minRadius

  • get minRadius(): number
  • set minRadius(minRadius: number): void
  • The minimum radius of this arc band, in meters. This field is mutable.

    Returns number

  • The minimum radius of this arc band, in meters. This field is mutable.

    Parameters

    • minRadius: 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(startAzimuth: number): void
  • The start angle. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

    Returns number

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

    Parameters

    • startAzimuth: number

    Returns any

sweepAngle

  • get sweepAngle(): number
  • set sweepAngle(sweepAngle: number): void
  • The angle over which the shape extends, in degrees, positive clockwise. This field is mutable.

    Returns number

  • The angle over which the shape extends, in degrees, positive clockwise. This field is mutable.

    Parameters

    • sweepAngle: 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

contains2DCoordinates

  • (aX: number, aY: number): boolean

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

  • (aArcBand: Shape): boolean

move2DToCoordinates

  • (x: number, y: number): void
  • Moves the center point to another location. The passed x and y coordinates are expressed in the reference. The passed coordinates will become the coordinates of the center point.

    Parameters

    • x: number

      the x coordinate of the point.

    • y: number

      the y coordinate of the point.

    Returns void

move2DToPoint

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

    throws

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

    Parameters

    • point: Point

      the point to move the center point to.

    Returns void

toString

  • (): string

translate2D

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