com.tencent.tencentmap.mapsdk.maps.model

## 类 PolygonOptions

- java.lang.Object
- - com.tencent.tencentmap.mapsdk.maps.model.PolygonOptions

-     public class PolygonOptions
      extends java.lang.Object

  设置多边形相关选项

- - ### 构造器概要

    构造器
    构造器和说明
    `PolygonOptions()` 构造PolygonOptions对象

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `PolygonOptions` | `add(LatLng... latLngs)` 向PolygonOptions添加顶点
    `PolygonOptions` | `add(LatLng latLng)` 向PolygonOptions添加顶点
    `PolygonOptions` | `add(java.util.List<LatLng> points)` 添加顶点坐标
    `PolygonOptions` | `addAll(java.lang.Iterable<LatLng> latLngs)` 向PolygonOptions添加顶点
    `PolygonOptions` | `clickable(boolean clickable)` 多边形是否支持点击
    `PolygonOptions` | `fillColor(int fillColor)` 设置PolygonOptions填充颜色
    `int` | `getFillColor()` 返回PolygonOptions对象的填充颜色
    `java.util.List<java.util.List<LatLng>>` | `getHolePoints()` 获取PolygonOptions 带洞顶点
    `int` | `getLevel()` 获取PolygonOptions的显示level
    `java.util.List<java.lang.Integer>` | `getPattern()` 获取虚线样式
    `java.util.List<LatLng>` | `getPoints()` 返回PolygonOptions对象的顶点坐标列表
    `int` | `getStrokeColor()` 返回PolygonOptions对象的描边颜色
    `float` | `getStrokeWidth()` 返回PolygonOptions对象的描边宽度
    `BitmapDescriptor` | `getTexture()` 获取纹理
    `int` | `getTextureSpacing()` 获取纹理间隔
    `float` | `getZIndex()` 返回PolygonOptions对象的堆叠顺序
    `boolean` | `isClickable()` 是否支持点击
    `boolean` | `isValid()`
    `boolean` | `isVisible()` 返回PolygonOptions对象的可见性
    `PolygonOptions` | `level(int level)` 设置Polygon的显示Level，level用于控制Polygon与楼块，道路，POI的显示层级关系。
    `PolygonOptions` | `pattern(java.util.List<java.lang.Integer> pattern)` 设置ARGB虚线的样式，与 `texture(BitmapDescriptor)` 互斥
    `PolygonOptions` | `setHolePoints(java.util.List<java.util.List<LatLng>> holePoints)` 设置PolygonOptions 带洞顶点
    `void` | `setPoints(java.lang.Iterable<LatLng> points)` 设置PolygonOptions顶点
    `PolygonOptions` | `strokeColor(int strokeColor)` 设置PolygonOptions描边颜色, 与 `texture(BitmapDescriptor)` 互斥
    `PolygonOptions` | `strokeWidth(float strokeWidth)` 设置PolygonOptions描边宽度
    `PolygonOptions` | `texture(BitmapDescriptor texture)` 设置纹理图片，这个纹理会重复地绘填充到线上，同时用户应配置纹理间隔 `textureSpacing(int)`， 与 `strokeColor(int)`、`pattern(List)`两个配置互斥，这三个接口最后调用的会生效
    `PolygonOptions` | `textureSpacing(int textureSpacing)` 纹理间隔
    `PolygonOptions` | `visible(boolean flag)` 设置折线可见性
    `PolygonOptions` | `zIndex(int zIndex)` 设置相同显示Level `level(int)` 的多边形堆叠顺序，相同显示level，zIndex越大越靠上显示 level优先级大于zIndex

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

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

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

    - #### PolygonOptions

          public PolygonOptions()

      构造PolygonOptions对象

  - ### 方法详细资料

    - #### setPoints

          public void setPoints(java.lang.Iterable<LatLng> points)

      设置PolygonOptions顶点
      参数:
        `points` - PolygonOptions顶点坐标

    - #### add

          public PolygonOptions add(LatLng latLng)

      向PolygonOptions添加顶点
      参数:
        `latLng` - 将该坐标添加到PolygonOptions顶点列表末尾
      返回:
        设置顶点后的PolygonOptions

    - #### add

          public PolygonOptions add(LatLng... latLngs)

      向PolygonOptions添加顶点
      参数:
        `latLngs` - 将该坐标集合添加到PolygonOptions顶点列表末尾
      返回:
        添加顶点后的PolygonOptions

    - #### add

          public PolygonOptions add(java.util.List<LatLng> points)

      添加顶点坐标
      参数:
        `points` - 定点坐标
      返回:
        多边形属性对象

    - #### addAll

          public PolygonOptions addAll(java.lang.Iterable<LatLng> latLngs)

      向PolygonOptions添加顶点
      参数:
        `latLngs` - 将该坐标集合添加到PolygonOptions顶点列表末尾
      返回:
        添加顶点后的PolygonOptions

    - #### setHolePoints

          public PolygonOptions setHolePoints(java.util.List<java.util.List<LatLng>> holePoints)

      设置PolygonOptions 带洞顶点
      参数:
        `holePoints` - 带洞顶点坐标

    - #### getHolePoints

          public java.util.List<java.util.List<LatLng>> getHolePoints()

      获取PolygonOptions 带洞顶点
      返回:
        带洞顶点坐标

    - #### strokeWidth

          public PolygonOptions strokeWidth(float strokeWidth)

      设置PolygonOptions描边宽度
      参数:
        `strokeWidth` - PolygonOptions描边宽度，单位（px）
      返回:
        设置描边宽度后的PolygonOptions

    - #### strokeColor

          public PolygonOptions strokeColor(int strokeColor)

      设置PolygonOptions描边颜色, 与 `texture(BitmapDescriptor)` 互斥
      参数:
        `strokeColor` - 设置PolygonOptions的32-bit ARGB描边颜色
      返回:
        设置描边颜色后的PolygonOptions

    - #### fillColor

          public PolygonOptions fillColor(int fillColor)

      设置PolygonOptions填充颜色
      参数:
        `fillColor` - 设置PolygonOptions的32-bit ARGB填充颜色
      返回:
        设置填充颜色后的PolygonOptions

    - #### zIndex

          public PolygonOptions zIndex(int zIndex)

      设置相同显示Level `level(int)` 的多边形堆叠顺序，相同显示level，zIndex越大越靠上显示 level优先级大于zIndex
      参数:
        `zIndex` - 设置PolygonOptions的堆叠顺序
      返回:
        设置堆叠顺序后的PolygonOptions

    - #### visible

          public PolygonOptions visible(boolean flag)

      设置折线可见性
      参数:
        `flag` - 设置PolygonOptions的可见性 true 可见 false 隐藏
      返回:
        设置可见性后的PolygonOptions

    - #### clickable

          public PolygonOptions clickable(boolean clickable)

      多边形是否支持点击
      参数:
        `clickable` -
      返回:

    - #### getPoints

          public java.util.List<LatLng> getPoints()

      返回PolygonOptions对象的顶点坐标列表
      返回:
        折线的顶点坐标列表

    - #### getStrokeWidth

          public float getStrokeWidth()

      返回PolygonOptions对象的描边宽度
      返回:
        PolygonOptions的描边宽度, 单位（px）

    - #### getStrokeColor

          public int getStrokeColor()

      返回PolygonOptions对象的描边颜色
      返回:
        PolygonOptions的32-bit ARGB描边颜色

    - #### getFillColor

          public int getFillColor()

      返回PolygonOptions对象的填充颜色
      返回:
        PolygonOptions的32-bit ARGB填充颜色

    - #### getZIndex

          public float getZIndex()

      返回PolygonOptions对象的堆叠顺序
      返回:
        PolygonOptions的堆叠顺序

    - #### isVisible

          public boolean isVisible()

      返回PolygonOptions对象的可见性
      返回:
        true 可见 false 隐藏

    - #### isClickable

          public boolean isClickable()

      是否支持点击

    - #### level

          public PolygonOptions level(int level)

      设置Polygon的显示Level，level用于控制Polygon与楼块，道路，POI的显示层级关系。 默认为`OverlayLevel.OverlayLevelAboveLabels` POI之上 相同Level内的显示层级关系通过`zIndex(int)`来控制，zIndex越大越靠上显示。 Level优先级高于zIndex
      参数:
        `level` - 必须为如下值之一，否则不生效

        `OverlayLevel.OverlayLevelAboveRoads`

        `OverlayLevel.OverlayLevelAboveBuildings`

        `OverlayLevel.OverlayLevelAboveLabels`

      返回:

    - #### getLevel

          public int getLevel()

      获取PolygonOptions的显示level
      返回:

    - #### isValid

          public boolean isValid()

    - #### getPattern

          public java.util.List<java.lang.Integer> getPattern()

      获取虚线样式
      返回:

    - #### pattern

          public PolygonOptions pattern(java.util.List<java.lang.Integer> pattern)

      设置ARGB虚线的样式，与 `texture(BitmapDescriptor)` 互斥
      参数:
        `pattern` - pattern的元素数量必须是偶数个，每对元素分别表示虚线中实线区域的长度，以及空白区域的长度（单位px)
      返回:

    - #### getTexture

          public BitmapDescriptor getTexture()

      获取纹理
      返回:

    - #### texture

          public PolygonOptions texture(BitmapDescriptor texture)

      设置纹理图片，这个纹理会重复地绘填充到线上，同时用户应配置纹理间隔 `textureSpacing(int)`， 与 `strokeColor(int)`、`pattern(List)`两个配置互斥，这三个接口最后调用的会生效
      参数:
        `texture` -
      返回:

    - #### getTextureSpacing

          public int getTextureSpacing()

      获取纹理间隔
      返回:

    - #### textureSpacing

          public PolygonOptions textureSpacing(int textureSpacing)

      纹理间隔
      参数:
        `textureSpacing` - 纹理之间的间隔，单位：像素
      返回: