Class Polygon

Hierarchy

EventBindable
- Polygon

Index

Constructors

constructor

Methods

Constructors

constructor

new Polygon(options?: PolygonOptions): Polygon

Overrides EventBindable.constructor
- Defined in index.d.ts:743
Parameters
- Optional options: PolygonOptions
Returns Polygon

Methods

contains

contains(point: LngLat): boolean

- Defined in index.d.ts:756
Parameters
- point: LngLat
Returns boolean

getArea

getArea(): number

- Defined in index.d.ts:750
Returns number

getBounds

getBounds(): Bounds

- Defined in index.d.ts:749
Returns Bounds

getExtData

getExtData(): any

- Defined in index.d.ts:755
Returns any

getOptions

getOptions(): PolygonOptions

- Defined in index.d.ts:748
Returns PolygonOptions

getPath

getPath(): LngLat[] | LngLat[][]

- Defined in index.d.ts:746
Returns LngLat[] | LngLat[][]

hide

hide(): void

- Defined in index.d.ts:751
Returns void

off

off(eventName: string, callback: EventCallback): void

Inherited from EventBindable.off
- Defined in index.d.ts:71
Parameters
- eventName: string
- callback: EventCallback
Returns void

on

on(eventName: string, callback: EventCallback): void

Inherited from EventBindable.on
- Defined in index.d.ts:70
Parameters
- eventName: string
- callback: EventCallback
Returns void

setExtData

setExtData(ext: any): void

- Defined in index.d.ts:754
Parameters
- ext: any
Returns void

setMap

setMap(map: Map): void

- Defined in index.d.ts:753
Parameters
- map: Map
Returns void

setOptions

setOptions(opt: PolygonOptions): void

- Defined in index.d.ts:747
Parameters
- opt: PolygonOptions
Returns void

setPath

setPath(path: LngLat[] | LngLat[][]): void

- Defined in index.d.ts:745
Parameters
- path: LngLat[] | LngLat[][]
Returns void

show

show(): void

- Defined in index.d.ts:752
Returns void

Generated using TypeDoc