Class UiSettings

地图内置UI及手势控制器。

Since

1.0.0

Constructors

constructor

Properties

uiSettingsDelegate

Methods

getLogoMarginRate getZoomPosition isCompassEnabled isGestureScaleByMapCenter isLogoEnable isMyLocationButtonEnabled isRotateGesturesEnabled isScaleControlsEnabled isScrollGesturesEnabled isTiltGesturesEnabled isZoomControlsEnabled isZoomGesturesEnabled setAllGesturesEnabled setCompassEnabled setGestureScaleByMapCenter setLogoBottomMargin setLogoLeftMargin setLogoMarginRate setLogoPosition setMyLocationButtonEnabled setRotateGesturesEnabled setScaleControlsEnabled setScrollGesturesEnabled setTiltGesturesEnabled setZoomControlsEnabled setZoomGesturesEnabled setZoomInByScreenCenter setZoomPosition

Constructors

constructor

  • new UiSettings(paramIUiSettingsDelegate): UiSettings

  • Parameters

    • paramIUiSettingsDelegate: IUiSettings

    Returns UiSettings

    Exclude

    javadoc中不显示

Properties

Private Readonly uiSettingsDelegate

uiSettingsDelegate: IUiSettings

Methods

getLogoMarginRate

  • getLogoMarginRate(type): number

  • 获取Logo到左边，右边，底边的比例

    Parameters

    • type: number


      AMapOptions#LOGO_MARGIN_LEFT 表示左边距比例
      AMapOptions#LOGO_MARGIN_RIGHT 表示右边距比例
      AMapOptions#LOGO_MARGIN_BOTTOM 表示到底边距比例

    Returns number

    比如0.5表示logo左边缘宽度占x轴的50%

    See

    #setLogoMarginRate(int, float)

    Since

    V2.0.0

    Exclude

    javadoc中不显示 滴滴使用

getZoomPosition

  • getZoomPosition(): number

  • 获取缩放按钮的位置。

    Returns number

    缩放按钮的位置常量。右边界中部：AMapOptions#ZOOM_POSITION_RIGHT_CENTER AMapOptions.ZOOM_POSITION_RIGHT_CENTER 右下：AMapOptions#ZOOM_POSITION_RIGHT_BUTTOM AMapOptions.ZOOM_POSITION_RIGHT_BUTTOM。

    Since

    V2.0.0

isCompassEnabled

  • isCompassEnabled(): boolean

  • 返回指南针控件是否可见。

    Returns boolean

    是否可见。

    Since

    V2.0.0

isGestureScaleByMapCenter

  • isGestureScaleByMapCenter(): boolean

  • 返回是否以地图中心点缩放

    Returns boolean

    true 以地图中心点缩放；false 不以地图中心点缩放

    Since

    1.0.0

isLogoEnable

  • isLogoEnable(): boolean

  • Returns boolean

isMyLocationButtonEnabled

  • isMyLocationButtonEnabled(): boolean

  • 返回定位按钮是否可见。

    Returns boolean

    是否可见。

    Since

    V2.0.0

isRotateGesturesEnabled

  • isRotateGesturesEnabled(): boolean

  • 返回旋转手势是否可用。

    Returns boolean

    是否可用。

    Since

    1.0.0

isScaleControlsEnabled

  • isScaleControlsEnabled(): boolean

  • 返回比例尺控件是否可见。

    Returns boolean

    是否可见。

    Since

    V2.0.0

isScrollGesturesEnabled

  • isScrollGesturesEnabled(): boolean

  • 返回拖拽手势是否可用。

    Returns boolean

    是否可用。

    Since

    1.0.0

isTiltGesturesEnabled

  • isTiltGesturesEnabled(): boolean

  • 返回倾斜手势是否可用。

    Returns boolean

    是否可用。

    Since

    1.0.0

isZoomControlsEnabled

  • isZoomControlsEnabled(): boolean

  • 返回缩放按钮是否可见。

    Returns boolean

    是否可见。

    Since

    V2.0

isZoomGesturesEnabled

  • isZoomGesturesEnabled(): boolean

  • 返回缩放手势是否可用。

    Returns boolean

    true 是否可用。

    Since

    1.0.0

setAllGesturesEnabled

  • setAllGesturesEnabled(enabled): void

  • 设置所有手势是否可用

    Parameters

    • enabled: boolean

      true为可用； false 为不可用。

    Returns void

    Since

    1.0.0

setCompassEnabled

  • setCompassEnabled(enabled): void

  • 设置指南针是否可见。

    Parameters

    • enabled: boolean

      true表示可见，false表示不可见。

    Returns void

    Since

    V2.0.0

setGestureScaleByMapCenter

  • setGestureScaleByMapCenter(isGestureScaleByMapCenter): void

  • 设置是否以地图中心点缩放
    注：优先级低于AMap#setPointToCenter(int, int)

    Parameters

    • isGestureScaleByMapCenter: boolean

      true:以地图中心的进行缩放,false:不以地图中心的进行缩放

    Returns void

    Since

    1.0.0

setLogoBottomMargin

  • setLogoBottomMargin(pixels): void

  • 设置Logo下边界距离屏幕底部的边距

    Parameters

    • pixels: number

      像素

    Returns void

    Since

    V2.0.0

setLogoLeftMargin

  • setLogoLeftMargin(pixels): void

  • 设置Logo左边界距离屏幕左侧的边距

    Parameters

    • pixels: number

      像素

    Returns void

    Since

    V2.0.0

setLogoMarginRate

  • setLogoMarginRate(type, rate): void

  • 设置logo到左边，右边，底边的比例

    Parameters

    • type: number


      AMapOptions#LOGO_MARGIN_LEFT 表示左边距比例
      AMapOptions#LOGO_MARGIN_RIGHT 表示右边距比例
      AMapOptions#LOGO_MARGIN_BOTTOM 表示到底边距比例

    • rate: number

      比如0.5表示logo左边缘宽度占x轴的50%

    Returns void

    Since

    V2.0.0

    Exclude

    javadoc中不显示 滴滴使用

setLogoPosition

  • setLogoPosition(position): void

  • 设置“高德地图”Logo的位置。

    Parameters

    • position: number

      位置参数。屏幕左下角：AMapOptions#LOGO_POSITION_BOTTOM_LEFT 底部居中：AMapOptions#LOGO_POSITION_BOTTOM_CENTER 右下：AMapOptions#LOGO_MARGIN_RIGHT

    Returns void

    Since

    V2.0.0

setMyLocationButtonEnabled

  • setMyLocationButtonEnabled(enabled): void

  • 设置定位按钮是否可见。

    Parameters

    • enabled: boolean

      true表示可见，false表示不可见。

    Returns void

    Since

    V2.0.0

setRotateGesturesEnabled

  • setRotateGesturesEnabled(enabled): void

  • 设置旋转手势是否可用。

    Parameters

    • enabled: boolean

      true为可用； false 为不可用。

    Returns void

    Since

    1.0.0

setScaleControlsEnabled

  • setScaleControlsEnabled(enabled): void

  • 设置比例尺控件是否可见

    Parameters

    • enabled: boolean

      true表示可见，false表示不可见。

    Returns void

    Since

    V2.0.0

setScrollGesturesEnabled

  • setScrollGesturesEnabled(enabled): void

  • 设置拖拽手势是否可用。

    Parameters

    • enabled: boolean

      true为可用； false 为不可用。

    Returns void

    Since

    1.0.0

setTiltGesturesEnabled

  • setTiltGesturesEnabled(enabled): void

  • 设置倾斜手势是否可用。

    Parameters

    • enabled: boolean

      true为可用； false 为不可用。

    Returns void

    Since

    1.0.0

setZoomControlsEnabled

  • setZoomControlsEnabled(enabled): void

  • 设置缩放按钮是否可见。

    Parameters

    • enabled: boolean

      true表示可见，false表示不可见。

    Returns void

    Since

    V2.0.0

setZoomGesturesEnabled

  • setZoomGesturesEnabled(enabled): void

  • 设置双指缩放手势是否可用。

    Parameters

    • enabled: boolean

      true为可用； false 为不可用。

    Returns void

    Since

    1.0.0

setZoomInByScreenCenter

  • setZoomInByScreenCenter(isZoomInByScreenCenter): void

  • 设置双击时,是否以屏幕中心点缩放，改接口只针对单指双击事件 注：优先级低于AMap#setPointToCenter(int, int)

    Parameters

    • isZoomInByScreenCenter: boolean

      true:以屏幕中心的进行缩放,false:不以屏幕中心的进行缩放

    Returns void

    Since

    V2.0.0

    Exclude

    javadoc中不显示 滴滴使用

setZoomPosition

  • setZoomPosition(position): void

  • 设置缩放按钮的位置。

    Parameters

    • position: number

      右边界中部：AMapOptions#ZOOM_POSITION_RIGHT_CENTER AMapOptions.ZOOM_POSITION_RIGHT_CENTER 右下：AMapOptions#ZOOM_POSITION_RIGHT_BUTTOM AMapOptions.ZOOM_POSITION_RIGHT_BUTTOM。

    Returns void

    Since

    V2.0.0

Settings

Member Visibility

Theme

On This Page

constructoruiSettingsDelegategetLogoMarginRategetZoomPositionisCompassEnabledisGestureScaleByMapCenterisLogoEnableisMyLocationButtonEnabledisRotateGesturesEnabledisScaleControlsEnabledisScrollGesturesEnabledisTiltGesturesEnabledisZoomControlsEnabledisZoomGesturesEnabledsetAllGesturesEnabledsetCompassEnabledsetGestureScaleByMapCentersetLogoBottomMarginsetLogoLeftMarginsetLogoMarginRatesetLogoPositionsetMyLocationButtonEnabledsetRotateGesturesEnabledsetScaleControlsEnabledsetScrollGesturesEnabledsetTiltGesturesEnabledsetZoomControlsEnabledsetZoomGesturesEnabledsetZoomInByScreenCentersetZoomPosition

Generated using TypeDoc