com.amap.api.maps.model

## 类 Circle

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

-     public final class Circle
      extends BaseOverlay

  定义了在地图上绘制圆的类。

  圆对象有以下属性：

  - 圆心 ：圆心的经纬度。
  - 半径： 圆的半径，单位：米。这个值应该大于等于0。
  - 边框宽度： 圆的边框宽度。这个值设置后不会受到可视区域缩放级别的影响。默认为10。
  - 边框颜色：圆的边框颜色，ARGB格式。默认为黑色。
  - 填充颜色：圆的填充颜色，ARGB格式。默认为透明。
  - Z轴：Z轴是控制覆盖物重复区域的绘制顺序的值。Z轴较大的覆盖物会绘制在Z轴较小的覆盖物上面。如果两个覆盖物的Z轴数值相同，则覆盖情况将随机。默认值为0。
  - 可见属性：标识多边形是否可见。如果可见性为否，则不会被绘制。 圆形方法必须在主线程中调用，否则会抛出IllegalStateException。
  Defines the class for drawing circles on the map.

  The circle object has the following attributes:

  - Center: The latitude and longitude of the center of the circle.
  - Radius: The radius of the circle in meters. This value should be greater than or equal to 0.
  - Border width: The width of the circle's border. This value will not be affected by the zoom level of the visible area. Default is 10.
  - Border color: The color of the circle's border in ARGB format. Default is black.
  - Fill color: The fill color of the circle in ARGB format. Default is transparent.
  - Z-axis: The Z-axis controls the drawing order of overlapping overlays. Overlays with a higher Z-axis value will be drawn above those with a lower Z-axis value. If two overlays have the same Z-axis value, the overlap will be random. Default value is 0.
  - Visibility: Indicates whether the polygon is visible. If visibility is false, it will not be drawn. Circle 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)`
    `LatLng` | `getCenter()` 获取圆心经纬度坐标。
    `int` | `getFillColor()` 获取圆的填充颜色 Get the fill color of the circle.
    `java.util.List` | `getHoleOptions()` 获取洞的配置项集合 Get the configuration items collection for the hole.
    `java.lang.String` | `getId()` 返回圆的id。
    `double` | `getRadius()` 获取圆的半径，单位米。
    `int` | `getStrokeColor()` 获取圆的边框颜色 Get the border color of the circle.
    `int` | `getStrokeDottedLineType()` 获取圆的边框虚线形状。
    `float` | `getStrokeWidth()` 获取圆的边框宽度。
    `float` | `getZIndex()` 获取圆的Z轴数值 Get the Z-axis value of the circle.
    `int` | `hashCode()`
    `boolean` | `isVisible()` 获取圆是否可见 Get whether the circle is visible.
    `void` | `remove()` 删除从地图对象里圆 Delete the circle from the map object.
    `void` | `setCenter(LatLng center)` 设置圆心经纬度坐标，参数不能为null，无默认值。
    `void` | `setFillColor(int color)` 设置圆的填充颜色。
    `void` | `setHoleOptions(java.util.List options)` 设置洞的配置项集合 Set the configuration items collection for the hole.
    `void` | `setRadius(double radius)` 设置圆的半径，单位米。
    `void` | `setStrokeColor(int color)` 设置圆的边框颜色。
    `void` | `setStrokeDottedLineType(int type)` 设置圆的边框虚线形状。
    `void` | `setStrokeWidth(float width)` 设置圆的边框宽度，单位像素。
    `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()

      删除从地图对象里圆
      Delete the circle from the map object.
      从以下版本开始:
        2.0

    - #### getId

          public java.lang.String getId()

      返回圆的id。
      Return the ID of the circle.
      返回:
        返回圆的id。此id是覆盖物在所属的地图对象里的唯一标识。
        Return the ID of the circle. This ID is the unique identifier of the overlay in the map object to which it belongs.
      从以下版本开始:
        2.0

    - #### setCenter

          public void setCenter(LatLng center)

      设置圆心经纬度坐标，参数不能为null，无默认值。
      Set the latitude and longitude coordinates of the center. The parameter cannot be null and has no default value.
      参数:
        `center` - 圆心经纬度坐标。
        The latitude and longitude coordinates of the center.
      抛出:
        `java.lang.NullPointerException` - 如果圆心经纬度坐标为null。
        NullPointerException if the center latitude and longitude coordinates are null.
      从以下版本开始:
        2.0

    - #### getCenter

          public LatLng getCenter()

      获取圆心经纬度坐标。
      Get the latitude and longitude coordinates of the center.
      返回:
        圆心经纬度坐标。
        The latitude and longitude coordinates of the center.
      从以下版本开始:
        2.0

    - #### setRadius

          public void setRadius(double radius)

      设置圆的半径，单位米。半径必须大于等于0。
      Set the radius of the circle in meters. The radius must be greater than or equal to 0.
      参数:
        `radius` - 圆形半径，单位米。
        The radius of the circle in meters.
      抛出:
        `java.lang.IllegalArgumentException` - 如果传入的半径为负数。
        IllegalArgumentException if the passed radius is negative.
      从以下版本开始:
        2.0

    - #### getRadius

          public double getRadius()

      获取圆的半径，单位米。
      Get the radius of the circle in meters.
      返回:
        圆形半径，单位米。
        The radius of the circle in meters.
      从以下版本开始:
        2.0

    - #### setStrokeWidth

          public void setStrokeWidth(float width)

      设置圆的边框宽度，单位像素。参数必须大于等于0。如果为0则不会绘制边框。默认为10。
      Set the border width of the circle in pixels. The parameter must be greater than or equal to 0. If it is 0, the border will not be drawn. Default is 10.
      参数:
        `width` - 边框宽度，单位像素。
        The border width in pixels.
      抛出:
        `java.lang.IllegalArgumentException` - 如果宽度为负数。
        IllegalArgumentException if the width is negative.
      从以下版本开始:
        2.0

    - #### getStrokeWidth

          public float getStrokeWidth()

      获取圆的边框宽度。
      Get the border width of the circle.
      返回:
        圆的边框宽度，单位像素。
        The border width of the circle in pixels.
      从以下版本开始:
        2.0

    - #### setStrokeColor

          public void setStrokeColor(int color)

      设置圆的边框颜色。
      Set the border color of the circle.
      参数:
        `color` - 边框颜色，ARGB格式。
        The border color in ARGB format.
      从以下版本开始:
        2.0

    - #### getStrokeColor

          public int getStrokeColor()

      获取圆的边框颜色
      Get the border color of the circle.
      返回:
        圆的边框颜色，ARGB格式。
        The border color of the circle in ARGB format.
      从以下版本开始:
        2.0

    - #### setFillColor

          public void setFillColor(int color)

      设置圆的填充颜色。填充颜色是绘制边框以内部分的颜色，ARGB格式。
      Set the fill color of the circle. The fill color is the color of the area inside the border, in ARGB format.
      参数:
        `color` - 填充颜色ARGB格式。
        Fill color in ARGB format.
      从以下版本开始:
        2.0

    - #### getFillColor

          public int getFillColor()

      获取圆的填充颜色
      Get the fill color of the circle.
      返回:
        圆填充颜色的ARGB格式
        ARGB format of the circle's fill color.
      从以下版本开始:
        2.0

    - #### setZIndex

          public void setZIndex(float zIndex)

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

    - #### getZIndex

          public float getZIndex()

      获取圆的Z轴数值
      Get the Z-axis value of the circle.
      返回:
        圆的Z轴数值
        Z-axis value of the circle.
      从以下版本开始:
        2.0

    - #### setVisible

          public void setVisible(boolean visible)

      设置圆的可见属性。如果不可见属性为false，则不会被绘制在地图上。默认为true。
      Set the visibility property of the circle. If the visibility property is false, it will not be drawn on the map. Default is true.
      参数:
        `visible` - true为可见；false不可见。
        true for visible; false for invisible.
      从以下版本开始:
        2.0

    - #### isVisible

          public boolean isVisible()

      获取圆是否可见
      Get whether the circle is visible.
      返回:
        true 为可见，false为不可见。
        true for visible, false for invisible.
      从以下版本开始:
        2.0

    - #### equals

          public boolean equals(java.lang.Object paramObject)

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

    - #### hashCode

          public int hashCode()

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

    - #### contains

          public boolean contains(LatLng latLng)

      判断圆是否包含传入的经纬度点。
      Determine whether the circle contains the passed latitude and longitude point.
      参数:
        `latLng` - 经纬度点。
        Latitude and longitude point.
      返回:
        true 包含，false 为不包含。
        true for included, false for not included.
      从以下版本开始:
        2.1.4

    - #### setHoleOptions

          public void setHoleOptions(java.util.List options)

      设置洞的配置项集合
      Set the configuration items collection for the hole.
      参数:
        `options` - 洞的配置项集合
        Configuration items collection for the hole.
      从以下版本开始:
        5.5.0

    - #### getHoleOptions

          public java.util.List getHoleOptions()

      获取洞的配置项集合
      Get the configuration items collection for the hole.
      返回:
        洞的配置项集合
        Configuration items collection for the hole.
      从以下版本开始:
        5.5.0

    - #### setStrokeDottedLineType

          public void setStrokeDottedLineType(int type)

      设置圆的边框虚线形状。
      Set the dotted line shape of the circle'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.
      从以下版本开始:
        6.2.0

    - #### getStrokeDottedLineType

          public int getStrokeDottedLineType()

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