com.tencent.map.sdk.utilities.visualization.trails

## 类 TrailOverlayProvider

- java.lang.Object
- - com.tencent.map.sdk.utilities.visualization.BaseOverlayProvider
  - - com.tencent.map.sdk.utilities.visualization.trails.TrailOverlayProvider

- 所有已实现的接口:
    VectorOverlayProvider

      public final class TrailOverlayProvider
      extends BaseOverlayProvider

  All rights Reserved, Designed By lbs.qq.com

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `TrailOverlayProvider.TrailOverlayType` 支持的轨迹图层展示类型

  - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `protected int` | `mColorMapSize`

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

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

  - ### 构造器概要

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

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `TrailOverlayProvider` | `data(java.util.List<TrailLatLng> val)` 轨迹线数据
    `TrailOverlayProvider` | `displayLevel(int displayLevel)` 设置修改显示Level，用于控制Overlay与POI的显示层级关系。
    `int` | `getAnimateEndTime()`
    `int` | `getAnimateStartTime()`
    `int` | `getColorMapSize()`
    `float[]` | `getColorPoints()`
    `int[]` | `getColors()`
    `java.util.List<TrailLatLng>` | `getData()`
    `int` | `getDisplayLevel()` 图层展示级别
    `int` | `getHighLightDuration()`
    `int` | `getMaxZoom()` 获得最大可显示级别
    `int` | `getMinZoom()` 获得最小可显示级别
    `float` | `getOpacity()` 获得整体透明度
    `float` | `getPlayRatio()`
    `int` | `getType()`
    `float` | `getWidth()`
    `int` | `getZIndex()` zIndex
    `TrailOverlayProvider` | `gradient(int[] colors)` 设置轨迹线渐变颜色 用法说明： 实现单色线, 则colors数组为A 实现A-B的渐变线, 则colors数组传入A, B 实现A-B-C的渐变线, 其中B为轨迹线中点, 则colors数组传入A, B, C
    `boolean` | `isVisibility()` 获得显隐状态
    `TrailOverlayProvider` | `opacity(float opacity)` 设置透明度
    `TrailOverlayProvider` | `setAnimateStartTime(int startTime, int endTime)` 设置动画开始、结束时间区间
    `TrailOverlayProvider` | `setHighlightDuration(int highlightDuration)` 设置动画高亮时间
    `TrailOverlayProvider` | `setPlayRatio(float playRatio)` 设置动画速率
    `TrailOverlayProvider` | `type(TrailOverlayProvider.TrailOverlayType type)` 设置轨迹图类型
    `TrailOverlayProvider` | `visibility(boolean visibility)` 是否可见
    `TrailOverlayProvider` | `width(float width)` 轨迹线宽度
    `TrailOverlayProvider` | `zIndex(int zIndex)` 设置z轴层级
    `TrailOverlayProvider` | `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`

- - ### 字段详细资料

    - #### mColorMapSize

          protected int mColorMapSize

  - ### 构造器详细资料

    - #### TrailOverlayProvider

          public TrailOverlayProvider()

  - ### 方法详细资料

    - #### type

          public TrailOverlayProvider type(TrailOverlayProvider.TrailOverlayType type)

      设置轨迹图类型
      参数:
        `type` - 目前支持 `TrailOverlayProvider.TrailOverlayType` 中的类型
      返回:
        更新之后的Provider

    - #### getType

          public int getType()

    - #### getData

          public java.util.List<TrailLatLng> getData()

    - #### data

          public TrailOverlayProvider data(java.util.List<TrailLatLng> val)

      轨迹线数据
      参数:
        `val` - 起终点坐标数据，不能为空
      返回:
        更新之后的Provider

    - #### getOpacity

          public float getOpacity()

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

    - #### opacity

          public TrailOverlayProvider 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 TrailOverlayProvider 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 TrailOverlayProvider 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 TrailOverlayProvider 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 TrailOverlayProvider zoomRange(int minZoom,
                                                int maxZoom)

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

    - #### gradient

          public TrailOverlayProvider gradient(int[] colors)

      设置轨迹线渐变颜色

      用法说明：
      实现单色线, 则colors数组为A 实现A-B的渐变线, 则colors数组传入A, B 实现A-B-C的渐变线, 其中B为轨迹线中点, 则colors数组传入A, B, C

      参数:
        `colors` - ARGB颜色值数组
        数组长度需大于0, 且最大长度为3.
      返回:
        更新之后的Provider

    - #### getColors

          public int[] getColors()

    - #### getColorPoints

          public float[] getColorPoints()

    - #### getColorMapSize

          public int getColorMapSize()

    - #### getWidth

          public float getWidth()

    - #### width

          public TrailOverlayProvider width(float width)

      轨迹线宽度
      参数:
        `width` - 单位：像素。 取值应大于0
        默认6像素
      返回:
        更新之后的Provider

    - #### setHighlightDuration

          public TrailOverlayProvider setHighlightDuration(int highlightDuration)

      设置动画高亮时间
      参数:
        `highlightDuration` - 单位:ms 取值大于0
        默认1000ms
      返回:
        更新之后的Provider

    - #### getHighLightDuration

          public int getHighLightDuration()

    - #### setAnimateStartTime

          public TrailOverlayProvider setAnimateStartTime(int startTime,
                                                          int endTime)

      设置动画开始、结束时间区间
      参数:
        `startTime` - 单位:ms 取值大于等于0
        默认0ms
        `endTime` - 单位:ms 取值大于0, 且endTime应大于startTime
        默认2000ms
      返回:
        更新之后的Provider

    - #### getAnimateStartTime

          public int getAnimateStartTime()

    - #### getAnimateEndTime

          public int getAnimateEndTime()

    - #### setPlayRatio

          public TrailOverlayProvider setPlayRatio(float playRatio)

      设置动画速率
      参数:
        `playRatio` - 单位:倍率 取值大于0
        默认1倍
      返回:
        更新之后的Provider

    - #### getPlayRatio

          public float getPlayRatio()