Didi Map Open Platform

https://lbs.xiaojukeji.com/docs/
Admin
Didi Map Open Platform provides standardized map, navigation, positioning, search, and traffic...
Tokens:208,122
Snippets:1,177
Trust Score:9.2
Update:10 months ago
Show doc for...
Tokens:
Raw
### Transit Route Planning API Request Example

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E8%B7%AF%E5%BE%84%E8%A7%84%E5%88%92

This example demonstrates how to make a GET request to the transit route planning API. It requires an API key, origin and destination coordinates, and the city name. Optional parameters like strategy and departure time can also be included.

```shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/transit?key=YOUR_API_KEY&origin=116.28184,40.04298&destination=116.28516,40.04979&city=北京市"
```

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

### Start Simulated Navigation

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveManager

Starts a simulated navigation session, useful for testing navigation logic without real GPS data.

```objective-c
- (BOOL)startEmulatorNavi
```

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

### DMKMapNaviDriveSimulate Start Simulation

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveSimulate

Starts the navigation simulation.

```APIDOC
## start

### Description
Starts the navigation simulation.

### Method
Objective-C

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```objectivec
[simulator start];
```

### Response
#### Success Response (200)
Void

#### Response Example
None
```

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

### Start DMKMapNaviDriveSimulate

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveSimulate

Starts the simulated navigation process. This method should be called after the simulator has been initialized.

```Objective-C
- (void)start
```

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

### 初始化导航SDK实例

Source: https://lbs.xiaojukeji.com/docs/ios/navsdk/3.2-rb

在使用导航相关功能前，需要调用 `DMKNavigationManager` 的 `setup` 方法来初始化公共实例。此步骤是使用SDK的前提。

```objc
#import <DMKNaviSDK/DMKNavigationManager.h>

//...

[DMKNavigationManager setup];

//...
```

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

### Project Dependencies (Gradle)

Source: https://lbs.xiaojukeji.com/docs/android/mapsdk/3.1-getStarted

Lists the necessary dependencies for an Android project using the Didi SDK, managed via Gradle. Requires a Gradle-based Android project setup.

```gradle
implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'androidx.legacy:legacy-support-v4:1.0.0'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
implementation 'androidx.media:media:1.0.0'

implementation 'org.greenrobot:eventbus:3.1.1'
implementation 'com.github.bumptech.glide:glide:4.11.0'
implementation 'com.squareup.wire:wire-runtime:1.6.1'
implementation 'com.squareup.okio:okio:2.8.0'
```

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

### Start Navigation After Route Calculation

Source: https://lbs.xiaojukeji.com/docs/android/navsdk/3.3%E4%B8%93%E4%B8%9A%E5%AF%BC%E8%88%AA

This code shows how to initiate navigation once a route has been successfully calculated. It handles selecting a specific route if multiple options are available before starting the navigation process.

```java
@Override
public void onCalculateRouteSuccess(DMapCalcRouteResult routeResult) {
    Log.i(TAG, "onCalculateRouteSuccess:" + routeResult);
    long[] routeIds = routeResult.getRouteId();
    // 默认选中第一条路线，如果有多条路线，想设置设置第二条路线导航的话，startNavi之前设置路线id
    if (routeIds != null && routeIds.length > 1) {
        dMapNavi.selectRouteId(routeIds[1]);
    }
    dMapNavi.startNavi();
}
```

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

### Start Navigation

Source: https://lbs.xiaojukeji.com/docs/ios/navsdk/3.3-navi

Initiates navigation. You can choose between full-screen navigation or a lightweight mode by passing a boolean value to the `startNavigation:` method.

```APIDOC
## POST /startNavigation

### Description
Initiates navigation with options for full-screen or lightweight mode.

### Method
POST

### Endpoint
`/startNavigation`

### Parameters
#### Query Parameters
- **fullscreen** (boolean) - Required - `YES` for full-screen, `NO` for lightweight navigation.

### Request Example
```json
{
  "fullscreen": true
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the navigation session has started.

#### Response Example
```json
{
  "status": "Navigation started successfully"
}
```
```

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

### Start Real-Time Navigation

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveManager

Starts real-time GPS navigation. This method can only be called after a route has been successfully calculated.

```objective-c
- (BOOL)startGPSNavi
```

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

### PolylineFeature Usage Example

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/vector-layer/PolylineFeature

Example demonstrating how to create a PolylineFeature, configure its properties, add it to a layer, and then add the layer to the map.

```APIDOC
## PolylineFeature Usage Example

### Description
Example demonstrating how to create a PolylineFeature, configure its properties, add it to a layer, and then add the layer to the map.

### Code Example

```javascript
const polylineFeature = new DiMap.PolylineFeature({
  geoData: [
    [116.405467, 39.907761],
    [116.415467, 39.917761],
    [116.425467, 39.927761],
    [116.435467, 39.937761]
  ],
  lineWidth: 2,
  lineColor: "#000",
  lineOpacity: 1,
  lineJoin: "miter",
  lineBlur: 0,
  lineGapWidth: 0,
  lineOffset: 0
});

const polylineLayer = new DiMap.PolylineLayer();
polylineFeature.addToLayer(polylineLayer);
polylineLayer.addToMap(map);
```
```

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

### ShapeEdit Plugin Initialization and Usage

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/editors/ShapeEdit

This example demonstrates how to initialize the ShapeEdit plugin and use it to edit a polygon. It includes adding a control button to trigger the editing functionality.

```APIDOC
## ShapeEdit Plugin Usage Example

### Description
This example demonstrates how to load the ShapeEdit plugin and use it to initiate editing for a polygon. It also shows how to add a custom control button to the map to toggle the editing mode.

### Method
Asynchronous loading and initialization using `DiMapLoader.load` and instantiation of `DiMapPlugin.ShapeEdit`.

### Endpoint
N/A (Client-side JavaScript API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
//以编辑多边形Polygon为例
window.DiMapLoader.load({
    key: "你申请的key",
    plugins: ["ShapeEdit"],
}).then(({ DiMap, DiMapPlugin }) => {
    // 添加 控制按钮
    const anchor = document.createElement("div")
    anchor.className = "control"
    anchor.style.zIndex = "9999"
    anchor.innerHTML = "多边形"
    anchor.style.position = "absolute"
    anchor.style.top = "10px"
    anchor.style.left = "10px"
    const mapContainer = map.getContainer()
    mapContainer.appendChild(anchor)

    // 创建图形编辑器
    const shapeEdit = new DiMapPlugin.ShapeEdit(map)

    anchor.onclick = () => {
      // 多边形编辑+吸附
      // 可编辑图形：多边形 Polygon、圆 Circle、线段 Line、矩形 Rectangle
      shapeEdit.edit("Polygon") 
    }
})
```

### Response
#### Success Response (200)
N/A (Client-side JavaScript execution)

#### Response Example
N/A
```

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

### HTML/JS: Initialize Map Correctly

Source: https://lbs.xiaojukeji.com/docs/jsapi/map/map-question

Provides a correct HTML and JavaScript example for initializing the map. It emphasizes that the map initialization script should run after the map container element is added to the DOM. It also shows the correct placement of the security configuration and the loader script.

```html
<div id="container" style="width:100vw; height:100vh"></div>

<script type="text/javascript">
  window._DiMapSecurityConfig = {
    securityJsCode: "你申请的安全密钥",
  };
</script>

<script src="https://lbs.xiaojukeji.com/api/v2/static/loader.js"></script>

<script type="text/javascript">
  //地图初始化应该在地图容器div已经添加到DOM树之后
  window.DiMapLoader.load({
		key: "你申请的key"
	}).then(({ DiMap }) => {
		new DiMap.Map({
			container: "container",
			style: "dimap://styles/normal"
		})
	})
</script>
```

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

### LBS Xiaojukeji Place Input Tips GET Request Example

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E6%90%9C%E7%B4%A2POI

This code snippet demonstrates how to make a GET request to the LBS Xiaojukeji API for place input tips. It requires an API key and search keywords, with optional parameters for city and extended fields. The request is made to the specified URL.

```shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/place/inputtips?key=YOUR_API_KEY&keywords=星巴&city=北京市&show_fields=sub_poi_list"
```

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

### Start Navigation using DMKNavigationManager

Source: https://lbs.xiaojukeji.com/docs/ios/navsdk/3.3-navi

Initiates navigation by calling the `startNavigation:` method of `DMKNavigationManager`. The boolean parameter controls whether to enter full-screen navigation or light navigation. No external dependencies are required beyond the SDK.

```objc
[self.navigationManager startNavigation:YES];
```

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

### Add CocoaPods Dependencies

Source: https://lbs.xiaojukeji.com/docs/ios/poisdk/3.1-getStarted

This snippet lists the dependencies required when using CocoaPods for managing your project's libraries. These pods need to be included in your Podfile to ensure all necessary components are installed.

```ruby
pod 'FMDB', '2.5.0'
pod 'JSONModel', '1.7.0'
pod 'libextobjc', '0.4.1'
pod 'Protobuf', '3.0.0'
```

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

### Create and Add LabelMarker to LabelLayer (JavaScript)

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/overlay/LabelMarker

This example demonstrates how to create a LabelMarker instance with custom icon and text configurations, and then add it to a LabelLayer which is subsequently added to the map. It highlights the initialization of LabelMarker with position, zoom levels, opacity, zIndex, icon properties (image, size, anchor, offset), and text properties (content, direction, offset, style).

```javascript
const labelMarker = new DiMap.LabelMarker({
  position: [116.405467, 39.907761],
  zooms: [0, 22],
  opacity: 1,
  zIndex: 1,
  icon: {
    image: "https://xxx.com/marker.png",
    size: [46 * 0.6, 66 * 0.6],
    anchor: "bottom",
    offset: [0, 4]
  },
  text: {
    content: "文字内容",
    direction: "top",
    offset: 0,
    style: {
      fontSize: 12,
      fillColor: "#000"
    }
  }
})
const labelLayer = new LabelLayer({
 visible: true,
 opacity: 1,
 collision: true,
 zooms: [0, 22]
})
labelLayer.add(labelMarker)
labelLayer.addToMap(map)
```

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

### Change Navigation View Mode

Source: https://lbs.xiaojukeji.com/docs/android/navsdk/3.3%E4%B8%93%E4%B8%9A%E5%AF%BC%E8%88%AA

This example illustrates how to dynamically change the navigation camera view between 2D and 3D perspectives. It includes logic to toggle the view mode and update button text accordingly.

```java
Button btnZoom;
boolean isFull3DMode = true;
btnZoom.setOnClickListener(v-> {
    // 切换导航视野模式
    isFull3DMode = !isFull3DMode;
    dMapNavi.changeViewMode(isFull3DMode ? ViewMode.FULL_3D : ViewMode.FULL_2D);
    btnZoom.setText(isFull3DMode ? "全览路线" : "退出全览");
})
```

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

### DMKOverlayView - initWithOverlay: Method

Source: https://lbs.xiaojukeji.com/docs/api/ios/mapsdk/Classes/DMKOverlayView

Explains the `initWithOverlay:` method used to initialize and return an overlay view.

```APIDOC
## DMKOverlayView - initWithOverlay: Method

### Description
Initializes and returns an overlay view.

### Method
`- (instancetype)initWithOverlay:(id<DMKOverlay>)_overlay_`

### Parameters
#### Path Parameters
- **overlay** (id<DMKOverlay>) - Required - Associated overlay object.

### Return Value
Returns the overlay view if initialization is successful, otherwise returns nil.

### Declared In
`DMKOverlayView.h`
```

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

### 配置工程依赖 (Gradle)

Source: https://lbs.xiaojukeji.com/docs/android/poisdk/3.1-getStarted

在Android Studio项目中，将SDK的aar包作为module引入后，需要在app/build.gradle文件中添加对该module的依赖。请确保'project(':poisearch-sdk')'中的module名称与实际引入的aar包创建的module名称一致。

```gradle
dependencies {
	//注意此处的project名称要与第一步引入aar所创建的module名称保持一致
    implementation project(':poisearch-sdk')
}
```

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

### Start DDMTrackClient Service

Source: https://lbs.xiaojukeji.com/docs/api/ios/tracksdk/Classes/DDMTrackManager

Starts the trajectory service for a given client. This method takes a DDMTrackClient object and returns the operation result.

```Objective-C
- (DDMSDKReturnCode)startServiceWithClient:(DDMTrackClient *)_client_

```

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

### Create and Display a CircleMarker in JavaScript

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/overlay/CircleMarker

This example demonstrates how to instantiate and display a CircleMarker using the DiMap JavaScript API. It requires a map instance and defines properties such as center coordinates, radius, and color options. The marker is made visible using the `show()` method.

```javascript
const circleMarker = new DiMap.CircleMarker({
 map: map,
 center: [116.405467, 39.907761],
 radius: 10,
 strokeColor: "#006600",
 strokeOpacity: 1,
 strokeWeight: 2,
 fillColor: "#006600",
 fillOpacity: 1,
 userData: {}
})
circl<ctrl63>
```

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

### Android: 配置工程依赖

Source: https://lbs.xiaojukeji.com/docs/android/sctxsdk/3.1-getStarted

配置Android项目以引入滴图开放平台SDK。此步骤需要在应用的build.gradle文件中添加对SDK模块的依赖，确保模块名称与引入的AAR文件创建的module名称一致。

```gradle
dependencies {
	//注意此处的project名称要与第一步引入aar所创建的module名称保持一致
    implementation project(':opensynctrip')
}
```

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

### Example: Null Island MercatorCoordinate

Source: https://lbs.xiaojukeji.com/docs/jsapi/demos/coordinate/MercatorCoordinate

An example demonstrating the creation of a MercatorCoordinate for 'null island' (0, 0 longitude/latitude), which corresponds to the center of the Mercator coordinate space (0.5, 0.5) with no altitude.

```javascript
const nullIsland = new DiMap.MercatorCoordinate(0.5, 0.5, 0);
```

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

### 获取路况栅格图 (GET)

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E8%B7%AF%E5%86%B5%E6%A0%85%E6%A0%BC%E5%9B%BE

通过GET请求获取指定城市、瓦片坐标和缩放级别的路况栅格图。需要提供API Key、城市名称、x、y、z参数。返回PNG格式的图片。

```http
GET /api/v2/traffic/raster?key=YOUR_API_KEY&city=北京市&x=843&y=414&z=10
```

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

### Initialize DMKMapNaviDriveManager

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveManager

Initializes the DMKMapNaviDriveManager with a provided DMKMapView. This is the primary method for setting up the navigation manager.

```objective-c
- (instancetype)initWithMapView:(DMKMapView *)_dmkMapView_
```

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

### POST/GET /api/v2/place/inputtips

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E6%90%9C%E7%B4%A2POI

This endpoint provides search suggestions for places. It can be used with either GET or POST requests. The GET method uses query parameters, while the POST method expects a JSON request body.

```APIDOC
## POST/GET /api/v2/place/inputtips

### Description
This endpoint provides search suggestions for places based on keywords and optional location parameters. It supports both GET and POST requests.

### Method
POST, GET

### Endpoint
https://lbs.xiaojukeji.com/api/v2/place/inputtips

### Parameters
#### Query Parameters (for GET requests)
- **key** (string) - Required - API Key for authentication.
- **keywords** (string) - Required - Search keywords.
- **location** (string) - Optional - Coordinates in "lng,lat" format.
- **city** (string) - Optional - City name for filtering.
- **types** (string) - Optional - POI filter types (6-digit codes), can be multiple, e.g., "101000,101020".
- **show_fields** (string) - Optional - Extended information to return, e.g., "sub_poi_list".
- **city_limit** (boolean) - Optional - Whether to limit search to the current city, defaults to false.

#### Request Body (for POST requests)
Requires a JSON object conforming to the `TextSearchRequest` model.

### Request Example
```shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/place/inputtips?key=YOUR_API_KEY&keywords=星巴&city=北京市&show_fields=sub_poi_list"
```

### Response
#### Success Response (200)
Returns a JSON object conforming to the `TextSearchResponse` model.
- **status** (integer) - Status code of the response.
- **msg** (string) - Message describing the status.
- **trace_id** (string) - Unique ID for tracing the request.
- **results** (array) - An array of place suggestions.
  - **name** (string) - Name of the place.
  - **location** (object) - Coordinates of the place.
    - **lng** (float) - Longitude.
    - **lat** (float) - Latitude.
  - **address** (string) - Address of the place.
  - **province** (string) - Province of the place.
  - **city** (string) - City of the place.
  - **district** (string) - District of the place.
  - **adcode** (string) - Adcode of the place.
  - **address_all** (string) - Full address.
  - **poi_id** (string) - Unique POI ID.
  - **type** (string) - POI type code.
  - **sub_poi_list** (array) - Optional, list of sub POIs if requested.
    - **poi_id** (string) - Unique sub POI ID.
    - **name** (string) - Name of the sub POI.
    - **address** (string) - Address of the sub POI.
    - **location** (object) - Coordinates of the sub POI.
      - **lng** (float) - Longitude.
      - **lat** (float) - Latitude.
    - **type** (string) - POI type code of the sub POI.
    - **select_tag** (string) - Selection tag for the sub POI.

#### Response Example
```json
{
  "status": 10000,
  "msg": "OK",
  "trace_id": "0aab11f468944e1c158ddcb625549802",
  "results": [
    {
      "name": "星巴克(民生金融中心店)",
      "location": {
        "lng": 116.419983,
        "lat": 39.907182
      },
      "address": "东城区建国门内大街28号民生金融中心C座1层",
      "province": "北京市",
      "city": "北京市",
      "district": "东城区",
      "adcode": "110101",
      "address_all": "东城区建国门内大街28号民生金融中心C座1层星巴克(民生金融中心店)",
      "poi_id": "110285444198432687599225390710798409401",
      "type": "161300",
      "sub_poi_list": [
        {
          "poi_id": "179919584780088526038817699620865083591",
          "name": "星巴克-户外座位区",
          "address": "东城区建国门内大街28号民生金融中心C座1层",
          "location": {
            "lng": 116.419983,
            "lat": 39.907282
          },
          "type": "050118",
          "select_tag": ""
        }
      ]
    },
    {
      "name": "星巴克(北京新闻大厦店)",
      "location": {
        "lng": 116.42196,
        "lat": 39.907482
      },
      "address": "东城区建国门内大街26号1号新闻大厦1层",
      "province": "北京市",
      "city": "北京市",
      "district": "东城区",
      "adcode": "110101",
      "address_all": "东城区建国门内大街26号1号新闻大厦1层星巴克(北京新闻大厦店)",
      "poi_id": "256535798603776763721612589994177088680",
      "type": "161300"
    }
  ]
}
```
```

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

### Initialize DiMap.Map Instance

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/map/Map

Demonstrates how to create and initialize a new DiMap.Map instance. This involves specifying the container element, map style, initial center coordinates, and zoom level. It also shows how to attach an event listener for the 'load' event.

```javascript
const map = new DiMap.Map({
  container: "container",
  style: "dimap://styles/normal",
  center: [116.39, 39.9],
  zoom: 10
})
map.on("load", () => {
  console.log("map loaded")
})
```

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

### Android SDK 初始化

Source: https://lbs.xiaojukeji.com/docs/android/authsdk/android-auth

在您的 Android 应用中集成滴图出行开放平台 SDK 时，需要使用获取到的 DiDi AuthInfo 来初始化 SDK。此初始化操作应在相关 SDK 启动之前完成，通常建议在 `Application.onCreate()` 方法中调用。

```java
DiDiAuth.init(this, "Your DiDi AuthInfo");
```

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

### GET /api/v2/traffic/incident

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E4%BA%A4%E9%80%9A%E4%BA%8B%E4%BB%B6

获取指定城市的交通事件信息，包括事故位置、事件描述、开始和结束时间等详细信息。交通事件信息实时更新，建议根据业务需求设置合适的请求频率。

```APIDOC
## GET /api/v2/traffic/incident

### Description
获取指定城市的交通事件信息，包括事故位置、事件描述、开始和结束时间等详细信息。

### Method
GET

### Endpoint
https://lbs.xiaojukeji.com/api/v2/traffic/incident

### Parameters
#### Query Parameters
- **key** (string) - Required - 鉴权用的 API Key
- **citycode** (string) - Required - 城市代码，见城市代码表
- **eventtype** (string) - Required - 事件类型 (100: 事故, 200: 施工, 300: 管制, 400: 封路, 500: 积水)
- **startid** (string) - Required - 开始id (首次请求时传入 0，后续传入上一次响应中的 `results.lastTraceId`)
- **format** (string) - Required - 返回格式，protobuf/json

### Request Example
```shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/traffic/incident?key=YOUR_API_KEY&citycode=1&eventtype=100&startid=0&format=json"
```

### Response
#### Success Response (200)
- **status** (integer) - 响应状态码
- **msg** (string) - 响应消息
- **trace_id** (string) - 请求跟踪ID
- **results** (object)
  - **eventsData** (array of objects) - 交通事件数据列表
    - **eventID** (integer) - 事件ID
    - **eventType** (integer) - 事件类型
    - **brief** (string) - 事件简述
    - **eventDesc** (string) - 事件描述
    - **roadName** (string) - 道路名称
    - **expressway** (boolean) - 是否为高速公路
    - **startTime** (integer) - 事件开始时间戳
    - **endTime** (integer) - 事件结束时间戳
    - **updateTime** (integer) - 事件更新时间戳
    - **x** (float) - 事件X坐标
    - **y** (float) - 事件Y坐标
    - **lines** (array of objects) - 事件影响的线路
      - **longitude** (float) - 经度
      - **latitude** (float) - 纬度
  - **lastTraceId** (integer) - 用于增量获取的ID

#### Response Example
```json
{
  "status": 10000,
  "msg": "OK",
  "trace_id": "0ac5186e67e513a96bd404838be2d3b0",
  "results": {
    "eventsData": [
      {
        "eventID": 470037591,
        "eventType": 100,
        "brief": "裕安路发生事故",
        "eventDesc": "裕安路发生事故",
        "roadName": "裕安路",
        "expressway": false,
        "startTime": 1747033837,
        "endTime": 1747034737,
        "updateTime": 1747034008,
        "x": 116.54529,
        "y": 40.08189,
        "lines": [
          {
            "longitude": 116.54529,
            "latitude": 40.08189
          }
        ]
      }
    ],
    "lastTraceId": 470037591
  }
}
```
```

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

### Initialize and Use HeatmapLayer in JavaScript

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/vector-layer/HeatmapLayer

Demonstrates how to create a HeatmapLayer instance, add heatmap features, append it to the map, and attach a click event listener. Requires the DiMap library and a map instance.

```javascript
const heatmapLayer = new DiMap.HeatmapLayer({
 max: 100,
 radius: 25,
 opacity: 0.7
})
heatmapLayer.addFeature(new DiMap.HeatmapFeature({...}))
heatmapLayer.addToMap(map)
heatmapLayer.on("click", () => {
 console.log("click")
})
```

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

### 自定义InfoWindow样式 (Java)

Source: https://lbs.xiaojukeji.com/docs/android/mapsdk/3.5-covering

本示例展示了如何通过实现DiMap.InfoWindowAdapter接口来为Marker自定义InfoWindow的样式。getInfoWindow()方法返回一个自定义的View，可以包含任意UI组件，实现更丰富的交互和视觉效果。自定义完成后，需要调用marker.showInfoWindow()来更新显示。

```java
marker.setInfoWindowAdapter(new DiMap.InfoWindowAdapter() {
    @Override
    public View getInfoWindow(Marker marker) {
        TextView t = new TextView(context);
        return t;
    }
});

// 调用showInfoWindow()更新
marker.showInfoWindow();
```

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

### 行政区域查询 API - GET 请求示例

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E8%A1%8C%E6%94%BF%E5%8C%BA%E5%9F%9F%E6%9F%A5%E8%AF%A2

使用GET方法查询行政区域信息。需要提供API Key和关键词。可选参数包括下级行政区级数和扩展信息。GET请求直接将参数附加在URL后面。

```shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/district?key=YOUR_API_KEY&keyword=北京市"
```

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

### LBS Xiaojukeji Place Input Tips Success Response Example

Source: https://lbs.xiaojukeji.com/docs/web/guide/%E6%90%9C%E7%B4%A2POI

This is an example of a successful JSON response from the LBS Xiaojukeji place input tips API. It includes status information, a message, a trace ID, and a list of results, each containing details like name, location, address, and potentially sub-POIs.

```json
{
  "status": 10000,
  "msg": "OK",
  "trace_id": "0aab11f468944e1c158ddcb625549802",
  "results": [
    {
      "name": "星巴克(民生金融中心店)",
      "location": {
        "lng": 116.419983,
        "lat": 39.907182
      },
      "address": "东城区建国门内大街28号民生金融中心C座1层",
      "province": "北京市",
      "city": "北京市",
      "district": "东城区",
      "adcode": "110101",
      "address_all": "东城区建国门内大街28号民生金融中心C座1层星巴克(民生金融中心店)",
      "poi_id": "110285444198432687599225390710798409401",
      "type": "161300",
      "sub_poi_list": [
        {
          "poi_id": "179919584780088526038817699620865083591",
          "name": "星巴克-户外座位区",
          "address": "东城区建国门内大街28号民生金融中心C座1层",
          "location": {
            "lng": 116.419983,
            "lat": 39.907282
          },
          "type": "050118",
          "select_tag": ""
        }
      ]
    },
    {
      "name": "星巴克(北京新闻大厦店)",
      "location": {
        "lng": 116.42196,
        "lat": 39.907482
      },
      "address": "东城区建国门内大街26号1号新闻大厦1层",
      "province": "北京市",
      "city": "北京市",
      "district": "东城区",
      "adcode": "110101",
      "address_all": "东城区建国门内大街26号1号新闻大厦1层星巴克(北京新闻大厦店)",
      "poi_id": "256535798603776763721612589994177088680",
      "type": "161300"
    }
  ]
}
```

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

### Initialize DMapNavi with MapView

Source: https://lbs.xiaojukeji.com/docs/android/navsdk/3.2%E8%B7%AF%E7%BA%BF%E8%A7%84%E5%88%92

Initializes the DMapNavi instance, which is required for navigation and route planning. It requires a Context and a DiMap. The DiMap can be obtained from MapView.getMap() if navigation display on the map is needed. Listeners for navigation events and parallel road information can also be added.

```java
MapView mapView = findViewById(R.id.mapview);
mapView.getMap(didiMap -> {
    DMapNavi dMapNavi = new DMapNavi(Context, DiMap);
    // Add navigation info callback listener
    dMapNavi.addDMapNaviListener(DMapNaviListener);
    // Add main/sub road, bridge on/under info callback listener
    dMapNavi.addParallelRoadListener(ParallelRoadListener);
    ... ...
}
```

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

### ShapeEdit.edit()

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/editors/ShapeEdit

Starts or ends the editing mode for a specified geometric shape type.

```APIDOC
## POST /ShapeEdit/edit

### Description
This method is used to start or stop the editing process for different types of geometric shapes on the map. You can specify the shape type and additional editing options.

### Method
`shapeEdit.edit(type, options)`

### Endpoint
N/A (Client-side JavaScript API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

#### Parameters
- **type** (string) - Required - The type of shape to edit. Possible values are `"Polygon"`, `"Line"`, `"Circle"`, or `"Rectangle"`.
- **options** (EditOptions) - Optional - An object containing optional parameters for editing.

##### EditOptions
- **editColor** (string) - Optional - The color used for editing the shape.
- **doneColor** (string) - Optional - The color used when the shape editing is completed.
- **shouldAdsor** (boolean) - Optional - A flag to enable or disable snapping functionality during editing.
- **initCoords** (Array<[number, number]>) - Optional - An array of initial coordinates to define the shape before editing begins.

### Request Example
```javascript
// Start editing a Polygon with custom options
shapeEdit.edit("Polygon", {
    editColor: "#FF0000",
    doneColor: "#00FF00",
    shouldAdsor: true,
    initCoords: [[10, 20], [30, 40]]
});

// End editing (if currently in edit mode for a shape)
// Calling edit with the same type might toggle off editing, or a specific 'end' command might be implied by context.
```

### Response
#### Success Response (200)
**Returns:** void

#### Response Example
N/A
```

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

### Get SDK Version (Objective-C)

Source: https://lbs.xiaojukeji.com/docs/api/ios/mapsdk/Classes/DMKMapView

Retrieves the version string of the SDK.

```Objective-C
- (NSString *)SDKVersion

```

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

### 智能定位 (Objective-C)

Source: https://lbs.xiaojukeji.com/docs/ios/locsdk/3.2-rb

结合系统定位、传感器和路网信息提供更高精度的连续定位。需要导入DMKLocationKit框架的DMKFLPAdapter，并在Info.plist中添加Motion Usage Description。通过startFLPUpdatingLocationWithDelegate开始更新，实现代理方法处理智能定位点，并可调用stopFLPUpdatingLocationWithDelegate停止更新。

```objective-c
//step1 导入头文件
#import <DMKLocationKit/DMKFLPAdapter.h>

- (void)startFLPLocation {
    //step2 注册监听
    DMKFLPAdapter *adapter = [DMKFLPAdapter mainAdapter];
    [adapter startFLPUpdatingLocationWithDelegate:self];
}

//step3 实现代理
- (void)flpAdapter:(DMKFLPAdapter *)adapter didUpdateLocation:(DMKFLPLocationModel *)flpLocationModel { 
    // 智能定位点使用代码

}

// step3 取消监听
- (void)stopFLPLocation {
    DMKFLPAdapter *adapter = [DMKFLPAdapter mainAdapter];
    [adapter updateNaviStop:1];
    [adapter stopFLPUpdatingLocationWithDelegate:self];
}
```

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

### Get Center of LngLatBounds - JavaScript

Source: https://lbs.xiaojukeji.com/docs/jsapi/demos/coordinate/LngLatBounds

Calculates and returns the geographical coordinates of the center of the LngLatBounds rectangle.

```javascript
const llb = new DiMap.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
llb.getCenter(); // = LngLat {lng: -73.96365, lat: 40.78315}
```

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

### 添加带InfoWindow的Marker (Java)

Source: https://lbs.xiaojukeji.com/docs/android/mapsdk/3.5-covering

此代码演示了如何创建一个带有InfoWindow（信息窗口）的Marker。通过设置Marker的title和snippet属性，可以使用默认的InfoWindow样式。setInfoWindowEnable(true)启用InfoWindow，并可以通过showInfoWindow()和hideInfoWindow()方法控制其显示和隐藏。InfoWindow是Marker上的一个可交互气泡，用于展示额外信息。

```java
    // 如下创建了一个带有InfoWindow的marker对象。其title和snippet设置了默认样式下的标题和文字片段，setInfoWindowEnable()开启InfoWindow
    MarkerOptions markerOptions = new MarkerOptions().icon(BitmapDescriptorFactory
        .defaultMarker())
        .position(DIAMOND_BUILDING)
        .title("标题")
        .snippet("文字片段")
        .setInfoWindowEnable(true);
        
    Marker markerWithInfoWindow = diMap.addMarker(markerOptions);
    
    // 显示InfoWindow
    markerWithInfoWindow.showInfoWindow();
    
    // 隐藏InfoWindow
    markerWithInfoWindow.hideInfoWindow();
```

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

### Get MercatorCoordinate Altitude

Source: https://lbs.xiaojukeji.com/docs/jsapi/demos/coordinate/MercatorCoordinate

The `toAltitude` instance method returns the altitude value of a MercatorCoordinate object.

```javascript
const coord = new DiMap.MercatorCoordinate(0, 0, 0.02);
coord.toAltitude(); // 6914.281956295339
```

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

### DMKMapNaviDriveSimulate Initialization

Source: https://lbs.xiaojukeji.com/docs/api/ios/navsdk/Classes/DMKMapNaviDriveSimulate

Initializes the simulation with a map view and route result.

```APIDOC
## initWithMapView:withResult:

### Description
Initializes the simulation with a map view and a route result.

### Method
Objective-C

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```objectivec
- (instancetype)initWithMapView:(DiMapView *)_mapview_ withResult:(DiRouteResult *)_result_
```

### Response
#### Success Response (200)
An instance of DMKMapNaviDriveSimulate.

#### Response Example
```objectivec
DMKMapNaviDriveSimulate *simulator = [[DMKMapNaviDriveSimulate alloc] initWithMapView:mapView withResult:routeResult];
```
```

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

### ShapeEdit Constructor

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/editors/ShapeEdit

Initializes the ShapeEdit plugin with a map instance and optional configuration options.

```APIDOC
## POST /ShapeEdit (Constructor)

### Description
Initializes the ShapeEdit plugin, providing it with the map instance and optional configuration for editing behaviors.

### Method
`new DiMapPlugin.ShapeEdit(map, options)`

### Endpoint
N/A (Client-side JavaScript API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

#### Parameters
- **map** (Map) - Required - The map instance to associate with the ShapeEdit plugin.
- **options** (ShapeEditOptions) - Optional - Configuration options for the ShapeEdit plugin.

##### ShapeEditOptions
- **middlePointState** (string) - Required - Specifies the display state of the middle point. Possible values are `"showing"` or `"default"`.

### Request Example
```javascript
const shapeEdit = new DiMapPlugin.ShapeEdit(map, {
    middlePointState: "showing"
});
```

### Response
#### Success Response (200)
N/A (Constructor returns an instance)

#### Response Example
N/A
```

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

### Get GeoLocation using JavaScript

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/geolocation/GetGeoLocation

获取地理位置工具类，用于获取设备的地理坐标信息。支持 success 和 error 回调函数，并可选择开启位置监听。返回一个 Promise，解析为获取到的位置信息或 null。

```javascript
const loc = await getGeoLocation({
 success: (data) => {},
 error: (err) => {},
})
```

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

### DMKLocationAdapter - Get Config

Source: https://lbs.xiaojukeji.com/docs/api/ios/locsdk/Classes/DMKLocationAdapter

Retrieves the current location configuration based on business information.

```APIDOC
## - configWithDelegate:

### Description
Retrieves the current location configuration based on business information. Returns nil if not found.

### Method
`- (DMKLocationConfig *)configWithDelegate:(id<DMKLocationAdapterDelegate>)_delegate_`

### Endpoint
N/A (Instance method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are passed directly)

- **delegate** (id<DMKLocationAdapterDelegate>) - Required - The callback delegate object.

### Request Example
N/A

### Response
#### Success Response
- **DMKLocationConfig** (object) - The current location configuration.

#### Failure Response
- **nil** - If no configuration is found for the given delegate.

### Response Example
N/A
```

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

### Android Gradle 依赖配置 (Groovy)

Source: https://lbs.xiaojukeji.com/docs/android/tracksdk/3.1-getStarted

在Android Studio项目中配置`build.gradle`文件，以引入本地的AAR库作为项目依赖。确保'project'名称与导入的AAR模块名称一致。

```groovy
dependencies {
	//注意此处的project名称要与第一步引入aar所创建的module名称保持一致
    implementation project(':open-tracksdk') 
}
```

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

### Layout Property Methods

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/map/Map

Methods for setting and getting layout properties for map layers.

```APIDOC
## POST /setLayoutProperty

### Description
Sets a specific layout property for a given layer.

### Method
POST

### Endpoint
/setLayoutProperty

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **layer** (string) - Required - The ID of the layer to set the layout property for.
- **name** (string) - Required - The name of the layout property to set.
- **value** (any) - Required - The value of the layout property.
- **options** (FilterOptions | null) - Optional - Options for setting the layout property.

### Request Example
```json
{
  "layer": "layer-id",
  "name": "layout-property-name",
  "value": "visible"
}
```

### Response
#### Success Response (200)
- **Map** - The map instance.

#### Response Example
```json
{
  "message": "Map instance returned"
}
```

## GET /getLayoutProperty

### Description
Retrieves the value of a specific layout property for a given layer.

### Method
GET

### Endpoint
/getLayoutProperty

### Parameters
#### Path Parameters
None

#### Query Parameters
- **layer** (string) - Required - The ID of the layer to get the layout property from.
- **name** (string) - Required - The name of the layout property to retrieve.

### Request Example
```json
{
  "layer": "layer-id",
  "name": "layout-property-name"
}
```

### Response
#### Success Response (200)
- **any** - The value of the specified layout property.

#### Response Example
```json
"visible"
```
```

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

### Initialize and Use PolygonLayer - JavaScript

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/vector-layer/PolygonLayer

Demonstrates how to create a new PolygonLayer, add polygon features, add it to a map, and attach a click event listener. This requires the DiMap library and assumes a map instance is available.

```javascript
const polygonLayer = new DiMap.PolygonLayer()
polygonLayer.addFeature(new DiMap.PolygonFeature({...}))
polygonLayer.addToMap(map)
polygonLayer.on("click", () => {
 console.log("click")
})
```

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

### Paint Property Methods

Source: https://lbs.xiaojukeji.com/docs/jsapi/apis/map/Map

Methods for setting and getting paint properties for map layers.

```APIDOC
## POST /setPaintProperty

### Description
Sets a specific paint property for a given layer.

### Method
POST

### Endpoint
/setPaintProperty

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **layer** (string) - Required - The ID of the layer to set the paint property for.
- **name** (string) - Required - The name of the paint property to set.
- **value** (any) - Required - The value of the paint property.
- **options** (FilterOptions | null) - Optional - Options for setting the paint property.

### Request Example
```json
{
  "layer": "layer-id",
  "name": "paint-property-name",
  "value": "#FF0000"
}
```

### Response
#### Success Response (200)
- **Map** - The map instance.

#### Response Example
```json
{
  "message": "Map instance returned"
}
```

## GET /getPaintProperty

### Description
Retrieves the value of a specific paint property for a given layer.

### Method
GET

### Endpoint
/getPaintProperty

### Parameters
#### Path Parameters
None

#### Query Parameters
- **layer** (string) - Required - The ID of the layer to get the paint property from.
- **name** (string) - Required - The name of the paint property to retrieve.

### Request Example
```json
{
  "layer": "layer-id",
  "name": "paint-property-name"
}
```

### Response
#### Success Response (200)
- **any** - The value of the specified paint property.

#### Response Example
```json
"#FF0000"
```
```

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

### Import Didi Map SDK Header Files (Objective-C)

Source: https://lbs.xiaojukeji.com/docs/ios/tracksdk/3.1-getStarted

Demonstrates how to import the necessary header files for using the Didi Map SDK's base service and track SDK functionalities in an Objective-C project.

```objective-c
#import <DMKBaseSDK/DMKBaseService.h>
#import <DMKTrackSDK/DMKTrackSDK.h>
```
Tokens:
Raw