TencentMapOptions (shell-vector-api API)

java.lang.Object
- com.tencent.tencentmap.mapsdk.maps.TencentMapOptions

public final class TencentMapOptions
extends java.lang.Object

Since:: 2019-12-06

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TencentMapOptions.IMapKernel
地图类型

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TencentMapOptions.IMapKernel` 地图类型

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOGO_POSITION_BOTTOM_CENTER` 设置地图logo的显示位置：底部居中
`static int`	`LOGO_POSITION_BOTTOM_LEFT` 设置地图logo的显示位置：左下角
`static int`	`LOGO_POSITION_BOTTOM_RIGHT` 设置地图logo的显示位置：右下角(默认)
`static int`	`LOGO_POSITION_TOP_CENTER` 设置地图logo的显示位置：顶部居中
`static int`	`LOGO_POSITION_TOP_LEFT` 设置地图logo的显示位置：左上角
`static int`	`LOGO_POSITION_TOP_RIGHT` 设置地图logo的显示位置：右上角
`static int`	`SCALEVIEW_POSITION_BOTTOM_CENTER` 设置地图比例尺的显示位置：底部居中
`static int`	`SCALEVIEW_POSITION_BOTTOM_LEFT` 设置地图比例尺的显示位置：左下角,默认
`static int`	`SCALEVIEW_POSITION_BOTTOM_RIGHT` 设置地图比例尺的显示位置：右下角
`static int`	`SCALEVIEW_POSITION_TOP_CENTER` 设置地图比例尺的显示位置：顶部居中
`static int`	`SCALEVIEW_POSITION_TOP_LEFT` 设置地图比例尺的显示位置：左上角
`static int`	`SCALEVIEW_POSITION_TOP_RIGHT` 设置地图比例尺的显示位置：右上角
`static int`	`ZOOM_POSITION_BOTTOM_LEFT` 设置地图缩放控件的显示位置：左下角
`static int`	`ZOOM_POSITION_BOTTOM_RIGHT` 设置地图缩放控件的显示位置：右下角，默认
`static int`	`ZOOM_POSITION_TOP_LEFT` 设置地图缩放控件的显示位置：左上角
`static int`	`ZOOM_POSITION_TOP_RIGHT` 设置地图缩放控件的显示位置：右上角

Constructor Summary

Constructors
Constructor and Description

TencentMapOptions()

Constructors
Constructor and Description
`TencentMapOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getCustomAssetsPath()` 获取个性化底图资源文件在 assets 目录中的路径
`java.lang.String`	`getCustomLocalPath()` 获取个性化底图资源文件在本地目录中的绝对路径
`java.lang.String`	`getCustomUserId()` 获取用户自定义的UID
`java.lang.String[]`	`getDebugTags()` 获取Debug模式的标签
`java.lang.Object`	`getExtSurface()` 获取用户指定地图渲染 surface
`int`	`getExtSurfaceHeight()` 获取扩展屏幕的高度
`int`	`getExtSurfaceWidth()` 获取扩展屏幕的宽度
`<any>`	`getMapAsyncCallback()` 获取异步回调
`TencentMapOptions.IMapKernel`	`getMapKernel()` 获取地图核心类型
`java.lang.String`	`getMapKey()` 获取用户设置的地图KEY
`MapViewType`	`getMapViewType()` 获得用户设置的地图视图类型
`AdapterType`	`getNetAdapterType()` 获取网络适配器类型
`Bundle`	`getNetParams()` 获取网络适配器初始化参数
`java.lang.Object`	`getProtocolDataDesc()` 获取协议数据描述
`int`	`getProtocolFrom()` 获取协议来源
`java.lang.String`	`getSatelliteVersion()` 获取配置的卫星图版本
`java.lang.String`	`getSubId()` 获取附加 appId
`java.lang.String`	`getSubKey()` 设置附加 key
`Typeface`	`getTypeface()` 获取当前地图的字体
`int`	`hashCode()`
`boolean`	`isHandDrawMapEnable()` 是否使用手绘图
`boolean`	`isMultipleInfoWindowEnable()` 是否允许显示多InfoWindow
`void`	`openDebugLogByTags(java.lang.String... tags)` 打开调试日志
`void`	`setCustomAssetsPath(java.lang.String customAssetsPath)` 设置个性化底图资源文件在 assets 目录中的路径
`void`	`setCustomLocalPath(java.lang.String customLocalPath)` 设置个性化底图资源文件在本地目录中的绝对路径
`TencentMapOptions`	`setCustomUserID(java.lang.String cuid)` 设置用户自定义的UID 此id会加入到网络请求的参数列表中，用户可以通过"cuid"加以识别
`void`	`setExtSurface(java.lang.Object surface)` 设置用户指定地图要渲染到的 surface(类型可支持Surface/SurfaceTexture/SurfaceHolder)
`void`	`setExtSurfaceDimension(int width, int height)` 设置外部传入的Surface or SurfaceTexture的尺寸
`TencentMapOptions`	`setGetMapAsync(<any> callback)` 设置异步获取地图对象注意：在代码中，设置异步获取地图对象之后，在创建MapView时，不能直接调用`MapView.getMap()`来获取地图对象，需要等回调返回之后才能做后续的地图操作，否则会出现地图对象为NULL。
`TencentMapOptions`	`setHandDrawMapEnable(boolean enable)` 设置是否使用手绘图
`TencentMapOptions`	`setMapKernel(TencentMapOptions.IMapKernel kernel)` 设置地图核心类型
`void`	`setMapKey(java.lang.String mapKey)` 用户设置的地图KEY
`TencentMapOptions`	`setMapViewType(MapViewType mapViewType)` 设置视图容器类型
`void`	`setMultipleInfoWindowEnable(boolean isEnable)` 设置是否允许显示多InfoWindow,默认地图中只允许显示一个InfoWindow
`TencentMapOptions`	`setNetAdapter(AdapterType adapterType, Bundle params)` 设置网络适配器类型
`TencentMapOptions`	`setSatelliteVersion(java.lang.String version)` 设置卫星图配置版本
`TencentMapOptions`	`setServiceProtocol(int protocolFrom, java.lang.Object protocolDataDesc)` 设置服务协议
`void`	`setSubInfo(java.lang.String subKey, java.lang.String subId)` 设置附加的 key 信息
`void`	`setTypeface(Typeface typeface)` 设置自定义字体
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOGO_POSITION_BOTTOM_LEFT
```
public static final int LOGO_POSITION_BOTTOM_LEFT
```
    设置地图logo的显示位置：左下角
    
    See Also:
    
    Constant Field Values
  - LOGO_POSITION_BOTTOM_RIGHT
```
public static final int LOGO_POSITION_BOTTOM_RIGHT
```
    设置地图logo的显示位置：右下角(默认)
    
    See Also:
    
    Constant Field Values
  - LOGO_POSITION_TOP_RIGHT
```
public static final int LOGO_POSITION_TOP_RIGHT
```
    设置地图logo的显示位置：右上角
    
    See Also:
    
    Constant Field Values
  - LOGO_POSITION_TOP_LEFT
```
public static final int LOGO_POSITION_TOP_LEFT
```
    设置地图logo的显示位置：左上角
    
    See Also:
    
    Constant Field Values
  - LOGO_POSITION_BOTTOM_CENTER
```
public static final int LOGO_POSITION_BOTTOM_CENTER
```
    设置地图logo的显示位置：底部居中
    
    See Also:
    
    Constant Field Values
  - LOGO_POSITION_TOP_CENTER
```
public static final int LOGO_POSITION_TOP_CENTER
```
    设置地图logo的显示位置：顶部居中
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_BOTTOM_LEFT
```
public static final int SCALEVIEW_POSITION_BOTTOM_LEFT
```
    设置地图比例尺的显示位置：左下角,默认
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_BOTTOM_RIGHT
```
public static final int SCALEVIEW_POSITION_BOTTOM_RIGHT
```
    设置地图比例尺的显示位置：右下角
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_TOP_RIGHT
```
public static final int SCALEVIEW_POSITION_TOP_RIGHT
```
    设置地图比例尺的显示位置：右上角
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_TOP_LEFT
```
public static final int SCALEVIEW_POSITION_TOP_LEFT
```
    设置地图比例尺的显示位置：左上角
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_BOTTOM_CENTER
```
public static final int SCALEVIEW_POSITION_BOTTOM_CENTER
```
    设置地图比例尺的显示位置：底部居中
    
    See Also:
    
    Constant Field Values
  - SCALEVIEW_POSITION_TOP_CENTER
```
public static final int SCALEVIEW_POSITION_TOP_CENTER
```
    设置地图比例尺的显示位置：顶部居中
    
    See Also:
    
    Constant Field Values
  - ZOOM_POSITION_BOTTOM_LEFT
```
public static final int ZOOM_POSITION_BOTTOM_LEFT
```
    设置地图缩放控件的显示位置：左下角
    
    See Also:
    
    Constant Field Values
  - ZOOM_POSITION_BOTTOM_RIGHT
```
public static final int ZOOM_POSITION_BOTTOM_RIGHT
```
    设置地图缩放控件的显示位置：右下角，默认
    
    See Also:
    
    Constant Field Values
  - ZOOM_POSITION_TOP_RIGHT
```
public static final int ZOOM_POSITION_TOP_RIGHT
```
    设置地图缩放控件的显示位置：右上角
    
    See Also:
    
    Constant Field Values
  - ZOOM_POSITION_TOP_LEFT
```
public static final int ZOOM_POSITION_TOP_LEFT
```
    设置地图缩放控件的显示位置：左上角
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TencentMapOptions
```
public TencentMapOptions()
```
- Method Detail
  - getCustomAssetsPath
```
public final java.lang.String getCustomAssetsPath()
```
    获取个性化底图资源文件在 assets 目录中的路径
  - setCustomAssetsPath
```
public final void setCustomAssetsPath(java.lang.String customAssetsPath)
```
    设置个性化底图资源文件在 assets 目录中的路径
    
    Parameters:
    
    customAssetsPath -
  - getCustomLocalPath
```
public final java.lang.String getCustomLocalPath()
```
    获取个性化底图资源文件在本地目录中的绝对路径
    
    Returns:
  - setCustomLocalPath
```
public final void setCustomLocalPath(java.lang.String customLocalPath)
```
    设置个性化底图资源文件在本地目录中的绝对路径
    
    Parameters:
    
    customLocalPath -
  - setHandDrawMapEnable
```
public final TencentMapOptions setHandDrawMapEnable(boolean enable)
```
    设置是否使用手绘图
    
    Parameters:
    
    enable -
  - isHandDrawMapEnable
```
public final boolean isHandDrawMapEnable()
```
    是否使用手绘图
    
    Returns:
  - getExtSurface
```
public final java.lang.Object getExtSurface()
```
    获取用户指定地图渲染 surface
    
    Returns:
  - setExtSurface
```
public final void setExtSurface(java.lang.Object surface)
```
    设置用户指定地图要渲染到的 surface(类型可支持Surface/SurfaceTexture/SurfaceHolder)
    
    Parameters:
    
    surface -
  - setTypeface
```
public final void setTypeface(Typeface typeface)
```
    设置自定义字体
    地图内部字体统一使用 Typeface#DEFAULT，默认修改仅影响地图内字体
    
    Parameters:
    
    typeface - 自定义字体库
  - getTypeface
```
public Typeface getTypeface()
```
    获取当前地图的字体
    
    Returns:
    
    字体库
  - getDebugTags
```
public java.lang.String[] getDebugTags()
```
    获取Debug模式的标签
    
    Returns:
    
    标签数组
  - setExtSurfaceDimension
```
public final void setExtSurfaceDimension(int width,
                                         int height)
```
    设置外部传入的Surface or SurfaceTexture的尺寸
    
    Parameters:
    
    width -
    
    height -
  - getExtSurfaceWidth
```
public final int getExtSurfaceWidth()
```
    获取扩展屏幕的宽度
    
    Returns:
    
    宽度
  - getExtSurfaceHeight
```
public final int getExtSurfaceHeight()
```
    获取扩展屏幕的高度
    
    Returns:
    
    高度
  - setSubInfo
```
public final void setSubInfo(java.lang.String subKey,
                             java.lang.String subId)
```
    设置附加的 key 信息
    
    Parameters:
    
    subKey - 附加 key，这个 key 与 manifest 里面的 key 都是从 lbs.qq.com 获取的
    
    subId - 附加 appId
  - getSubId
```
public final java.lang.String getSubId()
```
    获取附加 appId
    
    Returns:
    
    子AppId
  - getSubKey
```
public final java.lang.String getSubKey()
```
    设置附加 key
    
    Returns:
    
    子Key
  - setMapKey
```
public final void setMapKey(java.lang.String mapKey)
```
    用户设置的地图KEY
    
    Parameters:
    
    mapKey -
    
    Since:
    
    4.2.9
  - getMapKey
```
public final java.lang.String getMapKey()
```
    获取用户设置的地图KEY
    
    Returns:
    
    地图KEY
    
    Since:
    
    4.2.9
  - openDebugLogByTags
```
public final void openDebugLogByTags(java.lang.String... tags)
```
    打开调试日志
    注意：请不要在线上环境打开此开关
    
    Parameters:
    
    tags -
    
    Since:
    
    4.2.9
  - setMultipleInfoWindowEnable
```
public final void setMultipleInfoWindowEnable(boolean isEnable)
```
    设置是否允许显示多InfoWindow,默认地图中只允许显示一个InfoWindow
    
    Parameters:
    
    isEnable -
  - isMultipleInfoWindowEnable
```
public final boolean isMultipleInfoWindowEnable()
```
    是否允许显示多InfoWindow
    
    Returns:
  - setSatelliteVersion
```
public TencentMapOptions setSatelliteVersion(java.lang.String version)
```
    设置卫星图配置版本
    
    Parameters:
    
    version - 版本名
    
    Returns:
    
    更新之后的Options对象
    
    Since:
    
    4.3.0
  - getSatelliteVersion
```
public java.lang.String getSatelliteVersion()
```
    获取配置的卫星图版本
    
    Returns:
    
    版本名
    
    Since:
    
    4.3.0
  - setMapViewType
```
public final TencentMapOptions setMapViewType(MapViewType mapViewType)
```
    设置视图容器类型
    
    Parameters:
    
    mapViewType -
    
    Returns:
  - getMapViewType
```
public MapViewType getMapViewType()
```
    获得用户设置的地图视图类型
    
    Returns:
    
    地图视图类型
  - setMapKernel
```
public final TencentMapOptions setMapKernel(TencentMapOptions.IMapKernel kernel)
```
    设置地图核心类型
    
    Parameters:
    
    kernel -
  - getMapKernel
```
public TencentMapOptions.IMapKernel getMapKernel()
```
    获取地图核心类型
    
    Returns:
    
    地图核心类型
  - setServiceProtocol
```
public TencentMapOptions setServiceProtocol(int protocolFrom,
                                            java.lang.Object protocolDataDesc)
```
    设置服务协议
    
    Parameters:
    
    protocolFrom - 资源来源参考 TencentMapResource.ResourceFrom
    
    protocolDataDesc - 资源数据
  - getProtocolFrom
```
public int getProtocolFrom()
```
    获取协议来源
    
    Returns:
  - getProtocolDataDesc
```
public java.lang.Object getProtocolDataDesc()
```
    获取协议数据描述
    
    Returns:
  - setNetAdapter
```
public TencentMapOptions setNetAdapter(AdapterType adapterType,
                                       Bundle params)
```
    设置网络适配器类型
    
    Parameters:
    
    adapterType - 适配器类型
    
    params - 初始化参数
  - getNetAdapterType
```
public AdapterType getNetAdapterType()
```
    获取网络适配器类型
    
    Returns:
    
    网络适配器类型
  - getNetParams
```
public Bundle getNetParams()
```
    获取网络适配器初始化参数
    
    Returns:
    
    网络适配器初始化参数
  - setCustomUserID
```
public TencentMapOptions setCustomUserID(java.lang.String cuid)
```
    设置用户自定义的UID 此id会加入到网络请求的参数列表中，用户可以通过"cuid"加以识别
    
    Parameters:
    
    cuid -
    
    Since:
    
    4.3.3
  - getCustomUserId
```
public java.lang.String getCustomUserId()
```
    获取用户自定义的UID
    
    Returns:
    
    CUID
  - setGetMapAsync
```
public TencentMapOptions setGetMapAsync(<any> callback)
```
    设置异步获取地图对象注意：在代码中，设置异步获取地图对象之后，在创建MapView时，不能直接调用MapView.getMap()来获取地图对象，需要等回调返回之后才能做后续的地图操作，否则会出现地图对象为NULL。
    
    Parameters:
    
    callback - 异步回调，回调方法在主线程执行
  - getMapAsyncCallback
```
public <any> getMapAsyncCallback()
```
    获取异步回调
    
    Returns:
    
    异步回调
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TencentMapOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGO_POSITION_BOTTOM_LEFT

LOGO_POSITION_BOTTOM_RIGHT

LOGO_POSITION_TOP_RIGHT

LOGO_POSITION_TOP_LEFT

LOGO_POSITION_BOTTOM_CENTER

LOGO_POSITION_TOP_CENTER

SCALEVIEW_POSITION_BOTTOM_LEFT

SCALEVIEW_POSITION_BOTTOM_RIGHT

SCALEVIEW_POSITION_TOP_RIGHT

SCALEVIEW_POSITION_TOP_LEFT

SCALEVIEW_POSITION_BOTTOM_CENTER

SCALEVIEW_POSITION_TOP_CENTER

ZOOM_POSITION_BOTTOM_LEFT

ZOOM_POSITION_BOTTOM_RIGHT

ZOOM_POSITION_TOP_RIGHT

ZOOM_POSITION_TOP_LEFT

Constructor Detail

TencentMapOptions

Method Detail

getCustomAssetsPath

setCustomAssetsPath

getCustomLocalPath

setCustomLocalPath

setHandDrawMapEnable

isHandDrawMapEnable

getExtSurface

setExtSurface

setTypeface

getTypeface

getDebugTags

setExtSurfaceDimension

getExtSurfaceWidth

getExtSurfaceHeight

setSubInfo

getSubId

getSubKey

setMapKey

getMapKey

openDebugLogByTags

setMultipleInfoWindowEnable

isMultipleInfoWindowEnable

setSatelliteVersion

getSatelliteVersion

setMapViewType

getMapViewType

setMapKernel

getMapKernel

setServiceProtocol

getProtocolFrom

getProtocolDataDesc

setNetAdapter

getNetAdapterType

getNetParams

setCustomUserID

getCustomUserId

setGetMapAsync

getMapAsyncCallback

equals

hashCode

toString