UNPKG

@uiw/react-baidu-map-label

Version:

Baidu Map label Components for React.

238 lines (210 loc) 12.9 kB
<div markdown="1"> <sup>使用 <a href="https://wangchujiang.com/#/app" target="_blank">我的应用</a> 也是一种 <a href="https://wangchujiang.com/#/sponsor" target="_blank">支持</a> 我的方式:</sup> <br> <a target="_blank" href="https://apps.apple.com/app/Deskmark/6755948110" title="Deskmark for macOS"><img alt="Deskmark" height="52" width="52" src="https://wangchujiang.com/appicon/deskmark.png"></a> <a target="_blank" href="https://apps.apple.com/app/Keyzer/6500434773" title="Keyzer for macOS"><img alt="Keyzer" height="52" width="52" src="https://wangchujiang.com/appicon/keyzer.png"></a> <a target="_blank" href="https://github.com/jaywcjlove/vidwall-hub" title="Vidwall Hub for macOS"><img alt="Vidwall Hub" height="52" width="52" src="https://wangchujiang.com/appicon/vidwall-hub.png"></a> <a target="_blank" href="https://apps.apple.com/app/VidCrop/6752624705" title="VidCrop for macOS"><img alt="VidCrop" height="52" width="52" src="https://wangchujiang.com/appicon/vidcrop.png"></a> <a target="_blank" href="https://apps.apple.com/app/Vidwall/6747587746" title="Vidwall for macOS"><img alt="Vidwall" height="52" width="52" src="https://wangchujiang.com/appicon/vidwall.png"></a> <a target="_blank" href="https://wangchujiang.com/mousio-hint/" title="Mousio Hint for macOS"><img alt="Mousio Hint" height="52" width="52" src="https://wangchujiang.com/appicon/mousio-hint.png"></a> <a target="_blank" href="https://apps.apple.com/app/6746747327" title="Mousio for macOS"><img alt="Mousio" height="52" width="52" src="https://wangchujiang.com/appicon/mousio.png"></a> <a target="_blank" href="https://apps.apple.com/app/6745227444" title="Musicer for macOS"><img alt="Musicer" height="52" width="52" src="https://wangchujiang.com/appicon/musicer.png"></a> <a target="_blank" href="https://apps.apple.com/app/6743841447" title="Audioer for macOS"><img alt="Audioer" height="52" width="52" src="https://wangchujiang.com/appicon/audioer.png"></a> <a target="_blank" href="https://apps.apple.com/app/6744690194" title="FileSentinel for macOS"><img alt="FileSentinel" height="52" width="52" src="https://wangchujiang.com/appicon/file-sentinel.png"></a> <a target="_blank" href="https://apps.apple.com/app/6743495172" title="FocusCursor for macOS"><img alt="FocusCursor" height="52" width="52" src="https://wangchujiang.com/appicon/focus-cursor.png"></a> <a target="_blank" href="https://apps.apple.com/app/6742680573" title="Videoer for macOS"><img alt="Videoer" height="52" width="52" src="https://wangchujiang.com/appicon/videoer.png"></a> <a target="_blank" href="https://apps.apple.com/app/6740425504" title="KeyClicker for macOS"><img alt="KeyClicker" height="52" width="52" src="https://wangchujiang.com/appicon/key-clicker.png"></a> <a target="_blank" href="https://apps.apple.com/app/6739052447" title="DayBar for macOS"><img alt="DayBar" height="52" width="52" src="https://wangchujiang.com/appicon/daybar.png"></a> <a target="_blank" href="https://apps.apple.com/app/6739444407" title="Iconed for macOS"><img alt="Iconed" height="52" width="52" src="https://wangchujiang.com/appicon/iconed.png"></a> <a target="_blank" href="https://apps.apple.com/app/6737160756" title="Mousio for macOS"><img alt="Mousio" height="52" width="52" src="https://wangchujiang.com/appicon/rightmenu-master.png"></a> <a target="_blank" href="https://apps.apple.com/app/6723903021" title="Paste Quick for macOS"><img alt="Quick RSS" height="52" width="52" src="https://wangchujiang.com/appicon/paste-quick.png"></a> <a target="_blank" href="https://apps.apple.com/app/6670696072" title="Quick RSS for macOS/iOS"><img alt="Quick RSS" height="52" width="52" src="https://wangchujiang.com/appicon/quick-rss.png"></a> <a target="_blank" href="https://apps.apple.com/app/6670167443" title="Web Serve for macOS"><img alt="Web Serve" height="52" width="52" src="https://wangchujiang.com/appicon/web-serve.png"></a> <a target="_blank" href="https://apps.apple.com/app/6503953628" title="Copybook Generator for macOS/iOS"><img alt="Copybook Generator" height="52" width="52" src="https://wangchujiang.com/appicon/copybook-generator.png"></a> <a target="_blank" href="https://apps.apple.com/app/6471227008" title="DevTutor for macOS/iOS"><img alt="DevTutor for SwiftUI" height="52" width="52" src="https://wangchujiang.com/appicon/devtutor.png"></a> <a target="_blank" href="https://apps.apple.com/app/6479819388" title="RegexMate for macOS/iOS"><img alt="RegexMate" height="52" width="52" src="https://wangchujiang.com/appicon/regex-mate.png"></a> <a target="_blank" href="https://apps.apple.com/app/6479194014" title="Time Passage for macOS/iOS"><img alt="Time Passage" height="52" width="52" src="https://wangchujiang.com/appicon/time-passage.png"></a> <a target="_blank" href="https://apps.apple.com/app/6478772538" title="IconizeFolder for macOS"><img alt="Iconize Folder" height="52" width="52" src="https://wangchujiang.com/appicon/iconize-folder.png"></a> <a target="_blank" href="https://apps.apple.com/app/6478511402" title="Textsound Saver for macOS/iOS"><img alt="Textsound Saver" height="52" width="52" src="https://wangchujiang.com/appicon/textsound-saver.png"></a> <a target="_blank" href="https://apps.apple.com/app/6476924627" title="Create Custom Symbols for macOS"><img alt="Create Custom Symbols" height="52" width="52" src="https://wangchujiang.com/appicon/create-custom-symbols.png"></a> <a target="_blank" href="https://apps.apple.com/app/6476452351" title="DevHub for macOS"><img alt="DevHub" height="52" width="52" src="https://wangchujiang.com/appicon/devhub.png"></a> <a target="_blank" href="https://apps.apple.com/app/6476400184" title="Resume Revise for macOS"><img alt="Resume Revise" height="52" width="52" src="https://wangchujiang.com/appicon/resume-revise.png"></a> <a target="_blank" href="https://apps.apple.com/app/6472593276" title="Palette Genius for macOS"><img alt="Palette Genius" height="52" width="52" src="https://wangchujiang.com/appicon/palette-genius.png"></a> <a target="_blank" href="https://apps.apple.com/app/6470879005" title="Symbol Scribe for macOS"><img alt="Symbol Scribe" height="52" width="52" src="https://wangchujiang.com/appicon/symbol-scribe.png"></a> <br/> </div> <hr> Label 文本标注 === [![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor) [![npm version](https://img.shields.io/npm/v/@uiw/react-baidu-map-label.svg)](https://www.npmjs.com/package/@uiw/react-baidu-map-label) [![Downloads](https://img.shields.io/npm/dm/@uiw/react-baidu-map-label.svg?style=flat)](https://www.npmjs.com/package/@uiw/react-baidu-map-label) 表示地图上包 表示地图上包含信息的窗口。 ```jsx import { Label, useLabel } from '@uiw/react-baidu-map'; // 或者单独安装使用 import Label, { useLabel } from '@uiw/react-baidu-map-label'; ``` ### 基本用法 官方原生 JS 实例:https://lbsyun.baidu.com/jsdemo.htm#c1_14 ```jsx mdx:preview import React, { useState } from 'react'; import { Map, Label, APILoader } from '@uiw/react-baidu-map'; const Example = () => { const [visiable, setVisiable] = useState(true); const [content, setContent] = useState('上海市 <del>青浦区</del> 徐泾镇盈港东路'); function labelRef(props) { if (props && props.label) { console.log('label:', props.label, props.map, props.BMap); } } return ( <> <input value={content} onChange={(e) => setContent(e.target.value)} /> <button onClick={() => setVisiable(!visiable)}>{visiable ? '隐藏' : '显示'}</button> <Map zoom={13} widget={['NavigationControl']} style={{ height: 350 }} > <Label visiable={visiable} content={content} position={{ lng: 121.436256, lat: 31.246926 }} /> <Label ref={labelRef} title="wwww" content={content} position={{ lng: 121.501365, lat: 31.224942 }} onClick={() => setContent('您!点击了文本标注!')} /> <div> <Label content="test" visiable={visiable} title="wwww" position={{ lng: 121.501365, lat: 31.234942 }}> children - 2<br /> 上海市 <del>青浦区</del> 徐泾镇盈港东路 </Label> </div> </Map> </> ); } const Demo = () => ( <div style={{ width: '100%' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Example /> </APILoader> </div> ); export default Demo; ``` ### 使用 hooks `label`, `setLabel` ```jsx mdx:preview import React from 'react'; import { useRef, useEffect, useState } from 'react'; import { Map, APILoader, Provider, useMap, useLabel, useMapContext } from '@uiw/react-baidu-map'; const Example = () => { const [zoom, setZoom] = useState(15) const divElm = useRef(null); const { map } = useMapContext(); const { label, Portal } = useLabel({ content: '徐泾镇', position: { lng: 121.501365, lat: 31.224942 }, onClick: () => { console.log('点击事件!'); } }); useEffect(() => { if (map) { // 启用滚轮放大缩小,默认禁用 map.setZoom(zoom); } }, [zoom, map]); let counts = zoom || 15; return ( <> <button onClick={() => setZoom(counts-1)}>-</button> <span>{zoom || 10}</span> <button onClick={() => setZoom(counts+1)}>+</button> <Portal><div>xxxxxx</div></Portal> </> ) } const Demo = () => ( <div style={{ width: '100%' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Map zoom={9} widget={['NavigationControl']} style={{ height: 350 }} > <Example /> </Map> </APILoader> </div> ); export default Demo; ``` 使用 Provider ```jsx mdx:preview import React from 'react'; import { useRef, useEffect, useState } from 'react'; import { Map, APILoader, useMap, Provider, useLabel } from '@uiw/react-baidu-map'; const Example = () => { const [zoom, setZoom] = useState(15) const divElm = useRef(null); const { map, setContainer } = useMap({ zoom: 9, widget: ['GeolocationControl', 'NavigationControl'] }); const { label } = useLabel({ map, content: '徐泾镇', position: { lng: 121.436256, lat: 31.246926 }, onClick: () => { console.log('点击事件!'); } }); useEffect(() => { if (map) { // 启用滚轮放大缩小,默认禁用 map.setZoom(zoom); } }, [zoom, map]); useEffect(() => { if (divElm.current) { setContainer(divElm.current); } }, [divElm.current]); let counts = zoom || 15; return ( <> <button onClick={() => setZoom(counts-1)}>-</button> <span>{zoom || 15}</span> <button onClick={() => setZoom(counts+1)}>+</button> <div ref={divElm} style={{ height: 350 }} /> </> ) } const Demo = () => ( <div style={{ width: '100%' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Provider> <Example /> </Provider> </APILoader> </div> ); export default Demo; ``` ### Props | 参数 | 说明 | 类型 | 默认值 | | ----- | ----- | ----- | ----- | | content | 文本标注内容 | `string` | - | | children | 展示文本标注内容,_🚧 添加 `children` 的时候 `content` 将失效_<!--rehype:style=background-color: #ffe56440;-->。 | `JSX.Element` | - | | offset | 文本标注的位置偏移值 | `Size` | - | | position | 文本标注的地理位置 | `Point` | - | | title | 文本标注的标题 | `string` | - | | zIndex | 设置覆盖物的 zIndex | `number` | - | | style | 文本标注样式,该样式将作用于文本标注的容器元素上,如:`{ color : "red", fontSize : "12px" }`。 | `Style` | - | | visiable | 覆盖物是否可见。 | `boolean` | - | | enableMassClear | 允许覆盖物在 map.clearOverlays 方法中被清除 | `boolean` | - | ### 事件 | 参数 | 说明 | 类型 | 默认值 | | ----- | ----- | ----- | ----- | | onClick | 点击文本标注后会触发此事件 | (event: { type: string, target: any }) => void; | - | | onDblClick | 双击文本标注后会触发此事件 | (event: { type: string, target: any }) => void; | - | | onMouseDown | 鼠标在文本标注上按下触发此事件 | (event: { type: string, target: any }) => void; | - | | onMouseUp | 鼠标在文本标注释放触发此事件 | (event: { type: string, target: any }) => void; | - | | onMouseOout | 鼠标离开文本标注时触发此事件 | (event: { type: string, target: any }) => void; | - | | onMouseOver | 当鼠标进入文本标注区域时会触发此事件 | (event: { type: string, target: any }) => void; | - | | onRemove | 移除文本标注时触发 | (event: { type: string, target: any }) => void; | - | | onRightClick | 右键点击标注时触发此事件 | (event: { type: string, target: any }) => void; | - |