JSAPI GL Development Guide

When to Use

• Creating new map pages or components
• Adding markers, polylines, polygons, and other overlays to the map
• Handling map interaction events (click, drag, zoom, etc.)
• Configuring map styles or switching layers
• Debugging map rendering or performance issues

Quick Reference

0. Basic Concepts

• references/base-classes.md

  - Basic Classes: Point, Bounds, Size, Pixel, Icon

• references/constants.md

  - Common Constants: Search status codes, POI types

1. Map

• references/map-init.md

  - Map Initialization: Resource introduction, instance creation, configuration options, interaction and view control

2. Map Overlays

• references/overlay-common.md

  - Common Overlay Operations: Add/remove, show/hide, batch clear

• references/marker.md

  - Marker: Constructor parameters, position/icon/rotation/topmost/drag methods

• references/polyline.md

  - Polyline: Constructor parameters, line style, coordinate operations, edit mode

• references/polygon.md

  - Polygon: Constructor parameters, border/fill style, polygon with holes, edit mode

• references/circle.md

  - Circle: Constructor parameters, center point/radius, style settings, edit mode

• references/custom-overlay.md

  - Custom Overlay: DOM creation, attribute passing, event binding, rotation control

• references/info-window.md

  - Info Window: Constructor parameters, content/size settings, maximize, use with Marker

3. Events

• references/map-events.md

  - Map Events: Binding methods, interaction events, view change events, lifecycle events

• references/overlay-events.md

  - Overlay Events: Common events, drag events, vector graphic events

4. Map Styles

• references/map-style.md

  - Customized Maps: Customize map appearance (color, show/hide), implement dark themes, minimalist maps, etc.

5. Layer Services

• references/xyz-layer.md

  - Third-party Layers: Load standard tiles in XYZ/TMS/WMS/WMTS formats

• references/mvt-layer.md

  - Vector Tiles: Load tiles in MVT/PBF formats, support style expressions, feature interaction, state management

6. Route Planning

• references/route-common.md

  - Common Configuration: Constructor parameters, rendering options, callback functions, data structures, state constants

  • references/driving-route.md

    - Driving: Strategy enumeration, waypoints, traffic conditions, tolls, drag

  • references/walking-route.md

    - Walking: Turn types, drag

  • references/riding-route.md

    - Cycling: Cycling search

  • references/transit-route.md

    - Public Transit: Intra-city/inter-city strategies, transportation modes, transfers

7. Other LBS Services

• references/local-search.md

  - Local Search: General/range/surrounding search, result processing, pagination, POI data structure

• references/geocoder.md

  - Geocoding: Forward geocoding (address → coordinates), reverse geocoding (coordinates → address)

• references/convertor.md

  - Coordinate Conversion: Convert GPS/Amap/Google coordinates to Baidu coordinates

How to Use

references/map-init.md

• Brief function description
• Complete code examples and explanations
• API parameter descriptions and notes