InfoWindow 信息窗口

表示地图上包含信息的窗口。

1import { InfoWindow, useInfoWindow } from '@uiw/react-baidu-map';
2// 或者单独安装使用
3import InfoWindow, { useInfoWindow } from '@uiw/react-baidu-map-info-window';

基本用法

1import React, { useState } from 'react';
2import { Map, InfoWindow, APILoader } from '@uiw/react-baidu-map';
3
4const Example = () => {
5  const [visiable, setVisiable] = useState(true);
6  const [ isOpen, setIsOpen ] = useState(true);
7  const [ content, setContent ] = useState('上海市 <del>青浦区</del> 徐泾镇盈港东路');
8
9  function infoWindowRef(props) {
10    if (props && props.infoWindow) {
11      console.log('infoWindow:', props.infoWindow, props.map, props.BMap);
12    }
13  }
14  return (
15    <>
16      <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '关闭' : '打开'} isOpen={String(isOpen)}</button>
17      <button onClick={() => setVisiable(!visiable)}>{visiable ? '隐藏' : '显示'}visiable={String(visiable)}</button>
18      <input value={content} onChange={(e) => setContent(e.target.value)} />
19      <Map zoom={13} center={{ lng: 121.460977, lat: 31.227906 }}>
20        <InfoWindow
21          ref={infoWindowRef}
22          visiable={visiable}
23          isOpen={isOpen}
24          onClose={() => {
25            console.log(':onClose');
26          }}
27          position={{ lng: 121.501365, lat: 31.224942 }}
28          content={content}
29          title="地址信息一"
30        />
31      </Map>
32    </>
33  );
34}
35
36const Demo = () => (
37  <div style={{ width: '100%', height: '350px' }}>
38    <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG">
39      <Example />
40    </APILoader>
41  </div>
42);
43export default Demo;

content -> children 支持 JSX.Element

通过 children 支持 JSX.Element 的方式展现内容，因为窗口信息内容通过 content 展示内容，它支持 string/HTMLElement 添加事件并不方便。

🚧 如果同时设置了 content 属性且有 children，content 将失效被忽略。

1import React, { useState } from 'react';
2import { Map, InfoWindow, APILoader } from '@uiw/react-baidu-map';
3
4const Example = () => {
5  const [visiable, setVisiable] = useState(true);
6  const [ isOpen, setIsOpen ] = useState(true);
7  const [ count, setCount ] = useState(0);
8  return (
9    <>
10      <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '关闭' : '打开'} isOpen={String(isOpen)}</button>
11      <button onClick={() => setVisiable(!visiable)}>{visiable ? '隐藏' : '显示'}visiable={String(visiable)}</button>
12      <Map zoom={13} center={{ lng: 121.460977, lat: 31.227906 }}>
13        <InfoWindow
14          visiable={visiable}
15          isOpen={isOpen}
16          onClose={() => {
17            console.log(':onClose');
18          }}
19          position={{ lng: 121.501365, lat: 31.224942 }}
20          title={<div>地址信息二</div>}
21          content="test"
22        >
23          <div>
24            上海市 <del>青浦区</del> 徐泾镇盈港东路 Good!
25            <br/>
26            <button onClick={() => setCount(count+1)}>{count} Count={String(count)}</button>
27          </div>
28        </InfoWindow>
29      </Map>
30    </>
31  );
32}
33
34const Demo = () => (
35  <div style={{ width: '100%', height: '350px' }}>
36    <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG">
37      <Example />
38    </APILoader>
39  </div>
40);
41export default Demo;

使用 hooks

infoWindow, setInfoWindow, isOpen, setIsOpen

1import React, { useRef, useState, useEffect } from 'react';
2import { Map, Provider, useMap, InfoWindow, useInfoWindow, APILoader } from '@uiw/react-baidu-map';
3
4const Example = () => {
5  const divElm = useRef(null);
6  const { setContainer, map } = useMap({
7    zoom: 13, center: { lng: 121.460977, lat: 31.227906 },
8    widget: ['GeolocationControl', 'NavigationControl']
9  });
10
11  const [title, setTitle] = useState('地址信息二');
12  const position = { lng: 121.501365, lat: 31.224942 };
13  const { infoWindow, isOpen, setIsOpen, Portal, PortalTitle } = useInfoWindow({
14    position, enableCloseOnClick: false, isOpen: true,
15    // content: '上海市 <del>青浦区</del> 徐泾镇盈港东路',
16    // title,
17    onClose: () => {
18      console.log('onClose:');
19    }
20  });
21  useEffect(() => {
22    if (divElm.current) {
23      setContainer(divElm.current);
24    }
25  });
26  return (
27    <>
28      <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '显示' : '隐藏'}</button>
29      <input value={title} onChange={(e) => setTitle(e.target.value)} />
30      <div ref={divElm} style={{ height: 350 }} />
31      <Portal>上海市 <del>青浦区</del> 徐泾镇盈港东路</Portal>
32      <PortalTitle> {title} </PortalTitle>
33    </>
34  )
35}
36
37const Demo = () => {
38  return (
39    <div style={{ width: '100%' }}>
40      <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG">
41        <Provider>
42          <Example />
43        </Provider>
44      </APILoader>
45    </div>
46  )
47};
48export default Demo;

Props

参数	说明	类型	默认值
position	必填 指定的经度和纬度创建一个地理点坐标	Point	-
content	展示文本内容，支持 HTML 内容字符串	string	-
children	展示文本内容，🚧 添加 children 的时候 content 将失效。	JSX.Element	-
isOpen	窗口是否打开	Point	-
visiable	覆盖物是否可见。此属性来自继承 Overlay 实例对象。	boolean	-
width	信息窗宽度，单位像素。取值范围：0, 220 - 730。如果您指定宽度为 0，则信息窗口的宽度将按照其内容自动调整	number	true
height	信息窗高度，单位像素。取值范围：0, 60 - 650。如果您指定宽度为 0，则信息窗口的宽度将按照其内容自动调整	number	-
maxWidth	信息窗最大化时的宽度，单位像素。取值范围：220 - 730	number	-
offset	信息窗位置偏移值。默认情况下在地图上打开的信息窗底端的尖角将指向其地理坐标，在标注上打开的信息窗底端尖角的位置取决于标注所用图标的 infoWindowOffset 属性值，您可以为信息窗添加偏移量来改变默认位置	Size	-
maxContent	信息窗口最大化时所显示内容，支持HTML内容	string	-
title	信息窗标题文字，支持 HTML 内容	string	-
message	自定义部分的短信内容，可选项。完整的短信内容包括：自定义部分+位置链接，不设置时，显示默认短信内容。短信内容最长为140个字	string	-
enableAutoPan	是否开启信息窗口打开时地图自动移动（默认开启）	boolean	-
enableCloseOnClick	是否开启点击地图关闭信息窗口（默认开启）	boolean	-
enableMaximize	启用窗口最大化功能。需要设置最大化后信息窗口里的内容，该接口才生效	boolean	-

事件

参数	说明	类型
onClose	信息窗口被关闭时触发此事件	(event: { type: string, target: any, point: Point }) => void;
onOpen	信息窗口被打开时触发此事件	(event: { type: string, target: any, point: Point }) => void;
onMaximize	信息窗口最大化后触发此事件	(event: { type: string, target: any }) => void;
onRestore	信息窗口还原时触发此事件	(event: { type: string, target: any }) => void;
onClickclose	点击信息窗口的关闭按钮时触发此事件	(event: { type: string, target: any }) => void;