com.amap.api.maps.model

## 类 GroundOverlayOptions

- java.lang.Object
- - com.amap.api.maps.model.BaseOptions
  - - com.amap.api.maps.model.GroundOverlayOptions

- 所有已实现的接口:
    android.os.Parcelable, java.lang.Cloneable

      public final class GroundOverlayOptions
      extends BaseOptions
      implements android.os.Parcelable, java.lang.Cloneable

  ground 覆盖物的选项类。
  Option class for ground overlay.
  从以下版本开始:
    2.1.4

- - ### 嵌套类概要

    - ### 从接口继承的嵌套类/接口 android.os.Parcelable

      `android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>`

  - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `static GroundOverlayOptionsCreator` | `CREATOR`
    `static float` | `NO_DIMENSION`

    - ### 从接口继承的字段 android.os.Parcelable

      `CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE`

  - ### 构造器概要

    构造器
    构造器和说明
    `GroundOverlayOptions()` ground 覆盖物的选项类的构造函数。

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `GroundOverlayOptions` | `anchor(float anchorU, float anchorV)` 设置图片的对齐方式，[0,0]是左上角，[1,1]是右下角 。
    `GroundOverlayOptions` | `bearing(float bearing)` 设置ground 覆盖物从正北顺时针的角度，相对锚点旋转。
    `float` | `getAnchorU()` 从左边开始，水平方向的对齐方式，范围为[0,1]。
    `float` | `getAnchorV()` 从上边开始，垂直方向的对齐方式，范围为[0,1]。
    `float` | `getBearing()` 获取 ground 覆盖物的角度。
    `LatLngBounds` | `getBounds()` 获取 ground 覆盖物 的矩形区域 。
    `float` | `getHeight()` 获取 ground 覆盖物的高。
    `BitmapDescriptor` | `getImage()` 获取 ground 覆盖物的bitmap描述信息。
    `LatLng` | `getLocation()` 获取 Ground覆盖物 的位置。
    `float` | `getTransparency()` 获取 ground 覆盖物的透明度。
    `float` | `getWidth()` 获取 ground 覆盖物的宽 。
    `float` | `getZIndex()` 获取 ground 覆盖物的z轴指数。
    `GroundOverlayOptions` | `image(BitmapDescriptor image)` 设置 ground 覆盖物的图片信息。
    `boolean` | `isVisible()` 获取ground 覆盖物是否可见。
    `GroundOverlayOptions` | `position(LatLng location, float width)` 根据位置和宽设置ground 覆盖物。
    `GroundOverlayOptions` | `position(LatLng location, float width, float height)` 根据位置和宽高设置ground 覆盖物。
    `GroundOverlayOptions` | `positionFromBounds(LatLngBounds paramLatLngBounds)` 根据矩形区域设置ground 覆盖物的位置。
    `GroundOverlayOptions` | `transparency(float transparency)` 设置ground 覆盖物的透明度。
    `GroundOverlayOptions` | `visible(boolean visible)` 设置ground 覆盖物是否可见。
    `GroundOverlayOptions` | `zIndex(float zIndex)` 设置ground 覆盖物的z轴指数。

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

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

    - ### 从接口继承的方法 android.os.Parcelable

      `describeContents, writeToParcel`

- - ### 字段详细资料

    - #### CREATOR

          public static final GroundOverlayOptionsCreator CREATOR

    - #### NO_DIMENSION

          public static final float NO_DIMENSION

      另请参阅:
        常量字段值

  - ### 构造器详细资料

    - #### GroundOverlayOptions

          public GroundOverlayOptions()

      ground 覆盖物的选项类的构造函数。
      Constructor for the option class of ground overlay.
      从以下版本开始:
        2.1.4

  - ### 方法详细资料

    - #### image

          public GroundOverlayOptions image(BitmapDescriptor image)

      设置 ground 覆盖物的图片信息。
      Set the image information for the ground overlay.
      参数:
        `image` - ground 覆盖物使用的图片。
        Image used by the ground overlay.
      返回:
        根据新图片返回的GroundOverlayOptions。
        Return GroundOverlayOptions based on the new image.
      从以下版本开始:
        2.1.4

    - #### anchor

          public GroundOverlayOptions anchor(float anchorU,
                                             float anchorV)

      设置图片的对齐方式，[0,0]是左上角，[1,1]是右下角 。如果不设置，默认为[0.5,0.5]图片的中心点。
      Set the alignment of the image, [0,0] is the top-left corner, [1,1] is the bottom-right corner. If not set, it defaults to [0.5,0.5], the center of the image.
      参数:
        `anchorU` - 在宽度（水平方向）上的对齐方式，建议范围为[0,1]。
        Alignment in the width (horizontal direction), recommended range is [0,1].
        `anchorV` - 在高度（垂直方向）上的对齐方式，建议范围为[0,1]。
        Alignment in the height (vertical direction), recommended range is [0,1].
      返回:
        根据新的对齐方式返回的GroundOverlayOptions。
        Return GroundOverlayOptions based on the new alignment.
      从以下版本开始:
        2.1.4

    - #### position

          public GroundOverlayOptions position(LatLng location,
                                               float width)

      根据位置和宽设置ground 覆盖物。在显示时，图片高度根据图片的比例自动匹配。
      Set the ground overlay based on position and width. The image height is automatically matched based on the image ratio when displayed.
      参数:
        `location` - ground 覆盖物的锚点。
        Anchor point of the ground overlay.
        `width` - ground 覆盖物的宽，单位：米。
        Width of the ground overlay, unit: meters.
      返回:
        根据位置和宽设置ground 覆盖物 的 GroundOverlayOptions。
        GroundOverlayOptions for setting the ground overlay based on position and width.
      抛出:
        `java.lang.IllegalArgumentException` - 锚点为null时，IllegalArgumentException 宽度和高度为负数，IllegalStateException ground 覆盖物已经用矩形区域设置位置时。
        When the anchor is null, IllegalArgumentException if width and height are negative, IllegalStateException if the ground overlay has already been positioned using a rectangular area.
      从以下版本开始:
        2.1.4

    - #### position

          public GroundOverlayOptions position(LatLng location,
                                               float width,
                                               float height)

      根据位置和宽高设置ground 覆盖物。在显示时，图片会被缩放来适应指定的尺寸。
      Set the ground overlay based on position, width, and height. The image will be scaled to fit the specified dimensions when displayed.
      参数:
        `location` - ground 覆盖物的锚点。
        Anchor point of the ground overlay.
        `width` - ground 覆盖物的宽，单位：米。
        Width of the ground overlay, unit: meters.
        `height` - ground 覆盖物的高，单位：米。
        Height of the ground overlay, unit: meters.
      返回:
        根据位置和宽高设置ground 覆盖物的GroundOverlayOptions。
        GroundOverlayOptions for setting the ground overlay based on position, width, and height.
      抛出:
        `java.lang.IllegalArgumentException` - 锚点为null时，IllegalArgumentException 宽度和高度为负数，IllegalStateException ground 覆盖物已经用矩形区域设置位置时。
        When the anchor is null, IllegalArgumentException if width and height are negative, IllegalStateException if the ground overlay has already been positioned using a rectangular area.
      从以下版本开始:
        2.1.4

    - #### positionFromBounds

          public GroundOverlayOptions positionFromBounds(LatLngBounds paramLatLngBounds)

      根据矩形区域设置ground 覆盖物的位置。当设置时忽略旋转的角度，但是画此ground 覆盖物时还是会使用之前的旋转角度。
      Set the position of the ground overlay based on a rectangular area. The rotation angle is ignored when setting, but the previous rotation angle will still be used when drawing this ground overlay.
      参数:
        `paramLatLngBounds` - 设置ground 覆盖物的矩形区域。
        Set the rectangular area of the ground overlay.
      返回:
        根据矩形区域设置ground 覆盖物位置的GroundOverlayOptions。
        GroundOverlayOptions for setting the position of the ground overlay based on a rectangular area.
      抛出:
        `java.lang.IllegalStateException` - ground 覆盖物位置已经使用position(LatLng, float) or position(LatLng, float, float)设置时。
        When the ground overlay position has been set using position(LatLng, float) or position(LatLng, float, float).
      从以下版本开始:
        2.1.4

    - #### bearing

          public GroundOverlayOptions bearing(float bearing)

      设置ground 覆盖物从正北顺时针的角度，相对锚点旋转。
      Set the angle of the ground overlay clockwise from true north, relative to the anchor point.
      参数:
        `bearing` - ground 覆盖物从正北顺时针的角度，范围为[0,360)。
        ground 覆盖物从正北顺时针的角度，范围为[0,360)。
      返回:
        设置ground 覆盖物角度返回的GroundOverlayOptions。
        GroundOverlayOptions returned after setting the angle of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### zIndex

          public GroundOverlayOptions zIndex(float zIndex)

      设置ground 覆盖物的z轴指数。
      Set the z-index of the ground overlay.
      参数:
        `zIndex` - z轴指数。
        Z-index.
      返回:
        设置ground 覆盖物z轴指数的GroundOverlayOptions。
        GroundOverlayOptions for setting the z-index of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### visible

          public GroundOverlayOptions visible(boolean visible)

      设置ground 覆盖物是否可见。默认为可见 。
      Set whether the ground overlay is visible. Default is visible.
      参数:
        `visible` - true 可见，false 不可见。
        True for visible, false for invisible.
      返回:
        设置ground 覆盖物可见属性的GroundOverlayOptions。
        GroundOverlayOptions for setting the visibility property of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### transparency

          public GroundOverlayOptions transparency(float transparency)

      设置ground 覆盖物的透明度。默认为0，不透明。
      Set the transparency of the ground overlay. Default is 0, opaque.
      参数:
        `transparency` - ground 覆盖物的透明度，范围为[0,1]，0为不透明，1为全透明。
        The transparency of the ground overlay ranges from [0,1], where 0 is opaque and 1 is fully transparent.
      返回:
        设置ground 覆盖物透明度属性的GroundOverlayOptions。
        Set the transparency property of the ground overlay in GroundOverlayOptions.
      从以下版本开始:
        2.1.4

    - #### getImage

          public BitmapDescriptor getImage()

      获取 ground 覆盖物的bitmap描述信息。
      Get the bitmap description information of the ground overlay.
      返回:
        GroundOverlayOptions 的图片。
        The image of GroundOverlayOptions.
      从以下版本开始:
        2.1.4

    - #### getLocation

          public LatLng getLocation()

      获取 Ground覆盖物 的位置。
      Get the position of the ground overlay.
      返回:
        此ground 覆盖物的位置。如果用矩形区域设置ground 覆盖物位置，此方法返回null。
        The position of this ground overlay. If the ground overlay position is set using a rectangular area, this method returns null.
      从以下版本开始:
        2.1.4

    - #### getWidth

          public float getWidth()

      获取 ground 覆盖物的宽 。
      Get the width of the ground overlay.
      返回:
        ground 覆盖物的宽。单位：米。
        The width of the ground overlay. Unit: meters.
      从以下版本开始:
        2.1.4

    - #### getHeight

          public float getHeight()

      获取 ground 覆盖物的高。
      Get the height of the ground overlay.
      返回:
        ground 覆盖物的高。单位：米。
        The height of the ground overlay. Unit: meters.
      从以下版本开始:
        2.1.4

    - #### getBounds

          public LatLngBounds getBounds()

      获取 ground 覆盖物 的矩形区域 。
      Get the rectangular area of the ground overlay.
      返回:
        ground 覆盖物 的矩形区域（西南和东北点坐标范围）。如果用锚点设置ground 覆盖物位置，此方法会返回null。
        The rectangular area of the ground overlay (southwest and northeast point coordinate range). If the ground overlay position is set using an anchor point, this method will return null.
      从以下版本开始:
        2.1.4

    - #### getBearing

          public float getBearing()

      获取 ground 覆盖物的角度。
      Get the angle of the ground overlay.
      返回:
        ground 覆盖物的角度。
        The angle of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### getZIndex

          public float getZIndex()

      获取 ground 覆盖物的z轴指数。
      Get the z-index of the ground overlay.
      返回:
        ground 覆盖物的z轴指数。
        The z-index of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### getTransparency

          public float getTransparency()

      获取 ground 覆盖物的透明度。
      Get the transparency of the ground overlay.
      返回:
        ground 覆盖物的透明度。
        The transparency of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### getAnchorU

          public float getAnchorU()

      从左边开始，水平方向的对齐方式，范围为[0,1]。
      The horizontal alignment starting from the left, ranging from [0,1].
      返回:
        水平方向对齐返回的值。
        The value returned by horizontal alignment.
      从以下版本开始:
        2.1.4

    - #### getAnchorV

          public float getAnchorV()

      从上边开始，垂直方向的对齐方式，范围为[0,1]。
      The vertical alignment starting from the top, ranging from [0,1].
      返回:
        垂直方向对齐返回的值。
        The value returned by vertical alignment.
      从以下版本开始:
        2.1.4

    - #### isVisible

          public boolean isVisible()

      获取ground 覆盖物是否可见。
      Get whether the ground overlay is visible.
      返回:
        ground 覆盖物是否可见，true 可见，false 不可见。
        Whether the ground overlay is visible, true for visible, false for invisible.
      从以下版本开始:
        2.1.4