com.amap.api.maps.model

## 类 Polygon

- java.lang.Object
- - com.amap.api.maps.model.BaseOverlay
  - - com.amap.api.maps.model.Polygon

-     public final class Polygon
      extends BaseOverlay

  定义在地图上绘制多边形覆盖物。一个多边形可以凸面体，也可是凹面体。

  它有以下属性:

  - 边框

  一个多边开的边框由一系列的顺时针或逆时针顶点组成。边框不需要声明起点和终点一致。如果边框的起点与终点不一致，API会自动将它封闭。

  - 边框宽度

  边框的宽度以像素为单位，不会受可视区域缩放级别的影响。默认为10。

  - 边框颜色

  边框颜色是一个ARGB格式，ARGB请参考android.graphics.Color。默认为黑色。

  - 填充颜色

  填充颜色是一个ARGB格式，ARGB格式可参考android.graphics.Color。默认是透明的。如果多边形的几何图形不正确，则填充颜色不会被绘制。

  - Z轴

  Z轴是控制覆盖物重复区域的绘制顺序的值。Z轴较大的覆盖物会在绘制在Z轴较小的覆盖物上面。如果两个覆盖物的Z轴数值相同，则覆盖情况将随机。默认为0。

  - 可见性

  标示多边形是否可见。如果可见性为否，则不会被绘制。 多边形方法必须在主线程中调用，否则会抛出IllegalStateException。

Defines the drawing of polygon overlays on a map. A polygon can be convex or concave.

It has the following attributes:

- Border

The border of a polygon consists of a series of clockwise or counterclockwise vertices. The border does not need to declare that the start and end points are the same. If the start and end points of the border are not the same, the API will automatically close it.

- Border Width

The width of the border is in pixels and is not affected by the zoom level of the visible area. The default is 10.

- Border Color

The border color is in ARGB format, ARGB refers to android.graphics.Color. The default is black.

- Fill Color

The fill color is in ARGB format, ARGB format refers to android.graphics.Color. The default is transparent. If the geometry of the polygon is incorrect, the fill color will not be drawn.

- Z-axis

The Z-axis is a value that controls the drawing order of overlapping areas of overlays. Overlays with a larger Z-axis will be drawn on top of overlays with a smaller Z-axis. If two overlays have the same Z-axis value, the overlap will be random. The default is 0.

- Visibility

Indicates whether the polygon is visible. If visibility is false, it will not be drawn. Polygon methods must be called in the main thread, otherwise, an IllegalStateException will be thrown.

从以下版本开始:
  2.0

- - ### 字段概要

    - ### 从类继承的字段 com.amap.api.maps.model.BaseOverlay

      `Field1, Field2, overlayName`

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `boolean` | `contains(LatLng latLng)` 判断多边形是否包含传入的经纬度点。
    `boolean` | `equals(java.lang.Object paramObject)`
    `int` | `getFillColor()` 获取多边形的填充颜色 Get the fill color of the polygon
    `java.util.List` | `getHoleOptions()` 获取多边形空心洞的配置项集合 Get the configuration collection of polygon hollow holes
    `java.lang.String` | `getId()` 获取多边形的Id。
    `java.util.List<LatLng>` | `getPoints()` 获取多边形的顶点列表。
    `int` | `getStrokeColor()` 获取多边形的边框颜色 Get the border color of the polygon
    `int` | `getStrokeDottedLineType()` 获取多边形的边框虚线形状。
    `float` | `getStrokeWidth()` 获取多边形的边框宽度 Get the border width of the polygon
    `float` | `getZIndex()` 获取多边形的Z轴值 Get the Z-axis value of the polygon
    `int` | `hashCode()`
    `boolean` | `isVisible()` 获取多边形是否可见。
    `void` | `remove()` 从地图上删除当前多边形。
    `void` | `setFillColor(int color)` 设置多边形的填充颜色 Set the fill color of the polygon
    `void` | `setHoleOptions(java.util.List options)` 设置多边形空心洞的配置项集合 Set the configuration collection of polygon hollow holes
    `void` | `setPoints(java.util.List<LatLng> points)` 设置多边形的顶点。
    `void` | `setStrokeColor(int color)` 设置多边形的边框颜色 Set the border color of the polygon
    `void` | `setStrokeDottedLineType(int type)` 设置多边形的边框虚线形状。
    `void` | `setStrokeWidth(float width)` 设置多边形的边框宽度 Set the border width of the polygon
    `void` | `setVisible(boolean visible)` 设置多边形的可见属性。
    `void` | `setZIndex(float zIndex)` 设置多边形的Z轴数值。

    - ### 从类继承的方法 com.amap.api.maps.model.BaseOverlay

      `method1, method2`

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

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

- - ### 方法详细资料

    - #### remove

          public void remove()

      从地图上删除当前多边形。
      Remove the current polygon from the map.
      从以下版本开始:
        2.0

    - #### getId

          public java.lang.String getId()

      获取多边形的Id。
      Get the ID of the polygon.
      返回:
        返回多边形Id。Id是区分一个地图里不同多边形的标识。
        Return the polygon ID. The ID is the identifier to distinguish different polygons in a map.
      从以下版本开始:
        2.0

    - #### setPoints

          public void setPoints(java.util.List<LatLng> points)

      设置多边形的顶点。设置完成后再修改顶点列表的值，不会影响多边形。
      Set the vertices of the polygon. Modifying the vertex list after setting will not affect the polygon.
      参数:
        `points` - 多边形顶点列表
        Polygon vertex list
      从以下版本开始:
        2.0

    - #### getPoints

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

      获取多边形的顶点列表。如果调用此方法后，多边形的顶点发生了变化，列表的值不会随之改变。如果调用此方法获得顶点坐标后并且修改了顶点坐标， 也不会作用到当前多边形。如果需要修改多边形的顶点值必须调用setPoints(List)。
      Get the vertex list of the polygon. If the vertices of the polygon change after calling this method, the values in the list will not change accordingly. If you modify the vertex coordinates after obtaining them through this method, it will not affect the current polygon. To modify the vertex values of the polygon, you must call setPoints(List).
      从以下版本开始:
        2.0

    - #### setHoleOptions

          public void setHoleOptions(java.util.List options)

      设置多边形空心洞的配置项集合
      Set the configuration collection of polygon hollow holes
      参数:
        `options` - 空心洞的配置项集合
        Configuration collection of hollow holes
      从以下版本开始:
        5.5.0

    - #### getHoleOptions

          public java.util.List getHoleOptions()

      获取多边形空心洞的配置项集合
      Get the configuration collection of polygon hollow holes
      返回:
        空心洞的配置项集合
        Configuration collection of hollow holes
      从以下版本开始:
        5.5.0

    - #### setStrokeWidth

          public void setStrokeWidth(float width)

      设置多边形的边框宽度
      Set the border width of the polygon
      参数:
        `width` - 多边形边框宽度，单位：像素
        Polygon border width, unit: pixels
      从以下版本开始:
        2.0

    - #### getStrokeWidth

          public float getStrokeWidth()

      获取多边形的边框宽度
      Get the border width of the polygon
      返回:
        宽度 单位：像素
        Width, unit: pixels
      从以下版本开始:
        2.0

    - #### setStrokeColor

          public void setStrokeColor(int color)

      设置多边形的边框颜色
      Set the border color of the polygon
      参数:
        `color` - 边框颜色，ARGB格式。
        Border color, ARGB format.
      从以下版本开始:
        2.0

    - #### getStrokeColor

          public int getStrokeColor()

      获取多边形的边框颜色
      Get the border color of the polygon
      返回:
        ARGB格式
        ARGB format
      从以下版本开始:
        2.0

    - #### setFillColor

          public void setFillColor(int color)

      设置多边形的填充颜色
      Set the fill color of the polygon
      参数:
        `color` - 填充颜色的ARGB格式
        Fill color, ARGB format
      从以下版本开始:
        2.0

    - #### getFillColor

          public int getFillColor()

      获取多边形的填充颜色
      Get the fill color of the polygon
      返回:
        多边形填充颜色，ARGB格式。
        Polygon fill color, ARGB format.
      从以下版本开始:
        2.0

    - #### setZIndex

          public void setZIndex(float zIndex)

      设置多边形的Z轴数值。数值更高的多边形将绘制在数值较低的上面。
      Set the Z-axis value of the polygon. Polygons with higher values will be drawn above those with lower values.
      参数:
        `zIndex` - 多边形Z轴数值
        Polygon Z-axis value
      从以下版本开始:
        2.0

    - #### getZIndex

          public float getZIndex()

      获取多边形的Z轴值
      Get the Z-axis value of the polygon
      返回:
        多边形的Z轴值
        Polygon Z-axis value
      从以下版本开始:
        2.0

    - #### setVisible

          public void setVisible(boolean visible)

      设置多边形的可见属性。当不可见时，多边形将不会被绘制，但是其他属性将会保存。
      Set the visibility property of the polygon. When invisible, the polygon will not be drawn, but other properties will be preserved.
      参数:
        `visible` - true：可见；false：不可见。
        true: visible; false: invisible.
      从以下版本开始:
        2.0

    - #### isVisible

          public boolean isVisible()

      获取多边形是否可见。
      Get whether the polygon is visible.
      返回:
        true: 可见，false: 不可见
        true: visible; false: invisible.
      从以下版本开始:
        2.0

    - #### contains

          public boolean contains(LatLng latLng)

      判断多边形是否包含传入的经纬度点。
      Determine whether the polygon contains the incoming latitude and longitude point.
      参数:
        `latLng` - 经纬度点。
        Latitude and longitude point.
      返回:
        true 多边形包含这个点,false 多边形未包含这个点。
        true: the polygon contains this point; false: the polygon does not contain this point.
      从以下版本开始:
        2.1.4

    - #### equals

          public boolean equals(java.lang.Object paramObject)

      覆盖:
        `equals` 在类中 `java.lang.Object`

    - #### hashCode

          public int hashCode()

      覆盖:
        `hashCode` 在类中 `java.lang.Object`

    - #### setStrokeDottedLineType

          public void setStrokeDottedLineType(int type)

      设置多边形的边框虚线形状。
      Set the dotted line shape of the polygon's border.
      参数:
        `type` - 形状：
        `AMapPara.DOTTEDLINE_TYPE_DEFAULT`:不绘制虚线（默认）
        `AMapPara.DOTTEDLINE_TYPE_SQUARE`:方形；
        `AMapPara.DOTTEDLINE_TYPE_CIRCLE`：圆形；
        如果设置不属于给出的形状，则不绘制虚线
        Shapes:
        `AMapPara.DOTTEDLINE_TYPE_DEFAULT`: Do not draw dotted lines (default)
        `AMapPara.DOTTEDLINE_TYPE_SQUARE`: Square;
        `AMapPara.DOTTEDLINE_TYPE_CIRCLE`: Circle;
        If the setting does not belong to the given shapes, no dotted lines will be drawn.
      从以下版本开始:
        11.1.200

    - #### getStrokeDottedLineType

          public int getStrokeDottedLineType()

      获取多边形的边框虚线形状。
      Get the dotted line shape of the polygon's border.
      返回:
        形状： `AMapPara.DOTTEDLINE_TYPE_DEFAULT`:不绘制虚线（默认）
        Shape: `AMapPara.DOTTEDLINE_TYPE_DEFAULT`: Do not draw dotted lines (default)
      从以下版本开始:
        6.2.0