Namespace Regions

The Regions module provides a store for declaring geographical regions based on a center coordinate or coordinate bounds.

Index

Functions

Functions

Const asArray

asArray(keys: string[], format: {}): any

- Defined in src/maps/Regions.ts:236
Parameters
- keys: string[]
- format: {}
  - [key: string]: string
Returns any

Const get

get(key: string): RegionType

- Defined in src/maps/Regions.ts:211
Returns the region configuration associated with the specified key, if any.

Parameters
- key: string
Returns RegionType

Const set

set(key: string, region: RegionType): void

- Defined in src/maps/Regions.ts:219
Sets the region configuration associated with the specified key.

Parameters
- key: string
- region: RegionType
Returns void

Const slug

slug(key: string): string

- Defined in src/maps/Regions.ts:228
Returns the region URL slug associated with the specified key, if any.

Parameters
- key: string
Returns string

Generated using TypeDoc