com.tencent.map.sdk.utilities.visualization.aggregation

## 类 AggregationOverlayProvider

- java.lang.Object
- - com.tencent.map.sdk.utilities.visualization.BaseOverlayProvider
  - - com.tencent.map.sdk.utilities.visualization.aggregation.AggregationOverlayProvider

- 所有已实现的接口:
    VectorOverlayProvider
  直接已知子类:
    HoneyCombVectorOverlayProvider, SquareVectorOverlayProvider

      public abstract class AggregationOverlayProvider
      extends BaseOverlayProvider

  聚合覆盖物提供器
  从以下版本开始:
    2020/8/17

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `protected static class` | `AggregationOverlayProvider.AggregationOverlayType` 支持的热力图展示类型

  - ### 字段概要

    - ### 从类继承的字段 com.tencent.map.sdk.utilities.visualization.BaseOverlayProvider

      `mClickEnabled, mDisplayLevel, mMaxZoom, mMinZoom, mOpacity, mVisibility, mZIndex, onVectorOverlayClickListener, onVectorOverlayLoadlistener`

  - ### 构造器概要

    构造器
    构造器和说明
    `AggregationOverlayProvider()`

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `AggregationOverlayProvider` | `colors(int[] colors, double[] startPoints)` 蜂窝颜色配置数组 用法说明： colors数组与startPoints数组配合使用。
    `AggregationOverlayProvider` | `displayLevel(int displayLevel)` 设置修改显示Level，用于控制Overlay与POI的显示层级关系。
    `AggregationOverlayProvider` | `enable3D(boolean enable3D)` 设置2D/3D蜂窝热力图开关
    `AggregationOverlayProvider` | `gap(float gap)` 设置热力格子之间的间距
    `int` | `getAnimateDuration()`
    `int[]` | `getColors()`
    `int` | `getDisplayLevel()` 图层展示级别
    `float` | `getGap()`
    `LatLng` | `getGeoReferencePoint()`
    `double` | `getMaxHeight()`
    `double` | `getMaxIntensity()`
    `int` | `getMaxZoom()` 获得最大可显示级别
    `double` | `getMinHeight()`
    `double` | `getMinIntensity()`
    `int` | `getMinZoom()` 获得最小可显示级别
    `WeightedLatLng[]` | `getNodes()`
    `float` | `getOpacity()` 获得整体透明度
    `boolean` | `getRangeFlag()`
    `float` | `getSize()`
    `double[]` | `getStartPoints()`
    `int` | `getType()` 获得聚合类型值
    `int` | `getZIndex()` zIndex
    `boolean` | `isAnimate()`
    `boolean` | `isEnable3D()`
    `boolean` | `isVisibility()` 获得显隐状态
    `AggregationOverlayProvider` | `nodes(WeightedLatLng[] nodes)` 热力数据
    `AggregationOverlayProvider` | `opacity(float opacity)` 设置透明度
    `AggregationOverlayProvider` | `setAnimateDuration(int animateDuration)` 设置动画执行时间
    `void` | `setGeoReferencePoint(LatLng mGeoReferencePoint)` 设置地理基准点, 会用于米到墨卡托单位的转换。
    `AggregationOverlayProvider` | `setHeightRange(double minHeight, double maxHeight)` 设置蜂窝高度范围
    `AggregationOverlayProvider` | `setIntensityRange(double minIntensity, double maxIntensity)` 设置蜂窝热力值范围
    `AggregationOverlayProvider` | `size(float size)` 设置热力格子尺寸
    `protected AggregationOverlayProvider` | `type(AggregationOverlayProvider.AggregationOverlayType type)` 设置热力图类型
    `AggregationOverlayProvider` | `visibility(boolean visibility)` 是否可见
    `AggregationOverlayProvider` | `zIndex(int zIndex)` 设置z轴层级
    `AggregationOverlayProvider` | `zoomRange(int minZoom, int maxZoom)` 设置显示级别范围

    - ### 从类继承的方法 com.tencent.map.sdk.utilities.visualization.BaseOverlayProvider

      `enableClick, getOnVectorOverlayClickListener, getVectorOverlayLoadedListener, isClickEnabled, maxZoom, minZoom, setVectorOverlayClickListener, setVectorOverlayLoadedListener, toString`

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### 构造器详细资料

    - #### AggregationOverlayProvider

          public AggregationOverlayProvider()

  - ### 方法详细资料

    - #### type

          protected AggregationOverlayProvider type(AggregationOverlayProvider.AggregationOverlayType type)

      设置热力图类型
      参数:
        `type` - 目前支持 `AggregationOverlayProvider.AggregationOverlayType` 中的类型
      返回:
        更新之后的Provider

    - #### nodes

          public AggregationOverlayProvider nodes(WeightedLatLng[] nodes)

      热力数据
      参数:
        `nodes` - 热力点坐标数据，不能为空
      返回:
        更新之后的Provider

    - #### size

          public AggregationOverlayProvider size(float size)

      设置热力格子尺寸
      参数:
        `size` - 热力单元的宽度（内切圆的直径） 单位：米
        使用size+gap来计算热力。 size: 左右两端边框的距离，gap: 两个框之间的间隔 默认 2000 最小 10, 最大不设限制
      返回:
        更新之后的Provider

    - #### gap

          public AggregationOverlayProvider gap(float gap)

      设置热力格子之间的间距
      参数:
        `gap` - 边框之间的间隔 单位：米
        使用size+gap来计算热力。 size: 左右两端 边框的距离，gap: 两个框之间的间隔
      返回:
        更新之后的Provider

    - #### getOpacity

          public float getOpacity()

      从接口复制的说明: `VectorOverlayProvider`
      获得整体透明度
      指定者:
        `getOpacity` 在接口中 `VectorOverlayProvider`
      覆盖:
        `getOpacity` 在类中 `BaseOverlayProvider`
      返回:
        透明度值 [0-1]

    - #### opacity

          public AggregationOverlayProvider opacity(float opacity)

      设置透明度
      指定者:
        `opacity` 在接口中 `VectorOverlayProvider`
      覆盖:
        `opacity` 在类中 `BaseOverlayProvider`
      参数:
        `opacity` - 透明度，取值范围[0, 1]
        默认为1。 大于1时,设为1; 小于0时, 设为0.
      返回:
        更新之后的Provider

    - #### getZIndex

          public int getZIndex()

      从接口复制的说明: `VectorOverlayProvider`
      zIndex
      指定者:
        `getZIndex` 在接口中 `VectorOverlayProvider`
      覆盖:
        `getZIndex` 在类中 `BaseOverlayProvider`
      返回:
        zIndex

    - #### zIndex

          public AggregationOverlayProvider zIndex(int zIndex)

      设置z轴层级
      指定者:
        `zIndex` 在接口中 `VectorOverlayProvider`
      覆盖:
        `zIndex` 在类中 `BaseOverlayProvider`
      参数:
        `zIndex` - z轴层级 仅限于2D图层使用 默认： 0
        设置相同显示Level下的 `displayLevel(int)`} 的堆叠顺序，相同显示level，zIndex越大越靠上显示 level优先级大于zIndex
      返回:
        更新之后的Provider

    - #### getDisplayLevel

          public int getDisplayLevel()

      从接口复制的说明: `VectorOverlayProvider`
      图层展示级别
      指定者:
        `getDisplayLevel` 在接口中 `VectorOverlayProvider`
      覆盖:
        `getDisplayLevel` 在类中 `BaseOverlayProvider`
      返回:
        显示级别

    - #### displayLevel

          public AggregationOverlayProvider displayLevel(int displayLevel)

      设置修改显示Level，用于控制Overlay与POI的显示层级关系。
      指定者:
        `displayLevel` 在接口中 `VectorOverlayProvider`
      覆盖:
        `displayLevel` 在类中 `BaseOverlayProvider`
      参数:
        `displayLevel` - 默认层级为POI之下 `OverlayLevel.OverlayLevelAboveBuildings`
        相同Level内的显示层级关系通过`zIndex(int)`来控制，zIndex越大越靠上显示。 Level优先级高于zIndex displayLevel必须为如下值之一，否则不生效

        `OverlayLevel.OverlayLevelAboveBuildings`

        `OverlayLevel.OverlayLevelAboveLabels`

      返回:
        更新之后的Provider

    - #### isVisibility

          public boolean isVisibility()

      从接口复制的说明: `VectorOverlayProvider`
      获得显隐状态
      指定者:
        `isVisibility` 在接口中 `VectorOverlayProvider`
      覆盖:
        `isVisibility` 在类中 `BaseOverlayProvider`
      返回:
        显隐状态

    - #### visibility

          public AggregationOverlayProvider visibility(boolean visibility)

      是否可见
      指定者:
        `visibility` 在接口中 `VectorOverlayProvider`
      覆盖:
        `visibility` 在类中 `BaseOverlayProvider`
      参数:
        `visibility` - `true` 可见，否则不可见。
      返回:
        更新之后的Provider

    - #### getMinZoom

          public int getMinZoom()

      从接口复制的说明: `VectorOverlayProvider`
      获得最小可显示级别
      指定者:
        `getMinZoom` 在接口中 `VectorOverlayProvider`
      覆盖:
        `getMinZoom` 在类中 `BaseOverlayProvider`
      返回:
        最小可显示级别

    - #### getMaxZoom

          public int getMaxZoom()

      从接口复制的说明: `VectorOverlayProvider`
      获得最大可显示级别
      指定者:
        `getMaxZoom` 在接口中 `VectorOverlayProvider`
      覆盖:
        `getMaxZoom` 在类中 `BaseOverlayProvider`
      返回:
        最大可显示级别

    - #### zoomRange

          public AggregationOverlayProvider zoomRange(int minZoom,
                                                      int maxZoom)

      设置显示级别范围
      参数:
        `minZoom` - 取值大于等于4, 小于4时设为4
        默认为 4
        `maxZoom` - 取值小于等于22,大于22时设为22
        默认为 22
      返回:
        更新之后的Provider

    - #### colors

          public AggregationOverlayProvider colors(int[] colors,
                                                   double[] startPoints)

      蜂窝颜色配置数组

      用法说明：
      colors数组与startPoints数组配合使用。 注意：colors 和 startPoints两数组长度必须一致且不能为0。 colors数组中有3种颜色。 startPoints [0, 0.6, 0.8] 表示在3个区间分别显示3种颜色。 当在区间[0,0.6)使用第一个颜色，区间[0.6，0.8)使用第二个颜色， 区间[0.8, 1]使用第三个颜色。 startPoints首位需设置成0

      参数:
        `colors` - 颜色值数组
        `startPoints` - 颜色变化起点，需为递增数组，每个元素代表权重的一个节点(此节点为显示颜色的切换点)
      返回:
        更新之后的Provider

    - #### setHeightRange

          public AggregationOverlayProvider setHeightRange(double minHeight,
                                                           double maxHeight)

      设置蜂窝高度范围
      参数:
        `minHeight` - 最小高度 默认0
        `maxHeight` - 最大高度 默认100
        单位：蜂窝格子边长size的百分比比例 100则代表高度是蜂窝边长的100%
      返回:
        更新之后的Provider

    - #### setIntensityRange

          public AggregationOverlayProvider setIntensityRange(double minIntensity,
                                                              double maxIntensity)

      设置蜂窝热力值范围
      参数:
        `minIntensity` - 最小热力值 默认0
        小于最小热力值的热力点不参与计算
        `maxIntensity` - 最大热力值 默认2000
        大于最大热力值的热力点,其权重计算以最大热力值为准 如果不设置热力值范围, 则最小热力值为0, 最大热力值为数据源中的最大值。
      返回:
        更新之后的Provider

    - #### enable3D

          public AggregationOverlayProvider enable3D(boolean enable3D)

      设置2D/3D蜂窝热力图开关
      参数:
        `enable3D` - `true` 为3D蜂窝图，否则为2D蜂窝图。
        默认为false
      返回:
        更新之后的Provider

    - #### isEnable3D

          public boolean isEnable3D()

    - #### getGeoReferencePoint

          public LatLng getGeoReferencePoint()

    - #### setGeoReferencePoint

          public void setGeoReferencePoint(LatLng mGeoReferencePoint)

      设置地理基准点, 会用于米到墨卡托单位的转换。如果不设置则默认会使用nodes数据集的中心点
      参数:
        `mGeoReferencePoint` -

    - #### setAnimateDuration

          public AggregationOverlayProvider setAnimateDuration(int animateDuration)

      设置动画执行时间
      参数:
        `animateDuration` - 单位:ms 取值大于等于0, 等于0时为无动画
        默认0ms
      返回:
        更新之后的Provider

    - #### getAnimateDuration

          public int getAnimateDuration()

    - #### getType

          public int getType()

      获得聚合类型值
      返回:
        类型值

    - #### getNodes

          public WeightedLatLng[] getNodes()

    - #### getSize

          public float getSize()

    - #### getGap

          public float getGap()

    - #### getColors

          public int[] getColors()

    - #### getStartPoints

          public double[] getStartPoints()

    - #### getMaxHeight

          public double getMaxHeight()

    - #### getMinHeight

          public double getMinHeight()

    - #### getMaxIntensity

          public double getMaxIntensity()

    - #### getMinIntensity

          public double getMinIntensity()

    - #### getRangeFlag

          public boolean getRangeFlag()

    - #### isAnimate

          public boolean isAnimate()