com.amap.api.maps.model

## 类 MarkerOptions

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

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

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

  Marker 的选项类。
  Marker options class.
  从以下版本开始:
    2.0

- - ### 嵌套类概要

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

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

  - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `static MarkerOptionsCreator` | `CREATOR`

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

      `CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE`

  - ### 构造器概要

    构造器
    构造器和说明
    `MarkerOptions()` 创建MarkerOptions对象。

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `MarkerOptions` | `alpha(float alpha)` 设置Marker覆盖物的透明度 Set the transparency of the Marker overlay
    `MarkerOptions` | `altitude(float altitude)` marker的海拔 Marker's elevation
    `MarkerOptions` | `anchor(float u, float v)` 设置Marker覆盖物的锚点比例。
    `MarkerOptions` | `draggable(boolean enable)` 设置Marker覆盖物是否可拖拽。
    `float` | `getAlpha()` 获取Marker覆盖物的透明度,透明度范围[0,1] 1为不透明,默认值为1 Get the transparency of the Marker overlay, transparency range [0,1], 1 is opaque, default is 1
    `float` | `getAltitude()` 获取marker海拔高度 Get the elevation height of the marker
    `float` | `getAnchorU()` 获取Marker覆盖物锚点在水平范围的比例。
    `float` | `getAnchorV()` 获取Marker覆盖物锚点垂直范围的比例。
    `BitmapDescriptor` | `getIcon()` 获取Marker覆盖物的图标。
    `java.util.ArrayList<BitmapDescriptor>` | `getIcons()` 获取Marker覆盖物的动画帧图标列表，动画的描点和大小以第一帧为准，建议图片大小保持一致。
    `android.view.View` | `getIconView()` 获取Marker覆盖物的图标 原生view。
    `int` | `getInfoWindowOffsetX()` 获取Marker覆盖物的水平偏移距离 Get the horizontal offset distance of the Marker overlay.
    `int` | `getInfoWindowOffsetY()` 获取Marker覆盖物的垂直偏移距离 Get the vertical offset distance of the Marker overlay.
    `int` | `getPeriod()` 得到多少帧刷新一次图片资源，值越小动画越快。
    `LatLng` | `getPosition()` 获取Marker覆盖物的坐标位置。
    `float` | `getRotateAngle()` 获取 Marker覆盖物的图片旋转角度，从正北开始，逆时针计算。
    `java.lang.String` | `getSnippet()` 获取Marker覆盖物的文字片段。
    `java.lang.String` | `getTitle()` 获取Marker覆盖物的标题。
    `float` | `getZIndex()` 获取Marker覆盖物zIndex。
    `MarkerOptions` | `icon(BitmapDescriptor icon)` 设置Marker覆盖物的图标。
    `MarkerOptions` | `icon(android.view.View icon)` 设置Marker覆盖物的图标,图标使用原生view。
    `MarkerOptions` | `icons(java.util.ArrayList<BitmapDescriptor> icons)` 设置Marker覆盖物的动画帧图标列表，多张图片模拟gif的效果。
    `MarkerOptions` | `infoWindowEnable(boolean enabled)` 设置Marker覆盖物的InfoWindow是否允许显示,默认为true Set whether the InfoWindow of the Marker overlay is allowed to be displayed, default is true
    `boolean` | `isDraggable()` 获取Marker覆盖物的拖拽状态。
    `boolean` | `isFlat()` 获取Marker覆盖物是否平贴地图。
    `boolean` | `isGps()` 获取Marker覆盖物的坐标是否是Gps，默认为false。
    `boolean` | `isInfoWindowEnable()` 获取Marker覆盖物的InfoWindow是否允许显示, 可以通过 `MarkerOptions.infoWindowEnable(boolean)` 进行设置 Get whether the InfoWindow of the Marker overlay is allowed to be displayed, which can be set via `MarkerOptions.infoWindowEnable(boolean)`
    `MarkerOptions` | `isOpenCollisionDetection(boolean enabled)` 设置Marker覆盖物是否开启碰撞检测,默认为false Set whether the Marker overlay enables collision detection, default is false
    `boolean` | `isPerspective()` 已过时。
    `boolean` | `isVisible()` 获取Marker覆盖物是否可见。
    `MarkerOptions` | `period(int period)` 设置多少帧刷新一次图片资源，Marker动画的间隔时间，值越小动画越快。
    `MarkerOptions` | `perspective(boolean perspective)` 已过时。
    `MarkerOptions` | `position(LatLng position)` 设置Marker覆盖物的位置坐标。
    `MarkerOptions` | `rotateAngle(float rotate)` 设置Marker覆盖物的图片旋转角度，从正北开始，逆时针计算。
    `MarkerOptions` | `setFlat(boolean flat)` 设置Marker覆盖物是否平贴地图。
    `MarkerOptions` | `setGps(boolean isGps)` 设置Marker覆盖物的坐标是否是Gps，默认为false。
    `MarkerOptions` | `setInfoWindowOffset(int offsetX, int offsetY)` 设置Marker覆盖物的InfoWindow相对Marker的偏移。
    `MarkerOptions` | `snippet(java.lang.String snippet)` 设置 Marker覆盖物的 文字描述 Set the text description of the Marker overlay.
    `MarkerOptions` | `title(java.lang.String title)` 设置 Marker覆盖物 的标题 Set the title of the Marker overlay.
    `MarkerOptions` | `visible(boolean visible)` 设置Marker覆盖物是否可见。
    `MarkerOptions` | `zIndex(float zIndex)` 设置Marker覆盖物 zIndex。

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

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

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

      `describeContents, writeToParcel`

- - ### 字段详细资料

    - #### CREATOR

          public static final MarkerOptionsCreator CREATOR

  - ### 构造器详细资料

    - #### MarkerOptions

          public MarkerOptions()

      创建MarkerOptions对象。
      Create MarkerOptions object.
      从以下版本开始:
        2.0

  - ### 方法详细资料

    - #### icons

          public MarkerOptions icons(java.util.ArrayList<BitmapDescriptor> icons)

      设置Marker覆盖物的动画帧图标列表，多张图片模拟gif的效果。
      Set the animation frame icon list for Marker overlay, simulating GIF effects with multiple images.
      参数:
        `icons` - Marker的动画帧列表。
        Animation frame list of Marker.
      返回:
        MarkerOptions 对象。
        MarkerOptions object.
      从以下版本开始:
        2.1.4

    - #### getIcons

          public java.util.ArrayList<BitmapDescriptor> getIcons()

      获取Marker覆盖物的动画帧图标列表，动画的描点和大小以第一帧为准，建议图片大小保持一致。
      Get the animation frame icon list for Marker overlay. The anchor point and size of the animation are based on the first frame. It is recommended to keep the image sizes consistent.
      返回:
        Marker的动画帧列表。
        Animation frame list of Marker.
      从以下版本开始:
        2.1.4

    - #### period

          public MarkerOptions period(int period)

      设置多少帧刷新一次图片资源，Marker动画的间隔时间，值越小动画越快。
      Set how many frames to refresh the image resource. The interval time of Marker animation, the smaller the value, the faster the animation.
      参数:
        `period` - 帧数， 刷新周期，值越小速度越快。默认为20，最小为1。
        Frame count, refresh interval. The smaller the value, the faster the speed. Default is 20, minimum is 1.
      返回:
        MarkerOptions 对象。
        MarkerOptions object.
      从以下版本开始:
        2.1.4

    - #### getPeriod

          public int getPeriod()

      得到多少帧刷新一次图片资源，值越小动画越快。
      Get how many frames to refresh the image resource. The smaller the value, the faster the animation.
      返回:
        刷新周期，值越小速度越快。默认为20，最小为1。
        Refresh interval. The smaller the value, the faster the speed. Default is 20, minimum is 1.
      从以下版本开始:
        2.1.4

    - #### isPerspective

          public boolean isPerspective()

      已过时。
      获取 marker 覆盖物是否开启近大远小效果。默认为false，不具有此效果。
      Get whether the marker overlay has the perspective scaling effect enabled. Default is false, no such effect.
      返回:
        Marker覆盖物是否设置为近大远小效果。true为近大远小效果，反之没有效果。
        Whether the Marker overlay is set to perspective scaling effect. true enables the effect, false disables it.
      从以下版本开始:
        2.1.0

    - #### perspective

          public MarkerOptions perspective(boolean perspective)

      已过时。
      设置是否开启 marker 覆盖物近大远小效果，默认开启。
      在marker初始化时使用，当地图倾斜时，远方的标记变小，附近的标记变大。
      Set whether to enable the perspective scaling effect for marker overlay, enabled by default.
      Used during marker initialization, when the map is tilted, distant markers become smaller and nearby markers become larger.
      参数:
        `perspective` - true，设置近大远小效果；false，普通效果。
        true enables perspective scaling effect; false is normal effect.
      返回:
        MarkerOptions对象。
        MarkerOptions object.
      从以下版本开始:
        2.1.0

    - #### position

          public MarkerOptions position(LatLng position)

      设置Marker覆盖物的位置坐标。Marker经纬度坐标不能为Null，坐标无默认值。
      Set the position coordinates of the Marker overlay. Marker latitude and longitude coordinates cannot be Null, and there is no default value for coordinates.
      参数:
        `position` - 当前MarkerOptions对象的经纬度。
        Latitude and longitude of the current MarkerOptions object.
      返回:
        MarkerOptions对象。
        MarkerOptions object.
      从以下版本开始:
        2.0

    - #### setFlat

          public MarkerOptions setFlat(boolean flat)

      设置Marker覆盖物是否平贴地图。
      Set whether the Marker overlay is flat on the map.
      参数:
        `flat` - 平贴地图设置为 true，面对镜头设置为 false。
        Set flat on the map to true, facing the camera to false.
      返回:
        MarkerOptions 对象。
        MarkerOptions object.
      从以下版本开始:
        2.2.1

    - #### icon

          public MarkerOptions icon(BitmapDescriptor icon)

      设置Marker覆盖物的图标。相同图案的 icon 的 Marker 最好使用同一个 BitmapDescriptor 对象以节省内存空间。
      Set the icon of the Marker overlay. Markers with the same icon pattern should preferably use the same BitmapDescriptor object to save memory space.
      参数:
        `icon` - 图标的BitmapDescriptor对象
        BitmapDescriptor object of the icon
      返回:
        MarkerOptions对象。
        MarkerOptions object.
      从以下版本开始:
        2.0

    - #### icon

          public MarkerOptions icon(android.view.View icon)

      设置Marker覆盖物的图标,图标使用原生view。
      参数:
        `icon` - view
      返回:
        MarkerOptions对象。

    - #### anchor

          public MarkerOptions anchor(float u,
                                      float v)

      设置Marker覆盖物的锚点比例。锚点是marker 图标接触地图平面的点。图标的左顶点为（0,0）点，右底点为（1,1）点。
      默认为（0.5,1.0）
      Set the anchor point ratio of the Marker overlay. The anchor point is the point where the marker icon touches the map plane. The top-left vertex of the icon is (0,0), and the bottom-right vertex is (1,1).
      Default is (0.5,1.0)
      参数:
        `u` - 锚点水平范围的比例，建议传入0 到1 之间的数值。
        The ratio of the horizontal range of the anchor point, it is recommended to pass a value between 0 and 1.
        `v` - 锚点垂直范围的比例，建议传入0 到1 之间的数值。
        The ratio of the vertical range of the anchor point, it is recommended to pass a value between 0 and 1.
      返回:
        一个设置了锚点的MarkerOptions 对象
        A MarkerOptions object with an anchor point set.
      从以下版本开始:
        2.0

    - #### setInfoWindowOffset

          public MarkerOptions setInfoWindowOffset(int offsetX,
                                                   int offsetY)

      设置Marker覆盖物的InfoWindow相对Marker的偏移。

      坐标系原点为marker的中上点，InfoWindow相对此原点的像素偏移，向左和向上为负，向右和向下为正。InfoWindow的初始位置为marker上边线与InfoWindow下边线重合，并且两者的中线在一条线上。

      Set the offset of the InfoWindow relative to the Marker.

      The origin of the coordinate system is the top center point of the marker. The pixel offset of the InfoWindow relative to this origin is negative to the left and up, and positive to the right and down. The initial position of the InfoWindow is where the top edge of the marker coincides with the bottom edge of the InfoWindow, and their center lines are aligned.

      参数:
        `offsetX` - InfoWindow相对原点的横向像素偏移量，单位：像素。
        Horizontal pixel offset of the InfoWindow relative to the origin, unit: pixels.
        `offsetY` - InfoWindow相对原点的纵向像素偏移量，单位：像素。
        Vertical pixel offset of the InfoWindow relative to the origin, unit: pixels.
      返回:
        MarkerOptions对象。
        MarkerOptions object.

    - #### title

          public MarkerOptions title(java.lang.String title)

      设置 Marker覆盖物 的标题
      Set the title of the Marker overlay.
      参数:
        `title` - Marker 的标题
        Title of the Marker.
      返回:
        一个设置标题的MarkerOptions对象。
        A MarkerOptions object for setting the title.
      从以下版本开始:
        2.0

    - #### snippet

          public MarkerOptions snippet(java.lang.String snippet)

      设置 Marker覆盖物的 文字描述
      Set the text description of the Marker overlay.
      参数:
        `snippet` - Marker上的文字描述
        Text description on the Marker.
      返回:
        一个设置文字描述的MarkerOptions对象。
        A MarkerOptions object for setting the text description.
      从以下版本开始:
        2.0

    - #### draggable

          public MarkerOptions draggable(boolean enable)

      设置Marker覆盖物是否可拖拽。
      Set whether the Marker overlay is draggable.
      参数:
        `enable` - 一个布尔值，表示Marker是否可拖拽，true表示可拖拽，false表示不可拖拽。
        A boolean value indicating whether the Marker is draggable, true means draggable, false means not draggable.
      返回:
        设Marker是否可拖拽的MarkerOptions对象。
        A MarkerOptions object for setting whether the Marker is draggable.
      从以下版本开始:
        2.0.1

    - #### visible

          public MarkerOptions visible(boolean visible)

      设置Marker覆盖物是否可见。
      Set whether the Marker overlay is visible.
      参数:
        `visible` - Marker的可见性。
        Visibility of the Marker.
      返回:
        设置Marker覆盖物是否可见的MarkerOptions对象。
        A MarkerOptions object for setting the visibility of the Marker overlay.
      从以下版本开始:
        2.0

    - #### setGps

          public MarkerOptions setGps(boolean isGps)

      设置Marker覆盖物的坐标是否是Gps，默认为false。
      Set whether the coordinates of the Marker overlay are GPS, default is false.
      参数:
        `isGps` - true 是Gps，false 不是Gps。
        true means GPS, false means not GPS.
      返回:
        MarkerOptions 对象。
        MarkerOptions object.
      从以下版本开始:
        2.2.0

    - #### getPosition

          public LatLng getPosition()

      获取Marker覆盖物的坐标位置。
      Get the coordinate position of the Marker overlay.
      返回:
        当前MarkerOptions 对象所设置的经纬度。
        The latitude and longitude set by the current MarkerOptions object.
      从以下版本开始:
        2.0

    - #### getTitle

          public java.lang.String getTitle()

      获取Marker覆盖物的标题。
      Get the title of the Marker overlay.
      返回:
        Marker的标题。
        Title of the Marker.
      从以下版本开始:
        2.0

    - #### getSnippet

          public java.lang.String getSnippet()

      获取Marker覆盖物的文字片段。
      Get the text snippet of the Marker overlay.
      返回:
        当前MarkerOptions 对象所设置的文字片段。
        The text snippet set by the current MarkerOptions object.
      从以下版本开始:
        2.0

    - #### getIcon

          public BitmapDescriptor getIcon()

      获取Marker覆盖物的图标。
      Get the icon of the Marker overlay.
      返回:
        设置图标的BitmapDescriptor 对象，此对象无Bitmap对象，只有宽度和高度，如果未设置返回null。
        The BitmapDescriptor object for setting the icon, which has no Bitmap object, only width and height. Returns null if not set.
      从以下版本开始:
        2.0

    - #### getIconView

          public android.view.View getIconView()

      获取Marker覆盖物的图标 原生view。
      返回:
        Marker的view，可能为空

    - #### getAnchorU

          public float getAnchorU()

      获取Marker覆盖物锚点在水平范围的比例。这个比例值从图标的左边开始计算。
      Get the horizontal anchor ratio of the Marker overlay. This ratio is calculated from the left side of the icon.
      返回:
        锚点在水平范围的比例。
        Horizontal anchor ratio.
      从以下版本开始:
        2.0

    - #### getInfoWindowOffsetX

          public int getInfoWindowOffsetX()

      获取Marker覆盖物的水平偏移距离
      Get the horizontal offset distance of the Marker overlay.
      返回:
        infowindow偏移水平距离
        Horizontal offset distance of the InfoWindow.

    - #### getInfoWindowOffsetY

          public int getInfoWindowOffsetY()

      获取Marker覆盖物的垂直偏移距离
      Get the vertical offset distance of the Marker overlay.
      返回:
        infowindow偏移垂直距离
        Vertical offset distance of the InfoWindow.

    - #### getAnchorV

          public float getAnchorV()

      获取Marker覆盖物锚点垂直范围的比例。这个比例值从顶端开始计算。
      Get the vertical anchor ratio of the Marker overlay. This ratio is calculated from the top.
      返回:
        锚点在垂直范围的比例。
        Vertical anchor ratio.
      从以下版本开始:
        2.0

    - #### isDraggable

          public boolean isDraggable()

      获取Marker覆盖物的拖拽状态。
      Get the drag state of the Marker overlay.
      返回:
        true 可以拖动；false 不可以拖动。
        true: draggable; false: not draggable.
      从以下版本开始:
        2.0.1

    - #### isVisible

          public boolean isVisible()

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

    - #### isGps

          public boolean isGps()

      获取Marker覆盖物的坐标是否是Gps，默认为false。
      Get whether the coordinates of the Marker overlay are GPS, default is false.
      返回:
        true 是Gps，false 不是Gps。
        true means GPS, false means not GPS.
      从以下版本开始:
        2.2.0

    - #### isFlat

          public boolean isFlat()

      获取Marker覆盖物是否平贴地图。
      Get whether the Marker overlay is flat on the map.
      返回:
        若marker平贴在地图上返回 true；若marker面对镜头返回 false。
        Return true if the marker is flat on the map; return false if the marker faces the camera.
      从以下版本开始:
        2.2.1

    - #### zIndex

          public MarkerOptions zIndex(float zIndex)

      设置Marker覆盖物 zIndex。
      Set the zIndex of the Marker overlay.
      参数:
        `zIndex` -
      返回:
        MarkerOptions对象。
        MarkerOptions object.

    - #### getZIndex

          public float getZIndex()

      获取Marker覆盖物zIndex。
      Get the zIndex of the Marker overlay.
      返回:
        zIndex

    - #### alpha

          public MarkerOptions alpha(float alpha)

      设置Marker覆盖物的透明度
      Set the transparency of the Marker overlay
      参数:
        `alpha` - 透明度范围[0,1] 1为不透明
        Transparency range [0,1], 1 is opaque
      返回:
        修改了透明度的MarkerOptions对象
        Modified MarkerOptions object with transparency
      从以下版本开始:
        3.3.2

    - #### getAlpha

          public float getAlpha()

      获取Marker覆盖物的透明度,透明度范围[0,1] 1为不透明,默认值为1
      Get the transparency of the Marker overlay, transparency range [0,1], 1 is opaque, default is 1
      返回:
        透明度
        Transparency
      从以下版本开始:
        3.3.2

    - #### rotateAngle

          public MarkerOptions rotateAngle(float rotate)

      设置Marker覆盖物的图片旋转角度，从正北开始，逆时针计算。
      Set the rotation angle of the Marker overlay's image, starting from true north, calculated counterclockwise.
      参数:
        `rotate` - Marker图片旋转的角度，从正北开始，逆时针计算。
        The rotation angle of the Marker image, starting from true north, calculated counterclockwise.
      返回:
        MarkerOptions对象
        MarkerOptions object.
      从以下版本开始:
        4.0.0

    - #### getRotateAngle

          public float getRotateAngle()

      获取 Marker覆盖物的图片旋转角度，从正北开始，逆时针计算。
      Get the rotation angle of the Marker overlay's image, starting from true north, calculated counterclockwise.
      返回:
        Marker图片旋转的角度。
        The rotation angle of the Marker image.
      从以下版本开始:
        4.0.0

    - #### infoWindowEnable

          public MarkerOptions infoWindowEnable(boolean enabled)

      设置Marker覆盖物的InfoWindow是否允许显示,默认为true
      Set whether the InfoWindow of the Marker overlay is allowed to be displayed, default is true
      参数:
        `enabled` - true:允许显示,false:不允许显示
        true: allowed to display, false: not allowed to display
      返回:
        MarkerOptions对象
        MarkerOptions object.
      从以下版本开始:
        4.0.0

    - #### isInfoWindowEnable

          public boolean isInfoWindowEnable()

      获取Marker覆盖物的InfoWindow是否允许显示, 可以通过 `MarkerOptions.infoWindowEnable(boolean)` 进行设置
      Get whether the InfoWindow of the Marker overlay is allowed to be displayed, which can be set via `MarkerOptions.infoWindowEnable(boolean)`
      返回:
        true: 允许显示,false:不允许显示
        true: allowed to display, false: not allowed to display
      从以下版本开始:
        4.0.0

    - #### altitude

          public MarkerOptions altitude(float altitude)

      marker的海拔
      Marker's elevation
      参数:
        `altitude` -
      返回:
        MarkerOptions
      从以下版本开始:
        9.5.0

    - #### getAltitude

          public float getAltitude()

      获取marker海拔高度
      Get the elevation height of the marker
      返回:

    - #### isOpenCollisionDetection

          public MarkerOptions isOpenCollisionDetection(boolean enabled)

      设置Marker覆盖物是否开启碰撞检测,默认为false
      Set whether the Marker overlay enables collision detection, default is false
      参数:
        `enabled` - true:开启碰撞检测,false:不开启碰撞检测
        true: enable collision detection, false: disable collision detection
      返回:
        MarkerOptions对象
        MarkerOptions object.