Autocomplete

提供关键字自动补全和搜索建议功能。

构造函数

  • 创建自动完成实例

    参数类型说明
    optionsAutocompleteOptions配置参数
    属性类型说明
    baseDomstring | HTMLElement以此 DOM 元素为基础定位建议面板弹出位置
    inputstring | HTMLElement文本输入框元素或其id
    locationstring | Point | Map设定返回结果的所属城市范围。可传入城市名称字符串(如"北京市")、Map 实例(自动获取地图当前城市)或 Point 坐标(反解出所在城市)。不设置时默认搜索全国
    onConfirmFunction用户选中某条建议项时的回调函数
    onHighlightFunction高亮项发生变化时的回调函数
    onSearchCompleteFunction在input框中输入字符后,发起列表检索,完成后的回调函数
    suggestionCountnumber最多显示的建议条数
    typesstring返回数据类型。不设置或为空时返回所有类型数据(餐饮、地名、公司等)。设置为 ["city"] 时仅返回省市区县乡镇街道等行政区划地址类型数据

    返回值 Autocomplete

    示例代码1

    const autocomplete = new BMap.Autocomplete({
    input: 'searchInput',
    location: map,
    onSearchComplete(results) {
    console.log(autocomplete.getResults());
    },
    });

方法

  • 添加事件监听

    参数类型说明
    eventK事件名称
    handler(e: AutocompleteEventMap[K]) => void事件处理函数

    返回值 void

    4.0 已废弃,请使用 AutocompleteOptions 中的 onConfirm / onHighlight 回调代替

    示例代码1

    autocomplete.addEventListener('onconfirm', (e) => {
    console.log('选中:', e.item.value.business);
    console.log('索引:', e.item.index);
    });

    autocomplete.addEventListener('onhighlight', (e) => {
    console.log('高亮从', e.fromitem.index, '变为', e.toitem.index);
    });
  • 销毁自动完成实例

    返回值 void

  • 隐藏提示列表

    返回值 void

  • 移除事件监听

    参数类型说明
    eventK事件名称
    handler(e: AutocompleteEventMap[K]) => void要移除的事件处理函数

    返回值 void

    4.0 已废弃,请使用 AutocompleteOptions 中的 onConfirm / onHighlight 回调代替

  • 发起关键字提示请求,触发 onSearchComplete 回调

    参数类型说明
    keywordsstring搜索关键字

    返回值 void

    示例代码1

    autocomplete.search('天安门');
    
  • 设置绑定输入控件的值,不触发下拉列表

    参数类型说明
    keywordstring关键字

    返回值 void

    示例代码1

    autocomplete.setInputValue('北京大学');
    
  • 设置检索区域

    参数类型说明
    locationstring地图实例、坐标点或城市名称字符串

    返回值 void

    示例代码1

    autocomplete.setLocation('上海');
    
  • 修改请求数据类型

    参数类型说明
    typesstring数据类型数组

    返回值 void

    示例代码1

    autocomplete.setTypes(['city', 'district']);
    
  • 显示提示列表

    返回值 void