Class PlacesListFilter

Hierarchy

PlacesFilter
- PlacesListFilter

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PlacesListFilter(placesFilter: PlacesListFilterJSON): PlacesListFilter

Overrides PlacesFilter.constructor
- Defined in Places/ListFilter.ts:16
Parameters
- placesFilter: PlacesListFilterJSON
Returns PlacesListFilter

Properties

Protected Optional _bounds

_bounds: Bounds

Protected Optional _categories

_categories: string[]

Protected Optional _categoriesOperator

_categoriesOperator: LogicalOperator

Protected Optional _levels

_levels: string[]

Protected Optional _limit

_limit: undefined | number

Protected Optional _mapSpread

_mapSpread: undefined | number

Protected Optional _mapTiles

_mapTiles: string[]

Protected Optional _parents

_parents: string[]

Protected Optional _parentsOperator

_parentsOperator: LogicalOperator

Protected Optional _query

_query: undefined | string

Protected Optional _tags

_tags: string[]

Protected Optional _tagsOperator

_tagsOperator: LogicalOperator

Protected Optional _zoom

_zoom: undefined | number

Accessors

bounds

get bounds(): Bounds | null

Inherited from PlacesFilter.bounds
- Defined in Places/Filter.ts:66
Returns Bounds | null

mapSpread

get mapSpread(): number | null

- Defined in Places/ListFilter.ts:51
Returns number | null

zoom

get zoom(): number | null

Inherited from PlacesFilter.zoom
- Defined in Places/Filter.ts:70
Returns number | null

Methods

cloneSetBounds

cloneSetBounds(value: Bounds | null): PlacesListFilter

- Defined in Places/ListFilter.ts:25
Parameters
- value: Bounds | null
Returns PlacesListFilter

cloneSetLimit

cloneSetLimit(value: number): PlacesListFilter

- Defined in Places/ListFilter.ts:35
Parameters
- value: number
Returns PlacesListFilter

cloneSetMapTiles

cloneSetMapTiles(value: string[]): PlacesListFilter

- Defined in Places/ListFilter.ts:30
Parameters
- value: string[]
Returns PlacesListFilter

toQueryObject

toQueryObject(): PlacesListFilterQuery

Overrides PlacesFilter.toQueryObject
- Defined in Places/ListFilter.ts:40
Returns PlacesListFilterQuery

toQueryString

toQueryString(): string

Inherited from PlacesFilter.toQueryString
- Defined in Places/Filter.ts:107
Returns string

Protected validate

validate(): void

Overrides PlacesFilter.validate
- Defined in Places/ListFilter.ts:55
Returns void

Generated using TypeDoc