com.amap.api.maps

## 类 UiSettings

- java.lang.Object
- - com.amap.api.maps.UiSettings

-     public final class UiSettings
      extends java.lang.Object

  地图内置UI及手势控制器。
  Built-in UI and gesture controller for the map.

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `UiSettings.ScaleControlsUnit` 比例尺单位枚举 Enumeration for scale control units

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `int` | `getLogoPosition()` 获取“高德地图”Logo的位置。
    `UiSettings.ScaleControlsUnit` | `getScaleControlsUnit()` 获取当前比例尺单位 Get the current unit used by the scale control.
    `int` | `getZoomPosition()` 获取缩放按钮的位置。
    `boolean` | `isCompassEnabled()` 返回指南针控件是否可见。
    `boolean` | `isGestureScaleByMapCenter()` 返回是否以地图中心点缩放 Returns whether to zoom at the center of the map
    `boolean` | `isIndoorSwitchEnabled()` 返回室内地图楼层切换控件是否显示。
    `protected boolean` | `isLogoEnable()`
    `boolean` | `isMyLocationButtonEnabled()` 返回定位按钮是否可见。
    `boolean` | `isRotateGesturesEnabled()` 返回旋转手势是否可用。
    `boolean` | `isScaleControlsEnabled()` 返回比例尺控件是否可见。
    `boolean` | `isScrollGesturesEnabled()` 返回拖拽手势是否可用。
    `boolean` | `isTiltGesturesEnabled()` 返回倾斜手势是否可用。
    `boolean` | `isZoomControlsEnabled()` 返回缩放按钮是否可见。
    `boolean` | `isZoomGesturesEnabled()` 返回缩放手势是否可用。
    `void` | `setAllGesturesEnabled(boolean enabled)` 设置所有手势是否可用 Set whether all gestures are enabled
    `void` | `setCompassEnabled(boolean enabled)` 设置指南针是否可见。
    `void` | `setGestureScaleByMapCenter(boolean isGestureScaleByMapCenter)` 设置是否以地图中心点缩放 注：优先级低于`AMap.setPointToCenter(int, int)` Sets whether to zoom at the center of the map Note: The priority is lower than `AMap.setPointToCenter(int, int)`
    `void` | `setIndoorSwitchEnabled(boolean isIndoorSwitchEnabled)` 设置室内地图楼层切换控件是否可见。
    `void` | `setLogoBottomMargin(int pixels)` 设置Logo下边界距离屏幕底部的边距 Sets the margin of the bottom boundary of the logo from the bottom of the screen.
    `void` | `setLogoLeftMargin(int pixels)` 设置Logo左边界距离屏幕左侧的边距 Sets the margin of the left boundary of the logo from the left side of the screen.
    `void` | `setLogoPosition(int position)` 设置“高德地图”Logo的位置。
    `void` | `setMyLocationButtonEnabled(boolean enabled)` 设置定位按钮是否可见。
    `void` | `setRotateGesturesEnabled(boolean enabled)` 设置旋转手势是否可用。
    `void` | `setScaleControlsEnabled(boolean enabled)` 设置比例尺控件是否可见 Set whether the scale control is visible
    `void` | `setScaleControlsPosition(android.graphics.Point position)` 设置比例尺控件位置 Set the position of the scale control
    `void` | `setScaleControlsUnit(UiSettings.ScaleControlsUnit unit)` 设置比例尺单位 Set the unit used by the scale control.
    `void` | `setScrollGesturesEnabled(boolean enabled)` 设置拖拽手势是否可用。
    `void` | `setTiltGesturesEnabled(boolean enabled)` 设置倾斜手势是否可用。
    `void` | `setZoomControlsEnabled(boolean enabled)` 设置缩放按钮是否可见。
    `void` | `setZoomGesturesEnabled(boolean enabled)` 设置双指缩放手势是否可用。
    `void` | `setZoomPosition(int position)` 设置缩放按钮的位置。

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

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

- - ### 方法详细资料

    - #### setScaleControlsEnabled

          public void setScaleControlsEnabled(boolean enabled)

      设置比例尺控件是否可见
      Set whether the scale control is visible
      参数:
        `enabled` - true表示可见，false表示不可见。
        true means visible, false means invisible.
      从以下版本开始:
        2.0.1

    - #### setZoomControlsEnabled

          public void setZoomControlsEnabled(boolean enabled)

      设置缩放按钮是否可见。
      Set whether the zoom button is visible.
      参数:
        `enabled` - true表示可见，false表示不可见。
        true means visible, false means invisible.
      从以下版本开始:
        2.0

    - #### setCompassEnabled

          public void setCompassEnabled(boolean enabled)

      设置指南针是否可见。
      Set whether the compass is visible.
      参数:
        `enabled` - true表示可见，false表示不可见。
        true means visible, false means invisible.
      从以下版本开始:
        2.0.1

    - #### setMyLocationButtonEnabled

          public void setMyLocationButtonEnabled(boolean enabled)

      设置定位按钮是否可见。
      Set whether the location button is visible.
      参数:
        `enabled` - true表示可见，false表示不可见。
        true means visible, false means invisible.
      从以下版本开始:
        2.0

    - #### setScrollGesturesEnabled

          public void setScrollGesturesEnabled(boolean enabled)

      设置拖拽手势是否可用。
      Set whether the drag gesture is enabled.
      参数:
        `enabled` - true为可用； false 为不可用。
        true for enabled; false for disabled.
      从以下版本开始:
        2.0

    - #### setZoomGesturesEnabled

          public void setZoomGesturesEnabled(boolean enabled)

      设置双指缩放手势是否可用。
      Set whether the two-finger zoom gesture is enabled.
      参数:
        `enabled` - true为可用； false 为不可用。
        true for enabled; false for disabled.
      从以下版本开始:
        2.0

    - #### setTiltGesturesEnabled

          public void setTiltGesturesEnabled(boolean enabled)

      设置倾斜手势是否可用。
      Set whether the tilt gesture is enabled.
      参数:
        `enabled` - true为可用； false 为不可用。
        true for enabled; false for disabled.
      从以下版本开始:
        2.0

    - #### setRotateGesturesEnabled

          public void setRotateGesturesEnabled(boolean enabled)

      设置旋转手势是否可用。
      Set whether the rotate gesture is enabled.
      参数:
        `enabled` - true为可用； false 为不可用。
        true for enabled; false for disabled.
      从以下版本开始:
        2.0

    - #### setAllGesturesEnabled

          public void setAllGesturesEnabled(boolean enabled)

      设置所有手势是否可用
      Set whether all gestures are enabled
      参数:
        `enabled` - true为可用； false 为不可用。
        true for enabled; false for disabled.
      从以下版本开始:
        2.0

    - #### setLogoPosition

          public void setLogoPosition(int position)

      设置“高德地图”Logo的位置。
      Set the position of the "Amap" logo.
      参数:
        `position` - 位置参数。屏幕左下角：`AMapOptions.LOGO_POSITION_BOTTOM_LEFT` 底部居中：`AMapOptions.LOGO_POSITION_BOTTOM_CENTER` 右下：`AMapOptions.LOGO_MARGIN_RIGHT`
        Position parameters. Bottom-left corner of the screen: `AMapOptions.LOGO_POSITION_BOTTOM_LEFT` Bottom center: `AMapOptions.LOGO_POSITION_BOTTOM_CENTER` Bottom-right: `AMapOptions.LOGO_MARGIN_RIGHT`
      从以下版本开始:
        2.0.2

    - #### setZoomPosition

          public void setZoomPosition(int position)

      设置缩放按钮的位置。
      Set the position of the zoom button.
      参数:
        `position` - 右边界中部：`AMapOptions.ZOOM_POSITION_RIGHT_CENTER` 右下：`AMapOptions.ZOOM_POSITION_RIGHT_BOTTOM`。
        Middle of the right edge: `AMapOptions.ZOOM_POSITION_RIGHT_CENTER` Bottom-right: `AMapOptions.ZOOM_POSITION_RIGHT_BOTTOM`.
      从以下版本开始:
        2.3.0

    - #### getZoomPosition

          public int getZoomPosition()

      获取缩放按钮的位置。
      Get the position of the zoom button.
      返回:
        缩放按钮的位置常量。右边界中部：`AMapOptions.ZOOM_POSITION_RIGHT_CENTER` 右下：`AMapOptions.ZOOM_POSITION_RIGHT_BOTTOM`。
        Position constants for the zoom button. Middle of the right edge: `AMapOptions.ZOOM_POSITION_RIGHT_CENTER` Bottom-right: `AMapOptions.ZOOM_POSITION_RIGHT_BOTTOM`.
      从以下版本开始:
        2.0.2

    - #### isScaleControlsEnabled

          public boolean isScaleControlsEnabled()

      返回比例尺控件是否可见。
      Return whether the scale control is visible.
      返回:
        是否可见。
        Whether it is visible.
      从以下版本开始:
        2.0.1

    - #### isZoomControlsEnabled

          public boolean isZoomControlsEnabled()

      返回缩放按钮是否可见。
      Return whether the zoom button is visible.
      返回:
        是否可见。
        Whether it is visible.
      从以下版本开始:
        2.0

    - #### isCompassEnabled

          public boolean isCompassEnabled()

      返回指南针控件是否可见。
      Return whether the compass control is visible.
      返回:
        是否可见。
        Whether it is visible.
      从以下版本开始:
        2.0.1

    - #### isMyLocationButtonEnabled

          public boolean isMyLocationButtonEnabled()

      返回定位按钮是否可见。
      Return whether the location button is visible.
      返回:
        是否可见。
        Whether it is visible.
      从以下版本开始:
        2.0

    - #### isScrollGesturesEnabled

          public boolean isScrollGesturesEnabled()

      返回拖拽手势是否可用。
      Return whether the drag gesture is enabled.
      返回:
        是否可用。
      从以下版本开始:
        2.0

    - #### isZoomGesturesEnabled

          public boolean isZoomGesturesEnabled()

      返回缩放手势是否可用。 Return whether the zoom gesture is enabled.
      返回:
        true 是否可用。
      从以下版本开始:
        2.0

    - #### isTiltGesturesEnabled

          public boolean isTiltGesturesEnabled()

      返回倾斜手势是否可用。
      Return whether the tilt gesture is enabled.
      返回:
        是否可用。
      从以下版本开始:
        2.0

    - #### isRotateGesturesEnabled

          public boolean isRotateGesturesEnabled()

      返回旋转手势是否可用。
      Return whether the rotate gesture is enabled.
      返回:
        是否可用。
      从以下版本开始:
        2.0

    - #### getLogoPosition

          public int getLogoPosition()

      获取“高德地图”Logo的位置。
      Get the position of the "Amap" logo.
      返回:
        “高德地图”Logo的位置常量。屏幕左下角：`AMapOptions.LOGO_POSITION_BOTTOM_LEFT` 底部居中：`AMapOptions.LOGO_POSITION_BOTTOM_CENTER` 右下：`AMapOptions.LOGO_MARGIN_RIGHT`
        Position constants for the "Amap" logo. Bottom-left corner of the screen: `AMapOptions.LOGO_POSITION_BOTTOM_LEFT` Bottom center: `AMapOptions.LOGO_POSITION_BOTTOM_CENTER` Bottom-right: `AMapOptions.LOGO_MARGIN_RIGHT`
      从以下版本开始:
        2.0.2

    - #### isIndoorSwitchEnabled

          public boolean isIndoorSwitchEnabled()

      返回室内地图楼层切换控件是否显示。
      Returns whether the floor switching control of the indoor map is displayed.
      返回:
        是否显示。
        Whether to display.
      从以下版本开始:
        3.3.0

    - #### setIndoorSwitchEnabled

          public void setIndoorSwitchEnabled(boolean isIndoorSwitchEnabled)

      设置室内地图楼层切换控件是否可见。
      Sets whether the floor switching control of the indoor map is visible.
      参数:
        `isIndoorSwitchEnabled` - true 为可见；false 不可见。
        true for visible, false for invisible.
      从以下版本开始:
        3.3.0

    - #### setLogoLeftMargin

          public final void setLogoLeftMargin(int pixels)

      设置Logo左边界距离屏幕左侧的边距
      Sets the margin of the left boundary of the logo from the left side of the screen.
      参数:
        `pixels` - 像素
      从以下版本开始:
        4.0.0

    - #### setLogoBottomMargin

          public final void setLogoBottomMargin(int pixels)

      设置Logo下边界距离屏幕底部的边距
      Sets the margin of the bottom boundary of the logo from the bottom of the screen.
      参数:
        `pixels` - 像素
      从以下版本开始:
        4.0.0

    - #### setGestureScaleByMapCenter

          public void setGestureScaleByMapCenter(boolean isGestureScaleByMapCenter)

      设置是否以地图中心点缩放
      注：优先级低于`AMap.setPointToCenter(int, int)`
      Sets whether to zoom at the center of the map
      Note: The priority is lower than `AMap.setPointToCenter(int, int)`
      参数:
        `isGestureScaleByMapCenter` - true:以地图中心的进行缩放,false:不以地图中心的进行缩放
        true: zoom at the center of the map, false: do not zoom at the center of the map
      从以下版本开始:
        4.1.3

    - #### isGestureScaleByMapCenter

          public boolean isGestureScaleByMapCenter()

      返回是否以地图中心点缩放
      Returns whether to zoom at the center of the map
      返回:
        true 以地图中心点缩放；false 不以地图中心点缩放
        true: zoom at the center of the map; false: do not zoom at the center of the map
      从以下版本开始:
        4.1.3

    - #### isLogoEnable

          protected boolean isLogoEnable()

    - #### setScaleControlsPosition

          public void setScaleControlsPosition(android.graphics.Point position)

      设置比例尺控件位置
      Set the position of the scale control
      参数:
        `position` - 位置坐标，传入 null 时保持默认位置
        Position coordinates, null means keep the default position
      从以下版本开始:
        11.1.200

    - #### setScaleControlsUnit

          public void setScaleControlsUnit(UiSettings.ScaleControlsUnit unit)

      设置比例尺单位
      Set the unit used by the scale control.
      参数:
        `unit` - 单位类型
        unit The unit type to use for the scale control
      从以下版本开始:
        11.1.200

    - #### getScaleControlsUnit

          public UiSettings.ScaleControlsUnit getScaleControlsUnit()

      获取当前比例尺单位
      Get the current unit used by the scale control.
      返回:
        当前单位
        The currently set scale control unit
      从以下版本开始:
        11.1.200