@wenle_2523097/agri-map 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -0,0 +1,312 @@
+/**
+ * 农业地图组件库主入口文件
+ * @description 导出所有公共组件和工具函数
+ */
+import './styles/index.scss';
+/**
+ * 高性能地块图层组件
+ * @description 使用Leaflet原生GeoJSON Layer，支持大规模地块数据（上万条），支持单击和右键事件
+ * @see docs/PERFORMANCE_OPTIMIZATION.md 性能优化指南
+ * @example
+ * <PlotLayer plots={plotDataArray} onPlotClick={handleClick} onPlotContextMenu={handleContextMenu} />
+ */
+export { default as PlotLayer } from './components/PlotLayer';
+/**
+ * 多类型地块分组编排组件
+ * @description 将多种类型的地块分组渲染，每种类型对应一个独立的 PlotLayer 实例，
+ *   支持跨类型互斥选中、统一分组高亮、合并渲染统计等功能。
+ * @example
+ * <PlotGroupLayer
+ *   dataSource={{
+ *     wasteland: { dataSource: wastelandData, path: { color: '#8B7355', fillColor: '#8B7355', fillOpacity: 0.3 } },
+ *     paddyField: { dataSource: paddyFieldData, path: { color: '#52c41a', fillColor: '#52c41a', fillOpacity: 0.3 } },
+ *   }}
+ *   mode="single"
+ *   groupKey="possessor"
+ * />
+ */
+export { default as PlotGroupLayer } from './components/PlotGroupLayer';
+/**
+ * 天地图图层组件
+ * @description 封装天地图的矢量图层和标注图层，支持多种图层风格（矢量、卫星、地形）和叠加瓦片
+ * @example
+ * <TianDiTuLayer apiKey="your-key" layerType="satellite" showAnnotation={true} />
+ * <TianDiTuLayer apiKey="your-key" overlayUrl="https://your-server.com/overlay/{z}/{x}/{y}.png" overlayOpacity={0.5} />
+ */
+export { default as TianDiTuLayer, LAYER_TYPES } from './components/TianDiTuLayer';
+/**
+ * 双向标尺组件
+ * @description 在地图上同时显示水平和垂直两个标尺
+ * @example
+ * <DualScaleControl />
+ * <DualScaleControl config={{ metric: true, imperial: false, showZoomControl: true }} />
+ */
+export { default as DualScaleControl } from './components/DualScaleControl';
+/**
+ * 测量工具栏组件
+ * @description 提供地图上的长度和面积测量功能，采用统一的工具栏样式
+ * @features
+ * - 测长度：绘制折线，实时显示长度
+ * - 测面积：绘制多边形，实时显示面积
+ * - 支持多种单位：m/km/ft/mi（长度）, sqm/sqkm/sqft/acre/hectare（面积）
+ * - 可配置位置：topleft/topright/bottomleft/bottomright
+ * - 实时显示测量值
+ * - 统一工具栏样式，与 BaseEditToolbar 保持一致
+ * @example
+ * // 基础用法
+ * <MeasurementToolbar />
+ *
+ * // 自定义位置和单位
+ * <MeasurementToolbar position="topright" lengthUnit="km" areaUnit="hectare" />
+ */
+export { default as MeasurementToolbar } from './components/Measurement/toolbar';
+/**
+ * 全局配置提供者组件
+ * @description 为子组件提供统一的全局配置（如主题）
+ * @example
+ * <ConfigProvider theme="dark" dualScaleControl tianDiTuLayer={{ apiKey: 'xxx' }}>
+ *   <MapContainer>
+ *     <MapContent />
+ *   </MapContainer>
+ * </ConfigProvider>
+ */
+export { default as ConfigProvider, useConfig } from './components/ConfigProvider';
+/**
+ * 地图内容组件
+ * @description 根据 ConfigProvider 配置自动渲染 DualScaleControl、TianDiTuLayer 和 MapSizeHandler
+ * @example
+ * <ConfigProvider dualScaleControl tianDiTuLayer={{ apiKey: 'xxx' }} mapSizeHandler>
+ *   <MapContainer>
+ *     <MapContent />
+ *   </MapContainer>
+ * </ConfigProvider>
+ */
+export { default as MapContent } from './components/MapContent';
+/**
+ * 地图尺寸处理器组件
+ * @description 解决地图容器尺寸变化后（如抽屉/对话框打开），地图不自动刷新的问题
+ * @example
+ * // 通过 ConfigProvider 配置（推荐）
+ * <ConfigProvider mapSizeHandler>
+ *   <MapContainer>
+ *     <MapContent />
+ *   </MapContainer>
+ * </ConfigProvider>
+ *
+ * // 或直接使用
+ * <MapContainer>
+ *   <MapSizeHandler />
+ * </MapContainer>
+ */
+export { default as MapSizeHandler } from './components/MapSizeHandler';
+/**
+ * 地图标注组件
+ * @description 用于在地图上显示多个标注点，支持自定义图标
+ * @example
+ * <Marker
+ *   icon="point"
+ *   dataSource={[{ id: 1, position: [29.94, 117.90], title: '标注点1' }]}
+ *   onClick={handleClick}
+ * />
+ */
+export { default as Marker } from './components/Marker';
+/**
+ * 标注点编辑工具栏组件
+ * @description 提供标注点编辑功能的工具栏，包含新建、移动、删除等操作
+ */
+export { default as MarkerEditToolbar } from './components/Marker/toolbar';
+/**
+ * 农机轨迹组件
+ * @description 用于在地图上显示农机作业轨迹，支持轨迹分段显示（路上/作业中不同颜色）、方向指示、轨迹选中等功能
+ * @example
+ * <Track
+ *   data={trackData}
+ *   showDirection={true}
+ *   showStartEnd={true}
+ *   onClick={(key, track) => console.log(key, track)}
+ * />
+ */
+export { default as Track } from './components/Track';
+/**
+ * 小地图组件
+ * @description 在主地图上显示轨迹概览和当前视口位置的小地图，用于导航引导
+ * @example
+ * // 在 Track 组件中启用
+ * <Track dataSource={trackData} miniMap />
+ *
+ * // 自定义配置
+ * <Track
+ *   dataSource={trackData}
+ *   miniMap={{
+ *     width: 200,
+ *     height: 150,
+ *     zoomOffset: -5,
+ *     draggable: true,
+ *     showTrackOverview: true,
+ *   }}
+ * />
+ */
+export { default as MiniMap } from './components/MiniMap';
+/**
+ * 田间道路组件
+ * @description 用于在地图上绘制和管理田间道路，支持新建、编辑、删除等编辑功能
+ */
+export { default as Road } from './components/Road';
+/**
+ * 道路编辑工具栏组件
+ * @description 提供道路编辑功能的工具栏，包含新建、编辑、删除等操作
+ */
+export { default as RoadEditToolbar } from './components/Road/toolbar';
+/**
+ * 工具栏按钮组件
+ * @description 提供统一样式的工具栏按钮，用于自定义工具栏内容
+ * @example
+ * ```tsx
+ * import { Marker, ToolbarButton } from 'agri-map-components';
+ *
+ * <Marker
+ *   editMode={{
+ *     enabled: ['create', 'move', 'delete'],
+ *     toolbar: (
+ *       <>
+ *         <ToolbarButton variant="primary" onClick={() => console.log('自定义操作')}>
+ *           自定义按钮
+ *         </ToolbarButton>
+ *       </>
+ *     )
+ *   }}
+ * />
+ * ```
+ */
+export { default as ToolbarButton, type ToolbarButtonProps } from './components/shared/ToolbarButton';
+/**
+ * 灌溉渠组件
+ * @description 用于在地图上绘制和管理灌溉渠，支持新建、编辑、删除等编辑功能，可显示流向箭头
+ */
+export { default as Irrigation } from './components/Irrigation';
+/**
+ * 灌溉渠编辑工具栏组件
+ * @description 提供灌溉渠编辑功能的工具栏，包含新建、编辑、删除等操作
+ */
+export { default as IrrigationEditToolbar } from './components/Irrigation/toolbar';
+/**
+ * Loading 加载组件
+ * @description 显示加载状态的组件，支持多种加载图标和自定义配置
+ * @example
+ * // 基础用法
+ * <Loading />
+ *
+ * // 自定义图标和描述
+ * <Loading icon="loading-dots" description="加载中..." />
+ *
+ * // 自定义尺寸
+ * <Loading size="large" />
+ * <Loading size={64} />
+ *
+ * // 在 Marker 中使用
+ * <Marker loading={true} />
+ */
+export { default as Loading } from './components/Loading';
+/**
+ * SVG 图标组件库
+ * @description 统一的 SVG 图标组件，包含重绘、剪切、移动、删除、取消、保存、新建等图标
+ * @example
+ * import { PlotRedrawIcon, CreateIcon } from 'agri-map-components';
+ * // 或
+ * import Icons from 'agri-map-components';
+ * <Icons.Create />
+ */
+export { default as Icons, MarkerRedrawIcon, PlotRedrawIcon, RoadRedrawIcon, IrrigationRedrawIcon, ClipIcon, MoveIcon, DeleteIcon, CancelIcon, SaveIcon, CreateIcon, EditIcon, ReverseIcon } from './components/Icons';
+/**
+ * 图标选择器组件
+ * @description 兼容 antd Form 的 value/onChange 接口，用于选择预设地图图标
+ * @example
+ * // antd Form 中使用
+ * import { SelectIcon } from 'agri-map-components';
+ * <Form.Item label="图标" name="icon">
+ *   <SelectIcon />
+ * </Form.Item>
+ *
+ * // 独立使用
+ * const [icon, setIcon] = useState('marker-blue');
+ * <SelectIcon value={icon} onChange={setIcon} allowClear />
+ */
+export { SelectIcon, IconPreview, DEFAULT_ICON_GROUPS } from './components/Icons/SelectIcon';
+export type { SelectIconProps, IconPreviewProps, IconGroupItem, IconGroup } from './components/Icons/SelectIcon';
+/**
+ * 图标工具函数
+ * @description 统一的图标检测和处理工具
+ * @example
+ * import { detectIconType, PRESET_ICONS } from 'agri-map-components';
+ * const result = detectIconType('marker-blue'); // { type: 'preset', value: 'marker-blue' }
+ */
+export { detectIconType, PRESET_ICONS, isUrlIcon, isPresetIcon, generateSvgHtml, PULSE_ICONS } from './utils/iconUtils';
+export { generateTractorSvg, generateTractor2Svg } from './utils/iconCache';
+export { generatePulseSvg } from './utils/pulseIcon';
+/**
+ * 面积计算工具
+ * @description 包含面积计算、单位转换、格式化等函数
+ */
+export { calculatePolygonArea, convertArea, formatArea, getAreaUnitConfig, AREA_UNIT_CONFIGS, computeDataBounds } from './utils/area';
+/**
+ * 常量配置
+ * @description 地图组件库的常量定义
+ */
+export * from './constants';
+/**
+ * 工具函数
+ * @description 包含地图相关的计算和判断工具函数
+ */
+export * from './utils';
+/**
+ * 双向标尺配置类型
+ * @description DualScaleControl 组件的 config 属性配置
+ * @property metric - 是否显示公制单位（km/m/cm），默认 true
+ * @property imperial - 是否显示英制单位（mi/ft/in），默认 false
+ * @property showZoomControl - 是否显示缩放控件（放大/缩小按钮和缩放级别），默认 true
+ * @example
+ * const config: DualScaleControlConfig = {
+ *   metric: true,        // 显示公制单位
+ *   imperial: false,     // 不显示英制单位
+ *   showZoomControl: true // 显示缩放控件
+ * };
+ * <DualScaleControl config={config} />
+ */
+export type { DualScaleControlConfig } from './types';
+/**
+ * 天地图图层配置类型
+ * @description ConfigProvider 的 tianDiTuLayer 属性配置
+ * @property apiKey - 天地图 API Key（必填）
+ * @property layerType - 图层类型：vector(矢量) | satellite(卫星) | terrain(地形)，默认 vector
+ * @property showAnnotation - 是否显示标注图层，默认 true
+ * @property overlayUrl - 自定义瓦片叠加层 URL
+ * @property subdomains - 瓦片服务子域名
+ * @property maxZoom - 最大缩放级别
+ * @property minZoom - 最小缩放级别
+ * @example
+ * const config: TianDiTuLayerConfig = {
+ *   apiKey: 'your-api-key',
+ *   layerType: 'satellite',
+ *   showAnnotation: true,
+ *   overlayUrl: 'https://example.com/tile/{z}/{x}/{y}.png'
+ * };
+ */
+export type { TianDiTuLayerConfig } from './types';
+/**
+ * 地图尺寸处理器配置类型
+ * @description ConfigProvider 的 mapSizeHandler 属性配置
+ * @property enabled - 是否启用，默认 true
+ * @property delay - 首次刷新的延迟时间（毫秒），默认 100
+ * @property retries - 重试次数，默认 3
+ * @example
+ * const config: MapSizeHandlerConfig = {
+ *   enabled: true,
+ *   delay: 200,
+ *   retries: 5
+ * };
+ * <ConfigProvider mapSizeHandler={config}>
+ *   ...
+ * </ConfigProvider>
+ */
+export type { MapSizeHandlerConfig } from './types';
+export type { Coordinate, BoundingBox, PathOptions, PlotType, PlotStatus, PlotData, PlotStyle, PlotEditMode, PlotEditResult, PlotClipResult, PlotMoveResult, PlotCreateResult, PlotDeleteResult, RenderStats, PlotLayerProps, PlotRef, PlotFieldNames, PlotGroupConfig, GroupRenderStats, PlotGroupLayerProps, PlotGroupRef, MarkerData, MarkerIconOptions, MarkerCreateResult, MarkerMoveResult, MarkerDeleteResult, MarkerEditResult, MarkerProps, MarkerRef, MarkerEditModeConfig, MarkerEvents, RoadData, RoadCreateResult, RoadEditResult, RoadDeleteResult, RoadProps, RoadRef, RoadEditModeConfig, RoadEvents, IrrigationFieldNames, IrrigationData, IrrigationCreateResult, IrrigationEditResult, IrrigationDeleteResult, IrrigationReverseResult, IrrigationProps, IrrigationRef, IrrigationEvents, DecoratorConfig, LayerType, TianDiTuLayerProps, ConfigContextValue, ConfigProviderProps, DualScaleControlProps, MapContentProps, NotificationType, NotificationOptions, NotificationInstance, NotificationProps, PlotEditToolbarProps, MarkerEditToolbarProps, RoadEditToolbarProps, IrrigationEditToolbarProps, PlotLabelProps, TrackData, TrackProps, TrackRef, TrackPoint, MiniMapProps, LoadingIconName, LoadingSize, LoadingMaskConfig, LoadingProps, LengthUnit, MeasurementAreaUnit, MeasurementMode, MeasurementControlPosition, MeasurementToolbarProps, MeasurementData, UnitConfig, } from './types';