Interface PoiCitySearchOptionParams

interface PoiCitySearchOptionParams {
    city: string;
    keyword: string;
    pageNum?: number;
    pageCapacity?: number;
    isReturnAddr?: boolean;
    tag?: string;
    scope?: number;
    isCityLimit?: boolean;
    poiFilter?: PoiFilter;
    isExtendAdcode?: boolean;
    languageType?: LanguageType;
}

Properties

city keyword pageNum? pageCapacity? isReturnAddr? tag? scope? isCityLimit? poiFilter? isExtendAdcode? languageType?

Properties

city

city: string

检索行政区划区域。可输入行政区划名或对应cityCode 必须参数 如需严格限制召回数据在区域内，请设置isCityLimit参数为true

keyword

keyword: string

检索关键字，必须参数

Optional pageNum

pageNum?: number

分页页码 默认为0,0代表第一页，1代表第二页，以此类推

Optional pageCapacity

pageCapacity?: number

单页展示POI数量，默认为10条记录，最大返回20条。 多关键字检索时，返回的记录数为关键字个数*pageNum

Optional isReturnAddr

isReturnAddr?: boolean

是否返回地址信息

Optional tag

tag?: string

检索分类， 多个分类以","分割

Optional scope

scope?: number

检索结果详细程度。 取值为 或空，则返回基本信息；取值为2，返回检索POI详细信息

Optional isCityLimit

isCityLimit?: boolean

区域数据召回限制 为true时，仅返回city对应区域内数据

Optional poiFilter

poiFilter?: PoiFilter

检索过滤条件。 当scope取值为2时，可以设置filter进行排序

Optional isExtendAdcode

isExtendAdcode?: boolean

是召回行政区域编码

Optional languageType

languageType?: LanguageType

检索语言类型 默认中文

Settings

Theme

On This Page

citykeywordpageNumpageCapacityisReturnAddrtagscopeisCityLimitpoiFilterisExtendAdcodelanguageType