Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Readonly cache

cache: any

The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation.

Read more...

center

center: Point

The center point of the circle.

Read more...

centroid

centroid: Point

The centroid of the polygon.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly extent

extent: Extent

The extent of the geometry.

Read more...

geodesic

geodesic: boolean

Applicable when the spatial reference of the center point is either set to Web Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326).

Read more...

hasM

hasM: boolean

Indicates if the geometry has M values.

Read more...

hasZ

hasZ: boolean

Indicates if the geometry has z-values (elevation).

Read more...

initialized

initialized: boolean

isSelfIntersecting

isSelfIntersecting: boolean

Checks to see if polygon rings cross each other and indicates if the polygon is self-intersecting, which means the ring of the polygon crosses itself.

Read more...

numberOfPoints

numberOfPoints: number

This value defines the number of points along the curve of the circle.

Read more...

radius

radius: number

The radius of the circle.

Read more...

radiusUnit

radiusUnit: "meters" | "kilometers" | "feet" | "yards" | "miles" | "nautical-miles"

Unit of the radius.

Read more...

rings

rings: number[][][]

An array of rings.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the geometry.

Read more...

Readonly type

type: "polygon"

The string value representing the type of geometry.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Circle
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Circle

addRing

  • Adds a ring to the Polygon.

    Read more...

    Parameters

    • points: number[][] | Point[]

    Returns Polygon

clone

  • Creates a deep clone of Circle.

    Read more...

    Returns Circle

contains

  • contains(point: Point): boolean
  • Checks on the client if the input point is inside the polygon.

    Read more...

    Parameters

    Returns boolean

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getPoint

  • getPoint(ringIndex: number, pointIndex: number): Point
  • Returns a point specified by a ring and point in the path.

    Read more...

    Parameters

    • ringIndex: number
    • pointIndex: number

    Returns Point

insertPoint

  • insertPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon
  • Inserts a new point into the polygon.

    Read more...

    Parameters

    • ringIndex: number
    • pointIndex: number
    • point: Point | number[]

    Returns Polygon

isClockwise

  • isClockwise(ring: number[][] | Point[]): boolean
  • Checks if a Polygon ring is clockwise.

    Read more...

    Parameters

    • ring: number[][] | Point[]

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

removePoint

  • removePoint(ringIndex: number, pointIndex: number): Point[]
  • Removes a point from the polygon at the given pointIndex within the ring identified by ringIndex.

    Read more...

    Parameters

    • ringIndex: number
    • pointIndex: number

    Returns Point[]

removeRing

  • removeRing(index: number): Point[]
  • Removes a ring from the Polygon.

    Read more...

    Parameters

    • index: number

    Returns Point[]

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Circle

  • Parameters

    Returns Circle

setPoint

  • setPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon
  • Updates a point in the polygon.

    Read more...

    Parameters

    • ringIndex: number
    • pointIndex: number
    • point: Point | number[]

    Returns Polygon

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc