@tarojs/components 3.5.5 → 3.5.6-alpha.1

package/types/Map.d.ts

@@ -1,170 +1,167 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface MapProps extends StandardProps {
   /** 中心经度
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   longitude: number
 
   /** 中心纬度
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   latitude: number
 
-  /** 缩放级别，取值范围为3-20
+  /** 缩放级别，取值范围为 3-20
    * @default 16
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    * @swan 取值范围为4-21
    * @alipay 取值范围为5-18
    */
   scale?: number
-  /** 最小缩放级别3-20
+
+  /** 最小缩放级别 3-20
    * @default 3
    * @supported weapp, tt
    */
   minScale?: number
-  /** 最大缩放级别3-20
-   * (备注: 字节小程序最大缩放级别 3-19)
-   * @default 20 (字节小程序默认为19)
+
+  /** 最大缩放级别 3-20
+   * @default 20
    * @supported weapp, tt
    */
   maxScale?: number
 
   /** 标记点
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   markers?: MapProps.marker[]
 
   /** 标记点
-   * @deprecated 即将移除，请使用 markers
    * @supported weapp
    */
   covers?: any[]
 
   /** 路线
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   polyline?: MapProps.polyline[]
 
   /** 圆
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   circles?: MapProps.circle[]
 
   /** 控件（即将废弃，建议使用 cover-view 代替）
    * @deprecated
-   * @supported weapp, swan, alipay
+   * @supported weapp, alipay, swan, jd
    */
   controls?: MapProps.control[]
 
   /** 缩放视野以包含所有给定的坐标点
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   includePoints?: MapProps.point[]
 
   /** 显示带有方向的当前定位点
    * @default false
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   showLocation?: boolean
 
   /** 多边形
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, swan, tt, qq
    */
   polygons?: MapProps.polygon[]
 
   /** 个性化地图使用的 key
-   * @supported weapp
+   * @supported weapp, qq
    */
   subkey?: string
 
   /** 个性化地图配置的 style，不支持动态修改
    * @default 1
-   * @supported weapp
+   * @supported weapp, qq
    */
   layerStyle?: number
 
   /** 旋转角度，范围 0 ~ 360, 地图正北和设备 y 轴角度的夹角
    * @default 0
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt, qq
    */
   rotate?: number
 
   /** 倾斜角度，范围 0 ~ 40 , 关于 z 轴的倾角
    * @default 0
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt, qq
    */
   skew?: number
 
-  /** 展示 3D 楼块
-   * @default false
-   * @supported weapp, swan, tt
-   */
-  enable3D?: boolean
-
   /** 显示指南针
    * @default false
-   * @supported weapp, swan, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   showCompass?: boolean
 
   /** 显示比例尺
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt, qq
    */
   showScale?: boolean
 
   /** 开启俯视
    * @default false
-   * @supported weapp, swan, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   enableOverlooking?: boolean
 
   /** 是否支持缩放
    * @default true
-   * @supported weapp, swan, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   enableZoom?: boolean
 
   /** 是否支持拖动
    * @default true
-   * @supported weapp, swan, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   enableScroll?: boolean
 
   /** 是否支持旋转
    * @default false
-   * @supported weapp, swan, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   enableRotate?: boolean
 
   /** 是否开启卫星图
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt, qq
    */
   enableSatellite?: boolean
 
   /** 是否开启实时路况
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt, qq
    */
   enableTraffic?: boolean
 
   /** 配置项
    *
    * 提供 setting 对象统一设置地图配置。同时对于一些动画属性如 rotate 和 skew，通过 setData 分开设置时无法同时生效，需通过 settting 统一修改。
-   * @supported weapp, alipay
+   * @supported weapp, alipay, qq
    */
-  setting?: MapProps | { [key: string]: number | string | any }
+  setting?:
+    | MapProps
+    | {
+        [key: string]: number | string | any
+      }
 
   /** 点击地图时触发
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTap?: CommonEventFunction
 
   /** 点击标记点时触发，e.detail = {markerId}
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onMarkerTap?: CommonEventFunction<MapProps.onMarkerTapEventDetail>
 
@@ -174,34 +171,38 @@ interface MapProps extends StandardProps {
   onLabelTap?: CommonEventFunction<MapProps.onLabelTapEventDetail>
 
   /** 点击控件时触发，e.detail = {controlId}
-   * @supported weapp, swan, alipay
+   * @supported weapp, alipay, swan, jd
    */
   onControlTap?: CommonEventFunction<MapProps.onControlTapEventDetail>
 
   /** 点击标记点对应的气泡时触发，e.detail = {markerId}
-   * @supported weapp, swan, alipay, tt
+   * @supported alipay
    */
   onCalloutTap?: CommonEventFunction<MapProps.onCalloutTapEventDetail>
 
   /** 在地图渲染更新完成时触发
-   * @supported weapp, swan, tt
+   * @supported weapp, swan, tt, qq
    */
   onUpdated?: CommonEventFunction
 
   /** 视野发生变化时触发
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
-  onRegionChange?: CommonEventFunction<MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>>
+  onRegionChange?: CommonEventFunction<
+    MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>
+  >
 
   /** 点击地图poi点时触发，e.detail = {name, longitude, latitude}
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   onPoiTap?: CommonEventFunction<MapProps.onPoiTapEventDetail>
 
   /** 视野在地图 padding 范围内展示
    * @supported alipay
    */
-  includePadding?: { [key in ('left' | 'right' | 'top' | 'bottom')]: number | string }
+  includePadding?: {
+    [key in 'left' | 'right' | 'top' | 'bottom']: number | string
+  }
 
   /** 覆盖物，自定义贴图
    * @supported alipay
@@ -213,12 +214,98 @@ interface MapProps extends StandardProps {
    */
   tileOverlay?: any[]
 
-  /** 开启 optimize 模式后，无需再监听 onRegionChange 来获取并设置新的 scale 值以保证地图不会再回到原来的缩放比例。
+  /** 是否展示 POI 点
+   * @supported weapp, alipay, tt
+   */
+  enablePoi?: string
+
+  /** 是否展示建筑物
+   * @supported weapp, alipay, tt
+   */
+  enableBuilding?: string
+
+  /** 点击标记点对应的气泡时触发e.detail = {markerId}
+   * @supported weapp, swan, tt, jd
+   */
+  onCallOutTap?: CommonEventFunction
+
+  /** 点击定位标时触发，e.detail = {longitude, latitude}
+   * @supported weapp, tt
+   */
+  onAnchorPointTap?: CommonEventFunction
+
+  /** 内联样式。
    * @supported alipay
    */
-  optimize?: boolean
-}
+  style?: string
+
+  /** 样式名。
+   * @supported alipay
+   */
+  class?: string
+
+  /** 覆盖物，多边形。
+   *
+   * 版本要求：基础库 1.10.0 及以上
+   * @supported alipay
+   */
+  polygon?: string
+
+  /** 设置地图样式。
+   *
+   * default：默认样式
+   * light：精简样式
+   *
+   * 版本要求：基础库 1.20.0 及以上
+   * @supported alipay
+   */
+  customMapStyle?: string
+
+  /** 基于 map 高级定制渲染，设置覆盖在地图上的 view。
+   *
+   * 版本要求：基础库 1.23.0 及以上
+   * @supported alipay
+   */
+  panels?: string
+
+  /** 点击 panel 时触发。
+   *
+   * {
+   *
+   *    panelId,
+   *
+   *    layoutId,
+   *
+   * }
+   *
+   * 版本要求：基础库 1.23.0 及以上
+   * @supported alipay
+   */
+  onPanelTap?: CommonEventFunction
+
+  /** 地图初始化完成即将开始渲染第一帧时触发。
+   *
+   * 版本要求：基础库 2.7.2 及以上
+   * @supported alipay
+   */
+  onInitComplete?: CommonEventFunction
 
+  /** 否
+   * @supported jd
+   */
+  theme?: string
+
+  /** 内联样式。
+   * @supported alipay
+   */
+  optimize?: string
+
+  /** 展示3D楼块
+   * @supported weapp, swan, tt, qq
+   * @default false
+   */
+  enable3D?: string
+}
 declare namespace MapProps {
   /** 标记点用于在地图上显示标记的位置 */
   interface marker {
@@ -226,53 +313,66 @@ declare namespace MapProps {
      * @remarks marker 点击事件回调会返回此id。建议为每个 marker 设置上 Number 类型 id，保证更新 marker 时有更好的性能。
      */
     id?: number
+
     /** 纬度
      * @remarks 浮点数，范围 -90 ~ 90
      */
     latitude: number
+
     /** 经度
      * @remarks 浮点数，范围 -180 ~ 180
      */
     longitude: number
+
     /** 标注点名
      * @remarks 点击时显示，callout 存在时将被忽略
      */
     title?: string
+
     /** 显示层级
      */
     zIndex?: number
+
     /** 显示的图标
      * @remarks 项目目录下的图片路径，支持相对路径写法，以'/'开头则表示相对小程序根目录；也支持临时路径和网络图片
      */
     iconPath: string
+
     /** 旋转角度
      * @remarks 顺时针旋转的角度，范围 0 ~ 360，默认为 0
      */
     rotate?: number
+
     /** 标注的透明度
      * @remarks 默认1，无透明，范围 0 ~ 1
      */
     alpha?: number
+
     /** 标注图标宽度
      * @remarks 默认为图片实际宽度
      */
     width?: number | string
+
     /** 标注图标高度
      * @remarks 默认为图片实际高度
      */
     height?: number | string
+
     /** 标记点上方的气泡窗口
      * @remarks 支持的属性见下表，可识别换行符。
      */
     callout?: callout
+
     /** 自定义气泡窗口
      * @remarks 支持的属性见下表，可识别换行符。
      */
     customCallout?: customCallout
+
     /** 为标记点旁边增加标签
      * @remarks 支持的属性见下表
      */
     label?: label
+
     /** 经纬度在标注图标的锚点，默认底边中点
      * @remarks {x, y}，x表示横向(0-1)，y表示竖向(0-1)。{x: .5, y: 1} 表示底边中点
      */
@@ -280,6 +380,7 @@ declare namespace MapProps {
       x: number
       y: number
     }
+
     /** 无障碍访问，（属性）元素的额外描述 */
     ariaLabel?: string
   }
@@ -288,26 +389,37 @@ declare namespace MapProps {
   interface callout {
     /** 文本 */
     content: string
+
     /** 文本颜色 */
     color: string
+
     /** 文字大小 */
     fontSize: number
+
     /** 横向偏移量，向右为正数 */
     anchorX: number
+
     /** 纵向偏移量，向下为正数 */
     anchorY: number
+
     /** 边框圆角 */
     borderRadius: number
+
     /** 边框宽度 */
     borderWidth: number
+
     /** 边框颜色 */
     borderColor: string
+
     /** 背景色 */
     bgColor: string
+
     /** 文本边缘留白 */
     padding: number
+
     /** 'BYCLICK':点击显示; 'ALWAYS':常显 */
     display: 'BYCLICK' | 'ALWAYS'
+
     /** 文本对齐方式。有效值: left, right, center */
     textAlign: 'left' | 'right' | 'center'
   }
@@ -319,8 +431,10 @@ declare namespace MapProps {
   interface customCallout {
     /** 'BYCLICK':点击显示; 'ALWAYS':常显 */
     display: 'BYCLICK' | 'ALWAYS' | string
+
     /** 横向偏移量，向右为正数 */
     anchorX: number
+
     /** 纵向偏移量，向下为正数 */
     anchorY: number
   }
@@ -329,32 +443,34 @@ declare namespace MapProps {
   interface label {
     /** 文本 */
     content: string
+
     /** 文本颜色 */
     color: string
+
     /** 文字大小 */
     fontSize: number
-    /** label的坐标（废弃）
-     * @deprecated
-     */
-    x: number
-    /** label的坐标（废弃）
-     * @deprecated
-     */
-    y: number
+
     /** label的坐标，原点是 marker 对应的经纬度 */
     anchorX: number
+
     /** label的坐标，原点是 marker 对应的经纬度 */
     anchorY: number
+
     /** 边框宽度 */
     borderWidth: number
+
     /** 边框颜色 */
     borderColor: string
+
     /** 边框圆角 */
     borderRadius: number
+
     /** 背景色 */
     bgColor: string
+
     /** 文本边缘留白 */
     padding: number
+
     /** 文本对齐方式。有效值: left, right, center */
     textAlign: 'left' | 'right' | 'center'
   }
@@ -365,26 +481,33 @@ declare namespace MapProps {
      * @remarks [{latitude: 0, longitude: 0}]
      */
     points: point[]
+
     /** 线的颜色
      * @remarks 十六进制
      */
     color?: string
+
     /** 线的宽度 */
     width?: number
+
     /** 是否虚线
      * @remarks 默认 false
      */
     dottedLine?: boolean
+
     /** 带箭头的线
      * @remarks 默认 false，开发者工具暂不支持该属性
      */
     arrowLine?: boolean
+
     /** 更换箭头图标
      * @remarks 在 arrowLine 为 true 时生效
      */
     arrowIconPath?: string
+
     /** 线的边框颜色 */
     borderColor?: string
+
     /** 线的厚度 */
     borderWidth?: number
   }
@@ -395,16 +518,20 @@ declare namespace MapProps {
      * @remarks [{latitude: 0, longitude: 0}]
      */
     points: point[]
+
     /** 描边的宽度 */
     strokeWidth?: number
+
     /** 描边的颜色
      * @remarks 十六进制
      */
     strokeColor?: string
+
     /** 填充颜色
      * @remarks 十六进制
      */
     fillColor?: string
+
     /** 设置多边形Z轴数值 */
     zIndex?: number
   }
@@ -415,20 +542,25 @@ declare namespace MapProps {
      * @remarks 浮点数，范围 -90 ~ 90
      */
     latitude: number
+
     /** 经度
      * @remarks 浮点数，范围 -180 ~ 180
      */
     longitude?: number
+
     /** 描边的颜色
      * @remarks 十六进制
      */
     color?: string
+
     /** 填充颜色
      * @remarks 十六进制
      */
     fillColor?: string
+
     /** 半径 */
     radius: number
+
     /** 描边的宽度 */
     strokeWidth?: number
   }
@@ -441,46 +573,50 @@ declare namespace MapProps {
      * @remarks 在控件点击事件回调会返回此id
      */
     id?: number
+
     /** 控件在地图的位置
      * @remarks 控件相对地图位置
      */
     position: position
+
     /** 显示的图标
      * @remarks 项目目录下的图片路径，支持本地路径、代码包路径
      */
     iconPath: string
+
     /** 是否可点击
      * @remarks 默认不可点击
      */
     clickable?: boolean
   }
-
   interface point {
     /** 经度 */
     longitude: number
+
     /** 纬度 */
     latitude: number
   }
-
   interface position {
     /** 距离地图的左边界多远
      * @default 0
      */
     left: number
+
     /** 距离地图的上边界多远
      * @default 0
      */
     top: number
+
     /** 控件宽度
      * @default 图片宽度
      */
     width: number
+
     /** 控件高度
      * @default 图片宽度
      */
     height: number
   }
-
   interface onMarkerTapEventDetail {
     markerId: number | string
   }
@@ -493,25 +629,25 @@ declare namespace MapProps {
   interface onCalloutTapEventDetail {
     markerId: number | string
   }
-
   namespace RegionChangeDetail {
     interface type {
       begin
       end
     }
-
     interface CausedByBegin {
       /** 手势触发 */
       gesture
+
       /** 接口触发 */
       update
     }
-
     interface CausedByEnd {
       /** 拖动导致 */
       drag
+
       /** 缩放导致 */
       scale
+
       /** 调用更新接口导致 */
       update
     }
@@ -521,19 +657,26 @@ declare namespace MapProps {
      * @remarks 视野变化开始为begin，结束为end
      */
     type: T
+
     /** 导致视野变化的原因
      * @remarks 有效值为 gesture（手势触发）、update（接口触发或调用更新接口导致）、drag（拖动导致）、scale（缩放导致）
      */
-    causedBy: keyof (T extends 'begin' ? RegionChangeDetail.CausedByBegin : RegionChangeDetail.CausedByEnd)
+    causedBy: keyof (T extends 'begin'
+      ? RegionChangeDetail.CausedByBegin
+      : RegionChangeDetail.CausedByEnd)
+
     /** 视野改变详情 */
     detail: regionChangeDetail<RegionChangeDetail.type>
   }
   interface regionChangeDetail<T = keyof RegionChangeDetail.type> {
     /** 旋转角度 */
     rotate: number
+
     /** 倾斜角度 */
     skew: number
-    causedBy: keyof (T extends 'begin' ? RegionChangeDetail.CausedByBegin : RegionChangeDetail.CausedByEnd)
+    causedBy: keyof (T extends 'begin'
+      ? RegionChangeDetail.CausedByBegin
+      : RegionChangeDetail.CausedByEnd)
     type: T | string
     scale: number
     centerLocation: point
@@ -620,5 +763,4 @@ declare namespace MapProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/map.html#map
  */
 declare const Map: ComponentType<MapProps>
-
 export { Map, MapProps }