Class PoisService

Hierarchy

PoisService

Index

Constructors

constructor

Methods

searchByBbox searchByBuildingId searchByDistance searchByIds searchByVenueId searchCategories searchOrientation

Constructors

constructor

new PoisService(): PoisService
Returns PoisService
- Defined in src/services/pois_service.ts:30

Methods

searchByBbox

searchByBbox(keywords, bbox, offset?, page?): AxiosPromise<IResponse<IResponsePois>>
Parameters
- keywords: string
- bbox: number[]
  
  Rectangular area, [minLon, minLat, maxLon, maxLat].
- offset: number = OFFSET
  
  The maximum value is 100, default is 10.
- page: number = PAGE
  
  Default is 1.
Returns AxiosPromise<IResponse<IResponsePois>>

Description
Search POIs in a bbox.
- Defined in src/services/pois_service.ts:95

searchByBuildingId

searchByBuildingId(keywords, buildingId, offset?, page?): AxiosPromise<IResponse<IResponsePois>>
Parameters
- keywords: string
- buildingId: string
- offset: number = OFFSET
  
  The maximum value is 100, default is 10.
- page: number = PAGE
  
  Default is 1.
Returns AxiosPromise<IResponse<IResponsePois>>

Description
Search POIs of a building.
- Defined in src/services/pois_service.ts:127

searchByDistance

searchByDistance(category, center, distance, offset?, page?): AxiosPromise<IResponse<IResponsePois>>
Parameters
- category: string
- center: number[]
- distance: number
  
  Radius from center, unit is meter, cannot exceed 10,000.
- offset: number = OFFSET
  
  The maximum value is 100, default is 10.
- page: number = PAGE
  
  Default is 1.
Returns AxiosPromise<IResponse<IResponsePois>>

Description
Search POIs by radius distance of the center point.
- Defined in src/services/pois_service.ts:59

searchByIds

searchByIds(ids): AxiosPromise<IResponse<IResponsePois>>
Parameters
- ids: string | string[]
  
  Single id string or id string array. The number of IDs cannot exceed 100.
Returns AxiosPromise<IResponse<IResponsePois>>

Description
Search POIs by id[s].
- Defined in src/services/pois_service.ts:38

searchByVenueId

searchByVenueId(keywords, venueId, offset?, page?): AxiosPromise<IResponse<IResponsePois>>
Parameters
- keywords: string
- venueId: string
- offset: number = OFFSET
- page: number = PAGE
Returns AxiosPromise<IResponse<IResponsePois>>

Description
Search POIs of a venue.
- Defined in src/services/pois_service.ts:156

searchCategories

searchCategories(paramObject): AxiosPromise<IResponse<IPoiCategory[]>>
Parameters
- paramObject: {
      buildingId?: string;
      floorId?: string;
      venueId?: string;
  }
  - Optional buildingId?: string
  - Optional floorId?: string
  - Optional venueId?: string
Returns AxiosPromise<IResponse<IPoiCategory[]>>

Description
Search poi categories by venue id, building id, or floor id. Search scope priority: floorId > buildingId > venueId.
- Defined in src/services/pois_service.ts:182

searchOrientation

searchOrientation(paramObj): AxiosPromise<IResponse<IOrientationPoi[]>>
Parameters
- paramObj: {
      angle: number;
      buildingId?: string;
      center: [number, number];
      distance: number;
      distanceSearchType?: DistanceSearchType;
      floorId?: string;
      ordinal?: string;
  }
  - angle: number
    
    The angle between cellphone's orientation and the north.
  - Optional buildingId?: string
  - center: [number, number]
    
    User's current position, [lon, lat].
  - distance: number
    
    Radius.
  - Optional distanceSearchType?: DistanceSearchType
    
    Search type.
  - Optional floorId?: string
  - Optional ordinal?: string
    
    Floor order in physical space, e.g. '-1', '0'(ground floor), '1'...
Returns AxiosPromise<IResponse<IOrientationPoi[]>>

Description
Search orientation and poi. BuildingId, floorId and ordinal are mutually exclusive, priority: ordinal > floorId > buildingId.
- Defined in src/services/pois_service.ts:213

Class PoisService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns PoisService

Methods

searchByBbox

Parameters

keywords: string

bbox: number[]

offset: number = OFFSET

page: number = PAGE

Returns AxiosPromise<IResponse<IResponsePois>>

Description

searchByBuildingId

Parameters

keywords: string

buildingId: string

offset: number = OFFSET

page: number = PAGE

Returns AxiosPromise<IResponse<IResponsePois>>

Description

searchByDistance

Parameters

category: string

center: number[]

distance: number

offset: number = OFFSET

page: number = PAGE

Returns AxiosPromise<IResponse<IResponsePois>>

Description

searchByIds

Parameters

ids: string | string[]

Returns AxiosPromise<IResponse<IResponsePois>>

Description

searchByVenueId

Parameters

keywords: string

venueId: string

offset: number = OFFSET

page: number = PAGE

Returns AxiosPromise<IResponse<IResponsePois>>

Description

searchCategories

Parameters

paramObject: { buildingId?: string; floorId?: string; venueId?: string; }

Optional buildingId?: string

Optional floorId?: string

Optional venueId?: string

Returns AxiosPromise<IResponse<IPoiCategory[]>>

Description

searchOrientation

Parameters

paramObj: { angle: number; buildingId?: string; center: [number, number]; distance: number; distanceSearchType?: DistanceSearchType; floorId?: string; ordinal?: string; }

angle: number

Optional buildingId?: string

center: [number, number]

distance: number

Optional distanceSearchType?: DistanceSearchType

Optional floorId?: string

Optional ordinal?: string

Returns AxiosPromise<IResponse<IOrientationPoi[]>>

Description

Settings

Member Visibility

Theme

On This Page

paramObject: {
buildingId?: string;
floorId?: string;
venueId?: string;
}

`Optional` buildingId?: string

`Optional` floorId?: string

`Optional` venueId?: string

paramObj: {
angle: number;
buildingId?: string;
center: [number, number];
distance: number;
distanceSearchType?: DistanceSearchType;
floorId?: string;
ordinal?: string;
}

`Optional` buildingId?: string

`Optional` distanceSearchType?: DistanceSearchType

`Optional` floorId?: string

`Optional` ordinal?: string