Class Extent

Baseclass of all geometries. All geometry types must derive from this class. Not intented to be instantiated on its own.

Hierarchy (view full)

BaseGeometry
- Extent

Index

Constructors

Properties

id rawMax rawMin sr

Accessors

type xmax xmin ymax ymin

Methods

center childIdGenerator clone contains expand geoJsonFactory invalid isEqual toArray toESRI toGeoJSON toPolygon toPolygonArray fromArcServer fromConfig fromESRI fromGeoJSON fromParams

Constructors

constructor

new Extent(id, minPoint, maxPoint, sr?): Extent
Constructs an Extent from the given source of verticies
Parameters
- id: IdDef
  An identifier for the Extent
- minPoint: Point
- maxPoint: Point
- Optionalsr: SrDef
  A spatial reference for the geometry. Defaults to Lat/Long if not provided
Returns Extent
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/extent.ts:23
new Extent(id, minCoords, maxCoords, sr?): Extent
Parameters
- id: IdDef
  Id of the geometry
- minCoords: number[]
- maxCoords: number[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns Extent
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/extent.ts:24
new Extent(id, minXY, maxXY, sr?): Extent
Parameters
- id: IdDef
  Id of the geometry
- minXY: object
- maxXY: object
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns Extent
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/extent.ts:25
new Extent(id, minAnyFormat, maxAnyFormat, sr?): Extent
Parameters
- id: IdDef
  Id of the geometry
- minAnyFormat: any
- maxAnyFormat: any
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns Extent
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/extent.ts:26

Properties

`Readonly`id

id: string

Id of the geometry

`Protected`rawMax

rawMax: number[]

`Protected`rawMin

rawMin: number[]

sr

sr: SpatialReference

Spatial Reference of the geometry

Accessors

type

get type(): GeometryType
Returns the string 'Extent'.

Returns GeometryType
Overrides BaseGeometry.type
- Defined in src/geo/api/graphic/geometry/extent.ts:37

xmax

get xmax(): number
Returns number
- Defined in src/geo/api/graphic/geometry/extent.ts:49

xmin

get xmin(): number
Returns number
- Defined in src/geo/api/graphic/geometry/extent.ts:41

ymax

get ymax(): number
Returns number
- Defined in src/geo/api/graphic/geometry/extent.ts:53

ymin

get ymin(): number
Returns number
- Defined in src/geo/api/graphic/geometry/extent.ts:45

Methods

center

center(): Point
Returns Point
- Defined in src/geo/api/graphic/geometry/extent.ts:57

`Protected`childIdGenerator

childIdGenerator(idx): string
Parameters
- idx: number
Returns string
Inherited from BaseGeometry.childIdGenerator
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:29

clone

clone(): Extent
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:71

contains

contains(testPoint): boolean
Reports if a point is within the boundary of the extent. For performance reasons, the point must be in the same spatial reference as the extent.
Parameters
- testPoint: Point
Returns boolean
if point was within the extent or not
- Defined in src/geo/api/graphic/geometry/extent.ts:82

expand

expand(factor): Extent
Parameters
- factor: number
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:66

`Protected`geoJsonFactory

geoJsonFactory(type, coords): DirectGeometryObject
Parameters
- type: string
- coords: any[]
Returns DirectGeometryObject
Inherited from BaseGeometry.geoJsonFactory
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:45

invalid

invalid(): boolean
Returns boolean
Inherited from BaseGeometry.invalid
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:41

isEqual

isEqual(e): boolean
Parameters
- e: undefined | Extent
Returns boolean
- Defined in src/geo/api/graphic/geometry/extent.ts:139

toArray

toArray(): number[][]
Returns an array of point arrays (e.g. [[x1, y1], [x2, y2]] )

Returns number[][]
- Defined in src/geo/api/graphic/geometry/extent.ts:99

toESRI

toESRI(): Extent
Returns Extent
Overrides BaseGeometry.toESRI
- Defined in src/geo/api/graphic/geometry/extent.ts:160

toGeoJSON

toGeoJSON(): Polygon
Returns Polygon
Overrides BaseGeometry.toGeoJSON
- Defined in src/geo/api/graphic/geometry/extent.ts:202

toPolygon

toPolygon(): Polygon
Returns Polygon
- Defined in src/geo/api/graphic/geometry/extent.ts:115

toPolygonArray

toPolygonArray(): number[][][]
Returns number[][][]
- Defined in src/geo/api/graphic/geometry/extent.ts:103

`Static`fromArcServer

fromArcServer(serverExtent, id?): Extent
Parameters
- serverExtent: any
- Optionalid: string | number
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:170

`Static`fromConfig

fromConfig(id, configExtent): Extent
Parameters
- id: IdDef
- configExtent: RampExtentConfig
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:130

`Static`fromESRI

fromESRI(esriExtent, id?): Extent
Parameters
- esriExtent: Extent
- Optionalid: string | number
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:149

`Static`fromGeoJSON

fromGeoJSON(geoJsonExtent, id?): Extent
Parameters
- geoJsonExtent: Polygon
- Optionalid: string | number
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:178

`Static`fromParams

fromParams(id, xmin, ymin, xmax, ymax, sr?): Extent
Parameters
- id: IdDef
- xmin: string | number
- ymin: string | number
- xmax: string | number
- ymax: string | number
- Optionalsr: SrDef
Returns Extent
- Defined in src/geo/api/graphic/geometry/extent.ts:119