Tencent Location Service JavaScript API GL

https://lbs.qq.com/webApi/javascriptGL/glDoc
Admin
Tencent Location Service JavaScript API GL is a web mapping library that provides map visualization,...
Tokens:131,069
Snippets:769
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### onInit(options) (抽象方法)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocDomOverlay

实现这个接口来定义构造阶段的初始化过程，此方法在构造函数中被调用，接收构造函数的options参数作为输入。

```APIDOC
## onInit(options) (抽象方法)

### Description
实现这个接口来定义构造阶段的初始化过程，此方法在构造函数中被调用，接收构造函数的options参数作为输入。

### Method
Abstract Method

### Endpoint
onInit(options)

### Parameters
#### Parameters
- **options** - Required - 构造函数的options参数

### Response
#### Success Response
无返回值。
```

--------------------------------

### getGeometries()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocVector

Gets the multi-circle data.

```APIDOC
## getGeometries()

### Description
Gets the multi-circle data.

### Method
getGeometries

### Returns
- CircleGeometry[] - The array of circle geometries.

```

--------------------------------

### Example 2: Asynchronously Load API and Display Map

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Shows how to load the API asynchronously using a callback and then create a map.

```APIDOC
## Example 2: Asynchronously Load API and Display Map

### Description
This example demonstrates how to load the API asynchronously using a callback and then create a map.

### Code
```html
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>异步加载地图</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no" />
    <style type="text/css">
        html,
        body {
            height: 100%;
            margin: 0px;
            padding: 0px
        }
        #container {
            width: 100%;
            height: 100%
        }
    </style>
</head>
 
<body>
    <div id="container"></div>
    <script>
    function initMap() {
        var map = new TMap.Map("container", {
            pitch:45,
            zoom:12,
            center: new TMap.LatLng(39.984104, 116.307503)
        });
    }
    function loadScript() {
        //创建script标签，并设置src属性添加到body中
        var script = document.createElement("script");
        script.type = "text/javascript";
        script.src = "https://map.qq.com/api/gljs?v=1.exp&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77&callback=initMap";
        document.body.appendChild(script);
    }
    window.onload = loadScript;
    </script>
</body>
</html>
```
```

--------------------------------

### getGeometries()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocVector

Gets the polyline data.

```APIDOC
## getGeometries()

### Description
Gets the polyline data.

### Method
getGeometries

### Returns
- **PolylineGeometry[]** - Array of polyline geometries.
```

--------------------------------

### startAnimation(keyFrames: GLTFKeyFrame[], opt: AnimationOptions{})

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Starts a keyframe animation.

```APIDOC
## startAnimation(keyFrames: GLTFKeyFrame[], opt: AnimationOptions{})

### Description
Starts a keyframe animation.

### Parameters
- **keyFrames** (GLTFKeyFrame[]) - Required - The keyframes for the animation.
- **opt** (AnimationOptions{}) - Required - Animation options.

### Returns
- this (GLTFModel) - The model instance for chaining.

```

--------------------------------

### getCenter()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the center of the map.

```APIDOC
## getCenter()

### Description
Gets the center of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a LatLng object representing the center.

```

--------------------------------

### Example 1: Create a Map in a Div Container

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Shows how to initialize a TMap.Map instance inside a div container with rotation, pitch, zoom, and center options.

```APIDOC
## Example 1: Create a Map in a Div Container

### Description
This example demonstrates how to create a map inside a div container using the TMap.Map constructor.

### Code
```html
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>简单地图</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no" />
    <script charset="utf-8" src="https://map.qq.com/api/gljs?v=1.exp&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77"></script>
    <style type="text/css">
        html,
        body {
            height: 100%;
            margin: 0px;
            padding: 0px
        }
        #container {
            width: 100%;
            height: 100%
        }
    </style>
</head>
 
<body onload="initMap()">
    <div id="container"></div>
    <script type="text/javascript">
    function initMap() {
        var container = document.getElementById("container");
        var center = new TMap.LatLng(39.984104, 116.307503);
        //初始化地图
        var map = new TMap.Map(container, {
            rotation: 20,//设置地图旋转角度
            pitch:30, //设置俯仰角度（0~45）
            zoom:12,//设置地图缩放级别
            center: center//设置地图中心点坐标
        });
    }
    </script>
</body>
</html>
```
```

--------------------------------

### getVisible()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocLabel

Gets the visibility state.

```APIDOC
## getVisible()

### Description
Gets the visibility state.

### Method
getVisible

### Returns
- **visible** - The visibility state.
```

--------------------------------

### new TMap.service.Walking()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

Creates a Walking service instance for walking route planning.

```APIDOC
## new TMap.service.Walking()

### Description
Creates a Walking service instance for walking route planning.

### Constructor
new TMap.service.Walking()

### Methods
- **search(params: WalkingSearchParams)** - Returns Promise. Searches for a walking route. On success, resolves with WalkingPlan; on failure, rejects with ErrorResult.

```

--------------------------------

### getGeometries()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocLabel

Gets the label geometries.

```APIDOC
## getGeometries()

### Description
Gets the label geometries.

### Method
getGeometries

### Returns
- **LabelGeometry[]** - The array of label geometries.
```

--------------------------------

### MeasureTool.measureDistance()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocEditor

Starts a distance measurement. The user clicks on the map to add points and double-clicks to end. Returns a Promise that resolves with a DistanceMeasurementInfo object. If called during an ongoing measurement, the previous measurement is interrupted and a new one starts.

```APIDOC
## MeasureTool.measureDistance()

### Description
Starts a distance measurement. The user clicks on the map to add points and double-clicks to end. Returns a Promise that resolves with a DistanceMeasurementInfo object. If called during an ongoing measurement, the previous measurement is interrupted and a new one starts.

### Method
`measureDistance()`

### Return Value
- **Promise(DistanceMeasurementInfo)** - Resolves with a DistanceMeasurementInfo object when the measurement is complete.
```

--------------------------------

### startAnimation(keyFrames: MapKeyFrame[], opts: AnimationOptions)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Starts an animation defined by keyFrames.

```APIDOC
## startAnimation(keyFrames: MapKeyFrame[], opts: AnimationOptions)

### Description
Starts an animation defined by keyFrames.

### Method
Method

### Parameters
#### Path Parameters
- **keyFrames** (MapKeyFrame[]) - Required - The key frames for the animation.
- **opts** (AnimationOptions) - Required - Animation options.

### Response
#### Success Response
No return value.

```

--------------------------------

### new TMap.service.Transit(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

Creates a Transit service instance for public transit route planning. Accepts an options object to configure the service.

```APIDOC
## new TMap.service.Transit(options)

### Description
Creates a Transit service instance for public transit route planning. Accepts an options object to configure the service.

### Constructor
new TMap.service.Transit(options)

### Parameters
#### options (Object)
- **policy** (String) - Optional - Search strategy. Can be a sorting strategy (LEAST_TIME, LEAST_TRANSFER, LEAST_WALKING, RECOMMEND) and/or additional constraints (NO_SUBWAY, ONLY_SUBWAY, SUBWAY_FIRST). Multiple values can be combined with commas, e.g., "LEAST_TRANSFER,NO_SUBWAY".

### Methods
- **search(params: TransitSearchParams)** - Returns Promise. Searches for a public transit route. On success, resolves with TransitPlan; on failure, rejects with ErrorResult.
- **setPolicy(policy: String)** - Returns this. Sets the search strategy.
- **getPolicy()** - Returns String. Gets the current search strategy.

```

--------------------------------

### Marker3D.getVisible()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the visibility state of the layer.

```APIDOC
## Marker3D.getVisible()

### Description
Gets the visibility state of the layer.

### Method
getVisible

### Returns
- **Boolean** - The visibility state.
```

--------------------------------

### Marker3D.getGeometries()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the array of marker geometries.

```APIDOC
## Marker3D.getGeometries()

### Description
Gets the array of marker geometries.

### Method
getGeometries

### Returns
- **Marker3DGeometry[]** - The array of marker geometries.
```

--------------------------------

### new TMap.service.Bicycling()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

Creates a Bicycling service instance for bicycle route planning.

```APIDOC
## new TMap.service.Bicycling()

### Description
Creates a Bicycling service instance for bicycle route planning.

### Constructor
new TMap.service.Bicycling()

### Methods
- **search(params: BicyclingSearchParams)** - Returns Promise. Searches for a bicycle route. On success, resolves with BicyclingPlan; on failure, rejects with ErrorResult.

```

--------------------------------

### show()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Shows the model.

```APIDOC
## show()

### Description
Shows the model.

### Returns
- this (GLTFModel) - The model instance for chaining.

```

--------------------------------

### getMask()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the model mask area.

```APIDOC
## getMask()

### Description
Gets the model mask area.

### Returns
- LatLng[] - The mask area coordinates.

```

--------------------------------

### getScale()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the model scale ratio.

```APIDOC
## getScale()

### Description
Gets the model scale ratio.

### Returns
- Number[] - The scale values.

```

--------------------------------

### InfoWindowOptions 配置参数

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocInfo

信息窗配置参数，用于初始化 TMap.InfoWindow 实例。

```APIDOC
## InfoWindowOptions

### Description
信息窗配置参数。

### Properties
- **map** (Map) - Required - 显示信息窗的地图。
- **position** (LatLng) - Required - 信息窗的经纬度坐标。
- **content** (String) - Optional - 信息窗显示内容，默认为空字符串。当 enableCustom 为 true 时，需传入信息窗体的 dom 字符串。
- **zIndex** (Number) - Optional - 信息窗的 z-index 值，默认为 0。
- **offset** (Object) - Optional - 信息窗相对于 position 对应像素坐标的偏移量，x 方向向右偏移为正值，y 方向向下偏移为正值，默认为 {x:0, y:0}。
- **enableCustom** (Boolean) - Optional - 信息窗体样式是否为自定义，默认为 false。
```

--------------------------------

### getRotation()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the model rotation angle.

```APIDOC
## getRotation()

### Description
Gets the model rotation angle.

### Returns
- Number[] - The rotation angles.

```

--------------------------------

### ImageTileLayer.createCustomLayer(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocLayer

Creates a personalized layer configured on the platform. Returns a Promise that resolves to an ImageTileLayer object or null if authentication fails.

```APIDOC
## createCustomLayer(options: CustomLayerOptions)

### Description
Creates a personalized layer configured on the platform. Returns a Promise that resolves to an ImageTileLayer object or null if authentication fails.

### Method
`createCustomLayer(options: CustomLayerOptions)`

### Parameters
- **options** (CustomLayerOptions) - Required - Configuration for the custom layer.

### Returns
- **Promise** - A Promise that resolves to an ImageTileLayer object or null.
```

--------------------------------

### Asynchronously load the API and display a map

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

This example demonstrates how to load the Tencent Map GL JS API asynchronously by dynamically creating a script tag with a callback. The map is initialized in the initMap function after the API is loaded. The map is created with a pitch of 45, zoom of 12, and a center at the specified coordinates.

```html
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>异步加载地图</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no" />
    <style type="text/css">
        html,
        body {
            height: 100%;
            margin: 0px;
            padding: 0px
        }
        #container {
            width: 100%;
            height: 100%
        }
    </style>
</head>
 
<body>
    <div id="container"></div>
    <script>
    function initMap() {
        var map = new TMap.Map("container", {
            pitch:45,
            zoom:12,
            center: new TMap.LatLng(39.984104, 116.307503)
        });
    }
    function loadScript() {
        //创建script标签，并设置src属性添加到body中
        var script = document.createElement("script");
        script.type = "text/javascript";
        script.src = "https://map.qq.com/api/gljs?v=1.exp&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77&callback=initMap";
        document.body.appendChild(script);
    }
    window.onload = loadScript;
    </script>
</body>
</html>
```

--------------------------------

### getAnchor()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Gets the model anchor coordinates.

```APIDOC
## getAnchor()

### Description
Gets the model anchor coordinates.

### Returns
- Number[] - The anchor coordinates.

```

--------------------------------

### TMap.InfoWindow 构造函数

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocInfo

创建信息窗覆盖物实例，需传入 InfoWindowOptions 配置参数。

```APIDOC
## TMap.InfoWindow(options: InfoWindowOptions)

### Description
创建信息窗覆盖物实例。

### Constructor
`TMap.InfoWindow(options: InfoWindowOptions)`

### Parameters
- **options** (InfoWindowOptions) - Required - 信息窗配置参数，包含 map、position、content 等。

### Example
```javascript
var infoWindow = new TMap.InfoWindow({
    map: map,
    position: center,
    content: "Hello World!"
});
```
```

--------------------------------

### getZIndex()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocVector

Gets the drawing order of the layer.

```APIDOC
## getZIndex()

### Description
Gets the drawing order of the layer.

### Method
getZIndex

### Returns
- Number - The drawing order value.

```

--------------------------------

### getZIndex()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocVector

Gets the layer drawing order.

```APIDOC
## getZIndex()

### Description
Gets the layer drawing order.

### Method
getZIndex

### Returns
- **Number** - The z-index value.
```

--------------------------------

### easeTo(mapStatus:Object, opts:EaseOptions)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Smoothly transitions to the specified state. mapStatus is key-value format and can set center, zoom, rotation, pitch.

```APIDOC
## easeTo(mapStatus:Object, opts:EaseOptions)

### Description
Smoothly transitions to the specified state. mapStatus is key-value format and can set center, zoom, rotation, pitch.

### Method
Method

### Parameters
#### Path Parameters
- **mapStatus** (Object) - Required - The target map status object.
- **opts** (EaseOptions) - Optional - Animation options.

### Response
#### Success Response
Returns `this` for chaining.

```

--------------------------------

### getIndoorManager()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the indoor map manager.

```APIDOC
## getIndoorManager()

### Description
Gets the indoor map manager.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns an IndoorManager object.

```

--------------------------------

### new TMap.weather.WeatherLayer(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glWeatherLayer

创建天气图层，用户传入对应瓦片key、tileUrl、time和天气图类型，即可生成对应的气象图效果。

```APIDOC
## new TMap.weather.WeatherLayer(options)

### Description
创建天气图层，用户传入对应瓦片key、tileUrl、time和天气图类型，即可生成对应的气象图效果。

### Constructor
new TMap.weather.WeatherLayer(options)

### Parameters
#### options (WeatherLayerOptions) - Required
天气图层参数，包含以下字段：

- **map** (Map) - Required - 展示图层的地图对象
- **tileUrl** (string) - Required - 天气数据上传后返回的瓦片服务地址
- **weatherType** (WEATHER_TYPE) - Required - 标识灰度图色值类型，类型常量见TMap.constants.WEATHER_TYPE，目前已知有云图 CLOUD ，温度 TEMPRATURE,低云LOWCLOUD
- **time** (string) - Required - 数据时间点，字符串类型
- **key** (string) - Required - 用户上传瓦片后返回的数据标识key
- **colorMap** (GradientColor) - Optional - 色系映射方案，配置渐变色，当前图层下GradientColor 不支持设置angle，默认为0
- **minZoom** (Number) - Optional - 最小缩放层级，当地图缩放层级小于该值时该图层不显示，不填默认3
- **maxZoom** (Number) - Optional - 最大缩放层级，当地图缩放层级大于该值时该图层不显示， 不填默认20
- **maxDataZoom** (Number) - Optional - 最大数据层级，当缩放层级大于该值时不再加载新数据，而是以此层级数据拉伸进行展示（最大拉伸等级为9级），默认为等于maxZoom
- **enableBubble** (Boolean) - Optional - 是否将图层的鼠标事件冒泡到地图上，默认值为true。

### Events
- **click** (WeatherLayerEvent) - 鼠标左键单击图层时触发
- **hover** (WeatherLayerEvent) - 鼠标在图层上悬停位置改变时触发

### WeatherLayerEvent 对象规范
天气图层事件返回参数规范。

- **value** (Number) - 事件发生位置的对应图层属性值，如云图、低云图代表云量，温度图代表温度（摄氏度）
- **rgba** (Array) - 返回灰度瓦片的像素值（注： 不是当前渲染瓦片的像素颜色值），如[255,255,255, 1]
- **latLng** (LatLng) - 事件发生时的经纬度坐标
- **point** (Object) - 事件发生时的屏幕位置，返回{x:Number, y:Number}格式
- **type** (String) - 事件类型
- **target** (Object) - 事件的目标对象
- **originalEvent** (MouseEvent 或 TouchEvent) - 浏览器原生的事件对象

### TMap.weather.constants.WEATHER_TYPE 常量说明
天气图层类型常量。

- **WEATHER_TYPE.CLOUD** - 云图
- **WEATHER_TYPE.TEMPERATURE** - 温度层
- **WEATHER_TYPE.LOW_CLOUD** - 低云图
```

--------------------------------

### getViewMode()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the view mode of the map.

```APIDOC
## getViewMode()

### Description
Gets the view mode of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a String representing the view mode.

```

--------------------------------

### new TMap.service.Suggestion(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

创建关键词输入提示服务实例，用于获取输入关键字的补完与提示。

```APIDOC
## new TMap.service.Suggestion(options)

### Description
创建关键词输入提示服务实例，用于获取输入关键字的补完与提示。

### Constructor
new TMap.service.Suggestion(options)

### Parameters
#### options (Object) - Required
配置参数对象，包含以下字段：
- **pageSize** (Number) - Optional - 每页条目数，最大限制为20条，默认为10条
- **region** (String) - Optional - 限制城市范围，根据城市名称限制地域范围，如，仅获取“广州市”范围内的提示内容；缺省时侧进行全国范围搜索
- **regionFix** (Boolean) - Optional - false：[默认]当前城市无结果时，自动扩大范围到全国匹配；true：固定在当前城市
- **policy** (Number) - Optional - 检索策略，目前支持：policy=0：默认，常规策略；policy=1：本策略主要用于收货地址、上门服务地址的填写，提高了小区类、商务楼宇、大学等分类的排序，过滤行政区、道路等分类（如海淀大街、朝阳区等），排序策略引入真实用户对输入提示的点击热度，使之更为符合此类应用场景，体验更为舒适；policy=10：出行场景（网约车） – 起点查询；policy=11：出行场景（网约车） – 终点查询
- **filter** (String) - Optional - 筛选条件：基本语法：columnName<筛选列>=value<列值>；目前支持按POI分类筛选（例：category=分类词），若指定多个分类用英文逗号分隔，最多支持五个分类，支持的分类词可参考WebService API的相关说明

### Methods
- **getSuggestions(params: GetSuggestionsParams)** - Promise - 获取输入关键字的补完与提示，帮助用户快速输入；搜索完成后resolve状态下返回SuggestionResult，reject状态下返回ErrorResult
- **setPageSize(pageSize:Number)** - this - 设置每页返回的结果数量
- **setRegion(region: String)** - this - 设置城市范围
- **setRegionFix(regionFix: Boolean)** - this - 设置是否扩大匹配
- **setPolicy(policy: Number)** - this - 设置检索策略
- **setFilter(filter: String)** - this - 设置筛选条件
- **getPageSize()** - Number - 获取每页返回的结果数量
- **getRegion()** - String - 获取城市范围
- **getRegionFix()** - Boolean - 获取是否扩大匹配
- **getPolicy()** - Number - 获取检索策略
- **getFilter()** - String - 获取筛选条件
```

--------------------------------

### getBoundary()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the boundary limits of the map.

```APIDOC
## getBoundary()

### Description
Gets the boundary limits of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a LatLngBounds object representing the boundary.

```

--------------------------------

### new TMap.model.Marker3DStyle(options: Marker3DStyleOptions)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Marker3DStyle 构造函数，用于创建应用于 Marker3D 图层的样式对象。

```APIDOC
## new TMap.model.Marker3DStyle(options: Marker3DStyleOptions)

### Description
创建 Marker3DStyle 对象，用于定义 Marker3D 图层的样式。

### Constructor
`new TMap.model.Marker3DStyle(options: Marker3DStyleOptions)`

### Parameters
#### options (Marker3DStyleOptions) - Required
- **type** (String) - Optional - Marker3D类型，可选值为 `location`、`radiation`、`maglev`，默认为 `location`。
- **scale** (Number) - Optional - 模型在XYZ三轴上的缩放比例，默认为 1。
- **color** (String) - Optional - Marker3D颜色属性，支持 `rgb()`、`#RRGGBB` 等形式，默认值根据 type 不同：location 为 `#D81611`，maglev 为 `#1DFAF2`，radiation 为 `#E5811C`。

### Response
返回一个 Marker3DStyle 实例。
```

--------------------------------

### getDraggable()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets whether the map is draggable.

```APIDOC
## getDraggable()

### Description
Gets whether the map is draggable.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a Boolean indicating if the map is draggable.

```

--------------------------------

### new TMap.service.Search(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

创建搜索服务实例，可配置每页条目数。

```APIDOC
## new TMap.service.Search(options)

### Description
创建搜索服务实例，可配置每页条目数。

### Constructor
`new TMap.service.Search(options)`

### Parameters
- **options** (Object) - Required - 搜索类配置参数对象
  - **pageSize** (Number) - Optional - 每页条目数，最大限制为20条，默认为10条

```

--------------------------------

### getScale()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the display scale of the map.

```APIDOC
## getScale()

### Description
Gets the display scale of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a Number representing the scale.

```

--------------------------------

### new TMap.service.Driving(options)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocService

创建驾车路线规划服务实例，支持配置检索策略、是否返回多种方案、是否返回路线引导、车牌号、车辆类型等参数。

```APIDOC
## new TMap.service.Driving(options)

### Description
创建驾车路线规划服务实例，用于提供驾车路线规划服务，支持结合实时路况、少收费、不走高速等多种偏好，精准预估到达时间。

### Constructor
`new TMap.service.Driving(options)`

### Parameters
#### options (Object) - Required
- **policy** (String) - Optional - 检索策略。可选值：LEAST_TIME（默认，参考实时路况，时间最短）、PICKUP（网约车场景-接乘客）、TRIP（网约车场景-送乘客）。可与单项偏好参数并用，多选逗号分隔：REAL_TRAFFIC（参考实时路况）、LEAST_FEE（少收费）、AVOID_HIGHWAY（不走高速）、NAV_POINT_FIRST（通过终点坐标查找所在地点并使用地点出入口作为目的地）。
- **mp** (Boolean) - Optional - 是否返回多种方案：true 返回多种方案，false 返回一种方案。
- **noStep** (Boolean) - Optional - 是否不需路线引导：true 不需路线引导，false 需要路线引导。
- **plateNumber** (String) - Optional - 车牌号，填入后路线引擎会根据车牌对限行区域进行避让，不填不考虑限行问题。
- **carType** (Number) - Optional - 车辆类型：0（默认）普通汽车，1 新能源。

### Methods
- **search(params: DrivingSearchParams)** - Returns Promise - 搜索驾车路线；搜索完成后 resolve 状态下返回 DrivingPlan，reject 状态下返回 ErrorResult。
- **setPolicy(policy: String)** - Returns this - 设置检索策略。
- **setMp(mp: Boolean)** - Returns this - 设置是否返回多种方案。
- **setNoStep(noStep: Boolean)** - Returns this - 设置是否不需路线引导。
- **setPlateNumber(plateNumber: String)** - Returns this - 设置车牌号。
- **setCarType(carType: String)** - Returns this - 设置车辆类型。
- **getPolicy()** - Returns String - 获取检索策略。
- **getMp()** - Returns Boolean - 获取是否返回多种方案的设置。
- **getNoStep()** - Returns Boolean - 获取是否不需路线引导的设置。
- **getPlateNumber()** - Returns String - 获取车牌号。
- **getCarType()** - Returns Number - 获取车辆类型。

### Request Example
```json
{
  "policy": "LEAST_TIME,REAL_TRAFFIC",
  "mp": true,
  "noStep": false,
  "plateNumber": "京A12345",
  "carType": 0
}
```

### Response
#### Success Response
- **status** (Number) - 状态码，正常为0。
- **message** (String) - 状态说明。
- **result** (Object) - 搜索结果，包含 routes 数组。

#### Response Example
```json
{
  "status": 0,
  "message": "OK",
  "result": {
    "routes": []
  }
}
```
```

--------------------------------

### getPitch()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the pitch angle of the map.

```APIDOC
## getPitch()

### Description
Gets the pitch angle of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a Number representing the pitch angle.

```

--------------------------------

### MarkerStyleOptions

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocMarker

Configuration parameters for MarkerStyle.

```APIDOC
## MarkerStyleOptions

### Description
Configuration parameters for MarkerStyle.

### Properties
- **width** (Number) - Required - Width of the marker image, default 34.
- **height** (Number) - Required - Height of the marker image, default 50.
- **anchor** (Object) - Optional - Anchor position of the marker image, in the form {x: Number, y: Number}. The anchor point always corresponds to the marker position during map operations. Default { x: width/2, y: height }. Origin is top-left corner of the image.
- **src** (String) - Optional - URL or base64 address of the marker image. If URL, the server must allow cross-origin.
- **faceTo** (String) - Optional - Orientation of the marker image: 'map' (flat on ground) or 'screen' (upright). Default 'screen'.
- **enableRelativeScale** (Boolean) - Optional - Whether to enable scaling with map zoom. Default false (only for non-collision markers).
- **relativeScaleOptions** (RelativeScaleOptions) - Optional - Control parameters for scaling marker image and text with map zoom (only for non-collision markers).
- **rotate** (Number) - Optional - Rotation angle of the marker image in degrees, non-negative. Rotation origin is the anchor, counterclockwise positive.
- **opacity** (Number) - Optional - Opacity of the marker image, range 0-1.
- **color** (String) - Optional - Text color of the marker, supports rgb(), rgba(), #RRGGBB, etc. Default rgba(0,0,0,1).
- **strokeColor** (String) - Optional - Text stroke color, supports rgb(), rgba(), #RRGGBB, etc. Default rgba(0,0,0,0).
- **strokeWidth** (Number) - Optional - Text stroke width, default 1.
- **size** (Number) - Optional - Text font size, default 14.
- **direction** (String) - Optional - Position of text relative to the marker image: 'center', 'top', 'bottom', 'left', 'right'. Default 'center'.
- **offset** (Object) - Optional - Offset of text based on direction, in pixels, with text center as origin. x positive right, y positive down. Default {x:0, y:0}.
- **wrapOptions** (LabelWrapOptions) - Optional - Text wrapping options. Supports soft and hard wrapping. Soft wrap allows max width; hard wrap uses '\n'. If empty object, wraps at newline characters; if null or undefined, no wrapping.
- **padding** (String) - Optional - Padding of text background, in pixels. Accepts 1-2 values per CSS spec. Example: "15px" or "15px 20px". Note: padding is ignored if backgroundWidth/Height are set.
- **backgroundWidth** (Number) - Optional - Width of text background, in pixels, default 0.
- **backgroundHeight** (Number) - Optional - Height of text background, in pixels, default 0.
- **backgroundColor** (String) - Optional - Background color of text, supports rgb(), rgba(), #RRGGBB, etc. Requires padding or backgroundWidth/Height to be set. Default rgba(0,0,0,1).
- **backgroundBorderWidth** (Number) - Optional - Border width of text background, in pixels. Requires padding or backgroundWidth/Height. Default 0.
- **backgroundBorderRadius** (Number) - Optional - Border radius of text background, in pixels. Requires padding or backgroundWidth/Height. Default 0.
- **backgroundBorderColor** (String) - Optional - Border color of text background, supports rgb(), rgba(), #RRGGBB, etc. Requires padding or backgroundWidth/Height. Default rgba(0,0,0,0).
```

--------------------------------

### TMap.MultiMarker Constructor

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocMarker

Creates a new MultiMarker instance with the given options.

```APIDOC
## TMap.MultiMarker(options: MultiMarkerOptions)

### Description
Creates a new MultiMarker instance with the specified options.

### Constructor
TMap.MultiMarker(options: MultiMarkerOptions)

### Parameters
- **options** (MultiMarkerOptions) - Required - The options for the MultiMarker, including id, map, styles, and geometries.

### Example
```javascript
var marker = new TMap.MultiMarker({
    id: "marker-layer",
    map: map,
    styles: {
        "marker": new TMap.MarkerStyle({
            "width": 25,
            "height": 35,
            "anchor": { x: 16, y: 32 },
            "src": "img/marker.png"
        })
    },
    geometries: [{
        "id": "demo",
        "styleId": "marker",
        "position": new TMap.LatLng(39.984104, 116.307503),
        "properties": {
            "title": "marker"
        }
    }]
});
```
```

--------------------------------

### getZoom()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/docIndexMap

Gets the zoom level of the map.

```APIDOC
## getZoom()

### Description
Gets the zoom level of the map.

### Method
Method

### Parameters
None

### Response
#### Success Response
Returns a Number representing the zoom level.

```

--------------------------------

### getStyles()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocMarker

Gets the style information for the layer.

```APIDOC
## getStyles()

### Description
Gets the style information for the layer.

### Method
getStyles

### Returns
- **MultiMarkerStyleHash** - The style hash.
```

--------------------------------

### TMap.InfoWindow 事件

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocInfo

信息窗触发的事件，目前支持关闭按钮点击事件。

```APIDOC
## TMap.InfoWindow 事件

### Description
信息窗触发的事件，目前支持关闭按钮点击事件。

### Events

#### closeclick
- **参数**: none
- **说明**: 点击信息窗的关闭按钮时会触发此事件。
```

--------------------------------

### getGeometries()

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glDocMarker

Gets the point data array.

```APIDOC
## getGeometries()

### Description
Gets the point data array.

### Method
getGeometries

### Returns
- **PointGeometry[]** - The array of point geometries.
```

--------------------------------

### new TMap.model.Tileset3D(options: Tileset3DOptions)

Source: https://lbs.qq.com/webApi/javascriptGL/glDoc/glModel

Creates a 3D Tiles model object and adds it to the specified map. The options object must include the model URL and map instance.

```APIDOC
## Constructor: new TMap.model.Tileset3D(options: Tileset3DOptions)

### Description
Creates a 3D Tiles model object that can be overlaid on a map.

### Parameters
- **options** (Tileset3DOptions) - Required - Configuration object for the model.

### Tileset3DOptions Properties
- **url** (String) - Required - 3D Tiles model resource URL.
- **map** (Map) - Required - The map object on which to display the model.
- **id** (String) - Optional - Unique identifier for the model.
- **coordType** (String) - Optional - Coordinate system type, default 'gcj02', can be 'wgs84'.
- **mask** (LatLng[]) - Optional - Mask polygon that hides base map buildings and POIs within the enclosed area.
- **offset** (Number[]) - Optional - Offset coordinates [x, y, z] in meters, default [0, 0, 0].

### Example
```javascript
const tileset = new TMap.model.Tileset3D({
  url: 'https://example.com/model',
  map: map
});
```
```
Tokens:
Raw