# Map Component
Using the map component on iOS requires integrating the Extension SDK/MapSDK (System maps use the Extension SDK, third-party maps use MapSDK)
For iOS integration of Extension SDK/MapSDK, please refer to 「Mini-Program SDK-iOS SDK-iOS Integration」
Using the map component on Android requires integrating MapSDK
For Android integration of MapSDK, please refer to 「Mini-Program SDK-Android SDK-Android Integration-6. MapSDK」
# System Map (iOS and Harmony Only)
| Property | Type | Default Value | Required | Description | Support |
|---|---|---|---|---|---|
| longitude | number | 116.46 | Yes | Center longitude | iOS:✅ Harmony:✅ |
| latitude | number | 39.92 | Yes | Center latitude | iOS:✅ Harmony:✅ |
| scale | number | 16 | No | Zoom level, range is 3-20 | iOS:✅ Harmony:✅ |
| min-scale | number | 3 | No | Minimum zoom level (not controlled by this property when zooming with gestures) | iOS:✅ Harmony:✅ |
| max-scale | number | 20 | No | Maximum zoom level (not controlled by this property when zooming with gestures) | iOS:✅ Harmony:✅ |
| markers | Array.marker | No | Markers | iOS:✅ Harmony:✅ | |
| polyline | Array.polyline | No | Routes | iOS:✅ Harmony:✅ | |
| circles | Array.circle | No | Circles | iOS:✅ Harmony:✅ | |
| controls | Array.control | No | Controls (to be deprecated, recommended to use cover-view instead) | iOS:❌ Harmony:❌ | |
| include-points | Array.point | No | Zoom to include all given coordinate points | iOS:✅ Harmony:✅ | |
| show-location | boolean | false | No | Show current location point with direction | iOS:✅ Harmony:✅ |
| polygons | Array.polygon | No | Polygons | iOS:✅ Harmony:✅ | |
| subkey | - | No | Custom map not supported yet | iOS:❌ Harmony:❌ | |
| layer-style | - | No | Custom map not supported yet | iOS:❌ Harmony:❌ | |
| rotate | number | 0 | No | Rotation angle, range 0 ~ 360, angle between map north and device y-axis | iOS:❌ Harmony:✅ |
| skew | number | 0 | No | Tilt angle, range 0 ~ 40, tilt around z-axis | iOS:❌ Harmony:✅ |
| enable-3D | boolean | false | No | Display 3D buildings | iOS:❌ Harmony:✅ |
| show-compass | boolean | false | No | Show compass | iOS:✅ Harmony:✅ |
| show-scale | boolean | false | No | Show scale bar | iOS:✅ Harmony:✅ |
| enable-overlooking | boolean | false | No | Enable bird's eye view | iOS:✅ Harmony:✅ |
| enable-zoom | boolean | true | No | Whether zooming is supported | iOS:✅ Harmony:✅ |
| enable-scroll | boolean | true | No | Whether dragging is supported | iOS:✅ Harmony:✅ |
| enable-rotate | boolean | false | No | Whether rotation is supported | iOS:✅ Harmony:✅ |
| enable-satellite | boolean | false | No | Whether satellite view is enabled | iOS:✅ Harmony:❌ |
| enable-traffic | boolean | false | No | Whether real-time traffic is enabled | iOS:✅ Harmony:✅ |
| enable-poi | boolean | true | No | Whether POI points are displayed | iOS:✅ Harmony:❌ |
| enable-building | boolean | No | Whether buildings are displayed | iOS:✅ Harmony:❌ | |
| setting | object | No | Configuration item; if setting conflicts with property configuration, setting takes precedence | iOS:✅ Harmony:✅ | |
| bindtap | eventhandle | No | Triggered when the map is clicked, returns latitude and longitude information | iOS:❌ Harmony:✅ | |
| bindmarkertap | eventhandle | No | Triggered when a marker is clicked, e.detail = {markerId} | iOS:❌ Harmony:✅ | |
| bindlabeltap | eventhandle | No | Triggered when label is clicked, e.detail = {markerId} | iOS:❌ Harmony:❌ | |
| bindcontroltap | eventhandle | No | Triggered when control is clicked, e.detail = {controlId} | iOS:❌ Harmony:❌ | |
| bindcallouttap | eventhandle | No | Triggered when the bubble corresponding to the marker is clicked, e.detail = {markerId} | iOS:❌ Harmony:❌ | |
| bindupdated | eventhandle | No | Triggered when map rendering update is completed. (Harmony: triggered only once when map loading is completed) | iOS:❌ Harmony:✅ | |
| bindregionchange | eventhandle | No | Triggered when the field of view changes (Harmony: causeBy may not be accurate) | iOS:❌ Harmony:✅ | |
| bindpoitap | eventhandle | No | Triggered when a map POI point is clicked, e.detail = {name, longitude, latitude} | iOS:❌ Harmony:✅ | |
| bindpolylinetap | eventhandle | No | Triggered when a map route is clicked, e.detail = {longitude, latitude} (Harmony: returns the first point's coordinates) | iOS:❌ Harmony:✅ | |
| bindanchorpointtap | eventhandle | No | Triggered when the positioning marker is clicked, e.detail = {longitude, latitude} | iOS:❌ Harmony:✅ |
# marker
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Marker ID | number | No | This ID will be returned in the marker click event callback. | iOS:✅ Harmony:✅ |
| clusterId | Cluster ID | number | No | Used for custom point clustering effect | iOS:✅ Harmony:❌ |
| joinCluster | Whether to participate in point clustering | Boolean | No | Defaults to not participating in point clustering | iOS:❌ Harmony:❌ |
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | iOS:✅ Harmony:✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | iOS:✅ Harmony:✅ |
| title | Annotation name | string | No | Displayed on click, ignored if callout exists | iOS:✅ Harmony:✅ |
| zIndex | Display level | number | No | iOS:❌ Harmony:✅ | |
| iconPath | Displayed icon | string | Yes | Image path under project directory, supports network paths, local paths, code package paths | iOS:✅ Harmony:✅ |
| rotate | Rotation angle | number | No | Clockwise rotation angle, range 0 ~ 360, default is 0 | iOS:❌ Harmony:✅ |
| alpha | Marker transparency | number | No | Default 1, no transparency, range 0 ~ 1 | iOS:❌ Harmony:✅ |
| width | Marker icon width | number/string | No | Default is actual image width | iOS:❌ Harmony:❌ |
| height | Marker point | number | No | Default is actual image height | iOS:❌ Harmony:❌ |
| callout | Bubble window above the marker | Object | No | Supported properties see table below, recognizes line breaks. | iOS:✅ Harmony:✅ |
| customCallout | Marker point | object | No | iOS:❌ Harmony:✅ | |
| label | Add label next to the marker | Object | No | Supported properties see table below, recognizes line breaks. | iOS:❌ Harmony:✅ |
| anchor | Anchor point of latitude and longitude on the annotation icon, default bottom center | Object | No | {x, y}, x represents horizontal (0-1), y represents vertical (0-1). {x: .5, y: 1} indicates bottom center | iOS:❌ Harmony:✅ |
| aria-label | Accessibility description (property) additional description of the element | string | No | iOS:❌ Harmony:❌ |
# Bubble callout on marker
| Property | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:✅ Harmony:✅ | |
| color | Text color | string | iOS:❌ Harmony:✅ | |
| fontSize | Font size | number | iOS:❌ Harmony:✅ | |
| borderRadius | Border radius | number | iOS:❌ Harmony:✅ | |
| borderWidth | Border width | string | iOS:❌ Harmony:✅ | |
| borderColor | Border color | string | iOS:❌ Harmony:✅ | |
| bgColor | Background color | string | iOS:❌ Harmony:✅ | |
| padding | Text margin | number | iOS:❌ Harmony:✅ | |
| display | 'BYCLICK': Click to display; 'ALWAYS': Always visible | string | iOS:❌ Harmony:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:❌ Harmony:✅ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:❌ Harmony:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:❌ Harmony:✅ |
# Bubble customCallout on marker
When customCallout exists, it will ignore the callout and title attributes. Custom bubbles use cover-view customization, offering higher flexibility.
| Property | Description | Type | Remarks | Support |
|---|---|---|---|---|
| display | 'BYCLICK': Click to display; 'ALWAYS': Always visible | string | iOS:❌ Harmony:❌ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:❌ Harmony:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:❌ Harmony:✅ |
Usage is as follows, add a slot node named callout under the map component, and its internal cover-view binds to the marker through the marker-id attribute. When the marker is created, the content displayed by this cover-view will appear as a callout above the marker point.
<map>
<cover-view slot="callout">
<cover-view marker-id="1"></cover-view>
<cover-view marker-id="2"></cover-view>
<cover-view marker-id="3"></cover-view>
</cover-view>
</map>
# Bubble label on marker
| Property | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:✅ Harmony:✅ | |
| color | Text color | string | iOS:❌ Harmony:✅ | |
| fontSize | Font size | number | iOS:❌ Harmony:✅ | |
| anchorX | Label coordinates, origin is the marker's latitude and longitude | number | iOS:❌ Harmony:❌ | |
| anchorY | Label coordinates, origin is the marker's latitude and longitude | number | iOS:❌ Harmony:❌ | |
| borderWidth | Border width | number | iOS:❌ Harmony:❌ | |
| borderColor | Border color | string | iOS:❌ Harmony:❌ | |
| borderRadius | Border radius | number | iOS:❌ Harmony:❌ | |
| bgColor | Background color | string | iOS:❌ Harmony:❌ | |
| padding | Text margin | number | iOS:❌ Harmony:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:❌ Harmony:❌ |
# polyline
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Harmony:✅ |
| color | Line color | string | No | Hexadecimal | iOS:✅ Harmony:✅ |
| colorList | Rainbow line | array | No | If present, ignores color value | iOS:❌ Harmony:✅ |
| width | Line width | number | No | iOS:✅ Harmony:✅ | |
| dottedLine | Whether dashed line | boolean | No | Default false | iOS:❌ Harmony:✅ |
| arrowLine | Arrowed line | boolean | No | Default false | iOS:❌ Harmony:❌ |
| arrowIconPath | Change arrow icon | string | No | Effective when arrowLine is true | iOS:❌ Harmony:❌ |
| borderColor | Line border color | string | No | iOS:❌ Harmony:❌ | |
| borderWidth | Line thickness | number | No | iOS:❌ Harmony:❌ | |
| level | Overlap relationship | string | No | Default is abovelabels | iOS:❌ Harmony:❌ |
# polygon
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Harmony:✅ |
| strokeWidth | Stroke width | number | No | iOS:✅ Harmony:✅ | |
| strokeColor | Stroke color | string | No | Hexadecimal | iOS:✅ Harmony:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Harmony:✅ |
| dashArray | Dashed line | Array<number> | No | Default value [0, 0] for solid line, [10, 10] indicates ten pixels of solid line and ten pixels of blank space (repeatedly) forming a dashed line | iOS:❌ Harmony:✅ |
| zIndex | Set Z-axis value for polygon | number | No | iOS:✅ Harmony:✅ | |
| level | Overlap relationship | string | No | Default is abovelabels | iOS:❌ Harmony:❌ |
# circle
| Property | Description | Type | Required | Remarks | Other |
|---|---|---|---|---|---|
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | iOS:✅ Harmony:✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | iOS:✅ Harmony:✅ |
| color | Stroke color | string | No | Hexadecimal | iOS:✅ Harmony:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Harmony:✅ |
| radius | Radius | number | Yes | iOS:✅ Harmony:✅ | |
| strokeWidth | Stroke width | number | No | iOS:✅ Harmony:✅ | |
| level | Overlap relationship | string | No | Default is abovelabels | iOS:❌ Harmony:❌ |
# control
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Control ID | number | No | This ID will be returned in the control click event callback | ❌ |
| position | Control position on the map | object | Yes | Relative position to the map | ❌ |
| iconPath | Displayed icon | string | Yes | Image path under project directory, supports local paths, code package paths | ❌ |
| clickable | Whether clickable | boolean | No | Default not clickable | ❌ |
# position
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| left | Distance from the left boundary of the map | number | No | Default is 0 | ❌ |
| top | Distance from the top boundary of the map | number | No | Default is 0 | ❌ |
| width | Control width | number | No | Default is 0 | ❌ |
| height | Control height | number | No | Default is 0 | ❌ |
# AMap
AMap allows up to 10 map objects
If there are more than 10 map objects, the map content will display a black screen. Therefore, when using AMap to implement the map component (i.e., relying on the AMap Extension SDK), the Mini-Program needs to remove and destroy the map in the onHide() method of the page, then create the map and add map content in the onShow().
| Property | Type | Default Value | Required | Description | Support |
|---|---|---|---|---|---|
| longitude | number | 116.46 | Yes | Center longitude | iOS:✅ Android:✅ IDE:✅ |
| latitude | number | 39.92 | Yes | Center latitude | iOS:✅ Android:✅ IDE:✅ |
| scale | number | 16 | No | Zoom level, range is 3-20 | iOS:✅ Android:✅ IDE:✅ |
| min-scale | number | 3 | No | Minimum zoom level | iOS:✅ Android:✅ IDE:✅ Not supporting dynamic modification |
| max-scale | number | 20 | No | Maximum zoom level | iOS:✅ Android:✅ IDE:✅ Not supporting dynamic modification |
| markers | Array.marker | No | Markers | iOS:✅ Android:✅ IDE:✅ | |
| polyline | Array.polyline | No | Routes | iOS:✅ Android:✅ IDE:✅ | |
| circles | Array.circle | No | Circles | iOS:✅ Android:✅ IDE:✅ | |
| controls | Array.control | No | Controls (to be deprecated, recommended to use cover-view instead) | iOS:❌ Android:❌ IDE:✅ | |
| include-points | Array.point | No | Zoom to include all given coordinate points | iOS:✅ Android:✅ IDE:❌ | |
| show-location | boolean | false | No | Show current location point with direction | iOS:✅ Android:✅ IDE:❌ |
| polygons | Array.polygon | No | Polygons | iOS:✅ Android:✅ IDE:✅ | |
| subkey | - | No | Custom map not supported yet | iOS:❌ Android:❌ IDE:❌ | |
| layer-style | - | No | Custom map not supported yet | iOS:❌ Android:❌ IDE:❌ | |
| rotate | number | 0 | No | Rotation angle, range 0 ~ 360, angle between map north and device y-axis | iOS:✅ Android:✅ IDE:✅ |
| skew | number | 0 | No | Tilt angle, range 0 ~ 40, tilt around z-axis | iOS:✅ Android:✅ IDE:✅ |
| enable-3D | boolean | false | No | Display 3D buildings | iOS:❌ Android:❌ IDE:❌ |
| show-compass | boolean | false | No | Show compass | iOS:✅ Android:✅ IDE:❌ |
| show-scale | boolean | false | No | Show scale bar | iOS:✅ Android:✅ IDE:✅ |
| enable-overlooking | boolean | false | No | Enable bird's eye view | iOS:✅ Android:✅ IDE:❌ |
| enable-zoom | boolean | true | No | Whether zooming is supported | iOS:✅ Android:✅ IDE:✅ |
| enable-scroll | boolean | true | No | Whether dragging is supported | iOS:✅ Android:✅ IDE:✅ |
| enable-rotate | boolean | false | No | Whether rotation is supported | iOS:✅ Android:✅ IDE:✅ |
| enable-satellite | boolean | false | No | Whether satellite view is enabled | iOS:✅ Android:✅ IDE:✅ |
| enable-traffic | boolean | false | No | Whether real-time traffic is enabled | iOS:✅ Android:✅ IDE:✅ |
| enable-poi | boolean | true | No | Whether POI points are displayed | iOS:❌ Android:✅ IDE:✅ |
| enable-building | boolean | No | Whether buildings are displayed | iOS:✅ Android:✅ IDE:✅ | |
| setting | object | No | Configuration item; if setting conflicts with property configuration, setting takes precedence | iOS:✅ Android:✅ IDE:✅ | |
| bindtap | eventhandle | No | Triggered when the map is clicked, returns latitude and longitude information | iOS:✅ Android:✅ IDE:✅ | |
| bindmarkertap | eventhandle | No | Triggered when a marker is clicked, e.detail = {markerId} | iOS:✅ Android:✅ IDE:✅ | |
| bindlabeltap | eventhandle | No | Triggered when label is clicked, e.detail = {markerId} | iOS:❌ Android:❌ IDE:❌ | |
| bindcontroltap | eventhandle | No | Triggered when control is clicked, e.detail = {controlId} | iOS:❌ Android:❌ IDE:✅ | |
| bindcallouttap | eventhandle | No | Triggered when the bubble corresponding to the marker is clicked, e.detail = {markerId} | iOS:✅ Android:✅ IDE:❌ | |
| bindupdated | eventhandle | No | Triggered when map rendering update is completed | iOS:✅ Triggered only when map loading is completed Android:✅ Triggered only when map loading is completed IDE:❌ | |
| bindregionchange | eventhandle | No | Triggered when the field of view changes | iOS:✅ Android:✅ IDE:✅ | |
| bindpoitap | eventhandle | No | Triggered when a map POI point is clicked, e.detail = {name, longitude, latitude} | iOS:✅ Android:✅ IDE:❌ | |
| bindanchorpointtap | eventhandle | No | Triggered when the positioning marker is clicked, e.detail = {longitude, latitude} | iOS:✅ Android:✅ IDE:❌ |
# marker
| Property | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Marker ID | number | No | This ID will be returned in the marker click event callback. | iOS:✅ Android:✅ IDE:✅ |
| clusterId | Cluster ID | number | No | Used for custom point clustering effect | iOS:❌ Android:✅ IDE:❌ |
| joinCluster | Whether to participate in point clustering | Boolean | No | Defaults to not participating in point clustering | iOS:❌ Android:✅ IDE:❌ |
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | iOS:✅ Android:✅ IDE:✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | iOS:✅ Android:✅ IDE:✅ |
| title | Annotation name | string | No | Displayed on click, ignored if callout exists | iOS:✅ Android:✅ IDE:✅ |
| zIndex | Display level | number | No | iOS:✅ Android:✅ IDE:✅ | |
| iconPath | Displayed icon | string | Yes | Image path under project directory, supports network paths, local paths, code package paths | iOS:✅ Android:✅ IDE:✅ |
| rotate | Rotation angle | number | No | Clockwise rotation angle, range 0 ~ 360, default is 0 | iOS:❌ Android:✅ IDE:✅ |
| alpha | Marker transparency | number | No | Default 1, no transparency, range 0 ~ 1 | iOS:❌ Android:✅ IDE:✅ |
| width | Marker icon width | number/string | No | Default is actual image width | iOS:✅ Android:✅ IDE:✅ |
| height | Marker point | number | No | Default is actual image height | iOS:✅ Android:✅ IDE:✅ |
| callout | Bubble window above the marker | Object | No | Supported properties see table below, recognizes line breaks. | iOS:✅ Android:✅ IDE:✅ |
| customCallout | Marker point | number | No | iOS:✅ Android:✅ IDE:❌ | |
| label | Add label next to the marker | Object | No | Supported properties see table below, recognizes line breaks. | iOS:❌ Android:❌ IDE:✅ |
| anchor | Anchor point of latitude and longitude on the annotation icon, default bottom center | Object | No | {x, y}, x represents horizontal (0-1), y represents vertical (0-1). {x: .5, y: 1} indicates bottom center | iOS:❌ Android:✅ IDE:✅ |
| aria-label | Accessibility description (property) additional description of the element | string | No | iOS:❌ Android:❌ IDE:❌ | |
| displayWithCallout | Whether to display callout/customCallout/title as marker icon | Boolean | No | Display callout/customCallout/title as marker icon so that callout/customCallout/title can always be visible | iOS:✅ Android:✅ IDE:❌ |
# Bubble callout on marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:✅ Android:✅ IDE:✅ | |
| color | Text color | string | iOS:✅ Android:✅ IDE:❌ | |
| fontSize | Font size | number | iOS:✅ Android:✅ IDE:❌ | |
| borderRadius | Border radius | number | iOS:✅ Android:✅ IDE:✅ | |
| borderWidth | Border width | string | iOS:✅ Android:✅ IDE:❌ | |
| borderColor | Border color | string | iOS:✅ Android:✅ IDE:❌ | |
| bgColor | Background color | string | iOS:✅ Android:✅ IDE:❌ | |
| padding | Text padding | number | iOS:✅ Android:✅ IDE:❌ | |
| display | 'BYCLICK': Show on click; 'ALWAYS': Always visible | string | iOS:✅ Android:(does not support ALWAYS)✅ IDE:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:✅ Android:✅ IDE:❌ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:✅ IDE:❌ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ IDE:❌ |
# Custom Callout Bubble on Marker
When customCallout exists, it will ignore the callout and title attributes. The custom callout uses cover-view for customization, offering higher flexibility.
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| display | 'BYCLICK': Show on click; 'ALWAYS': Always visible | string | iOS:✅ Android:✅ IDE:❌ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:✅ IDE:❌ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ IDE:❌ |
Usage is as follows: Add a slot node named callout under the map component. The internal cover-view binds with the marker via the marker-id attribute. When the marker is created, the content displayed by this cover-view will appear as the callout above the marker point.
<map>
<cover-view slot="callout">
<cover-view marker-id="1"></cover-view>
<cover-view marker-id="2"></cover-view>
<cover-view marker-id="3"></cover-view>
</cover-view>
</map>
# Label Bubble on Marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:❌ Android:❌ IDE:✅ | |
| color | Text color | string | iOS:❌ Android:❌ IDE:❌ | |
| fontSize | Font size | number | iOS:❌ Android:❌ IDE:❌ | |
| anchorX | Label's coordinate, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ IDE:❌ | |
| anchorY | Label's coordinate, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ IDE:❌ | |
| borderWidth | Border width | number | iOS:❌ Android:❌ IDE:❌ | |
| borderColor | Border color | string | iOS:❌ Android:❌ IDE:❌ | |
| borderRadius | Border radius | number | iOS:❌ Android:❌ IDE:❌ | |
| bgColor | Background color | string | iOS:❌ Android:❌ IDE:❌ | |
| padding | Text padding | number | iOS:❌ Android:❌ IDE:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:❌ Android:❌ IDE:❌ |
# Polyline
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ IDE:✅ |
| color | Line color | string | No | Hexadecimal | iOS:✅ Android:✅ IDE:✅ |
| colorList | Rainbow line | array | No | If present, ignores the color value | iOS:❌ Android:✅ IDE:❌ |
| width | Line width | number | No | iOS:✅ Android:✅ IDE:✅ | |
| dottedLine | Whether dashed line | boolean | No | Default false | iOS:❌ Android:✅ IDE:✅ |
| arrowLine | Line with arrow | boolean | No | Default false | iOS:❌ Android:✅ IDE:✅ |
| arrowIconPath | Change arrow icon | string | No | Effective when arrowLine is true | iOS:✅ Android:✅ IDE:✅ |
| borderColor | Line border color | string | No | iOS:❌ Android:❌ IDE:✅ | |
| borderWidth | Line thickness | number | No | iOS:❌ Android:❌ IDE:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:✅ aboveroads equivalent to abovebuildings IDE:✅ |
# Polygon
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ IDE:✅ |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ IDE:✅ | |
| strokeColor | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ IDE:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ IDE:✅ |
| zIndex | Set Z-axis value for polygon | number | No | iOS:✅ Android:✅ IDE:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:✅ aboveroads equivalent to abovebuildings IDE:✅ |
# Circle
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | iOS:✅ Android:✅ IDE:✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | iOS:✅ Android:✅ IDE:✅ |
| color | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ IDE:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ IDE:✅ |
| radius | Radius | number | Yes | iOS:✅ Android:✅ IDE:✅ | |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ IDE:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:✅ aboveroads equivalent to abovebuildings IDE:✅ |
# Control
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Control ID | number | No | This ID will be returned in the control click event callback | iOS:❌ Android:❌ IDE:✅ |
| position | Position of the control on the map | object | Yes | Relative position of the control on the map | iOS:❌ Android:❌ IDE:✅ |
| iconPath | Displayed icon | string | Yes | Image path in the project directory, supports local path, code package path | iOS:❌ Android:❌ IDE:✅ |
| clickable | Whether clickable | boolean | No | Default is not clickable | iOS:❌ Android:❌ IDE:✅ |
# Position
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| left | Distance from the left boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ IDE:✅ |
| top | Distance from the top boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ IDE:✅ |
| width | Control width | number | No | Default is 0 | iOS:❌ Android:❌ IDE:✅ |
| height | Control height | number | No | Default is 0 | iOS:❌ Android:❌ IDE:✅ |
# Baidu Map (Only supported on iOS, Android, Harmony)
| Attribute | Type | Default Value | Required | Description | Support |
|---|---|---|---|---|---|
| longitude | number | 116.46 | Yes | Center longitude | iOS:✅ Android:✅ Harmony:✅ |
| latitude | number | 39.92 | Yes | Center latitude | iOS:✅ Android:✅ Harmony:✅ |
| scale | number | 16 | No | Zoom level, range is 3-20 | iOS:✅ Android:✅ Harmony:✅ |
| min-scale | number | 3 | No | Minimum zoom level | iOS:✅ Android:✅ Harmony:✅ |
| max-scale | number | 20 | No | Maximum zoom level | iOS:✅ Android:✅ Harmony:✅ |
| markers | Array.marker | No | Markers | iOS:✅ Android:✅ Harmony:✅ | |
| polyline | Array.polyline | No | Routes | iOS:✅ Android:✅ Harmony:✅ | |
| circles | Array.circle | No | Circles | iOS:✅ Android:✅ Harmony:✅ | |
| controls | Array.control | No | Controls (to be deprecated, recommended to use cover-view instead) | iOS:❌ Android:❌ Harmony:❌ | |
| include-points | Array.point | No | Zoom to include all given coordinates | iOS:✅ Android:✅ Harmony:✅ | |
| show-location | boolean | false | No | Show current location with direction | iOS:✅ Android:✅ Harmony:✅ |
| polygons | Array.polygon | No | Polygons | iOS:✅ Android:✅ Harmony:✅ | |
| subkey | - | No | Custom map not supported yet | iOS:❌ Android:❌ Harmony:❌ | |
| layer-style | - | No | Custom map not supported yet | iOS:❌ Android:❌ Harmony:❌ | |
| rotate | number | 0 | No | Rotation angle, range 0 ~ 360, angle between map north and device y-axis | iOS:✅ Android:✅ Harmony:✅ |
| skew | number | 0 | No | Tilt angle, range 0 ~ 40, tilt around z-axis | iOS:✅ Android:✅ Harmony:✅ |
| enable-3D | boolean | false | No | Show 3D buildings | iOS:✅ Android:✅ Harmony:❌ |
| show-compass | boolean | false | No | Show compass (iOS default enabled, cannot be disabled) | iOS:✅ Android:✅ Harmony:✅ |
| show-scale | boolean | false | No | Show scale bar | iOS:✅ Android:✅ Harmony:✅ |
| enable-overlooking | boolean | false | No | Enable bird's eye view | iOS:✅ Android:✅ Harmony:✅ |
| enable-zoom | boolean | true | No | Whether zooming is supported | iOS:✅ Android:✅ Harmony:✅ |
| enable-scroll | boolean | true | No | Whether dragging is supported | iOS:✅ Android:✅ Harmony:✅ |
| enable-rotate | boolean | false | No | Whether rotation is supported | iOS:✅ Android:✅ Harmony:✅ |
| enable-satellite | boolean | false | No | Whether satellite view is enabled | iOS:✅ Android:✅ Harmony:✅ |
| enable-traffic | boolean | false | No | Whether real-time traffic is enabled | iOS:✅ Android:✅ Harmony:❌ |
| enable-poi | boolean | true | No | Whether POI points are displayed | iOS:✅ Android:✅ Harmony:✅ |
| enable-building | boolean | No | Whether buildings are displayed | iOS:❌ Android:❌ Harmony:❌ | |
| setting | object | No | Configuration item. When setting conflicts with property configuration, setting takes precedence | iOS:✅ Android:✅ Harmony:✅ | |
| bindtap | eventhandle | No | Triggered when the map is clicked, returns latitude and longitude information | iOS:✅ Android:✅ Harmony:✅ | |
| bindmarkertap | eventhandle | No | Triggered when a marker is clicked, e.detail = {markerId} | iOS:✅ Android:✅ Harmony:✅ | |
| bindlabeltap | eventhandle | No | Triggered when label is clicked, e.detail = {markerId} | iOS:❌ Android:❌ Harmony:❌ | |
| bindcontroltap | eventhandle | No | Triggered when a control is clicked, e.detail = {controlId} | iOS:❌ Android:❌ Harmony:❌ | |
| bindcallouttap | eventhandle | No | Triggered when the bubble corresponding to the marker is clicked, e.detail = {markerId} | iOS:✅ Android:✅ Harmony:✅ | |
| bindupdated | eventhandle | No | Triggered when the map rendering update is completed | iOS:✅ Only triggered when the map loading is completed Android:✅ Only triggered when the map loading is completed Harmony:✅ Only triggered when the map loading is completed | |
| bindregionchange | eventhandle | No | Triggered when the field of view changes | iOS:✅ Android:✅ Harmony:✅ | |
| bindpoitap | eventhandle | No | Triggered when a POI point on the map is clicked, e.detail = {name, longitude, latitude} | iOS:✅ Android:✅ Harmony:❌ | |
| bindanchorpointtap | eventhandle | No | Triggered when the positioning mark is clicked, e.detail = {longitude, latitude} | iOS:✅ Android:✅ Harmony:❌ |
# Marker
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Marker ID | number | No | This ID will be returned in the marker click event callback. | iOS:✅ Android:✅ Harmony:✅ |
| clusterId | Cluster ID | number | No | Used for custom point clustering effect | iOS:✅ Android:✅ Harmony:❌ |
| joinCluster | Whether to participate in point clustering | Boolean | No | Default does not participate in point clustering | iOS:❌ Android:✅ Harmony:❌ |
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | iOS:✅ Android:✅ Harmony:✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | iOS:✅ Android:✅ Harmony:✅ |
| title | Annotation name | string | No | Displayed on click, ignored if callout exists | iOS:✅ Android:✅ Harmony:✅ |
| zIndex | Display level | number | No | iOS:✅ Android:✅ Harmony:✅ | |
| iconPath | Displayed icon | string | Yes | Image path in the project directory, supports network path, local path, code package path | iOS:✅ Android:✅ Harmony:✅ |
| rotate | Rotation angle | number | No | Clockwise rotation angle, range 0 ~ 360, default is 0 | iOS:❌ Android:✅ Harmony:✅ |
| alpha | Marker transparency | number | No | Default 1, no transparency, range 0 ~ 1 | iOS:❌ Android:✅ Harmony:✅ |
| width | Marker icon width | number/string | No | Default is the actual width of the image | iOS:✅ Android:✅ Harmony:✅ |
| height | Marker icon height | number | No | Default is the actual height of the image | iOS:✅ Android:✅ Harmony:✅ |
| callout | Bubble window above the marker | Object | No | Supported attributes see table below, recognizes newline characters. | iOS:✅ Android:✅ Harmony:✅ |
| customCallout | Marker | object | No | iOS:✅ Android:✅ Harmony:✅ | |
| label | Adds a label next to the marker | Object | No | Supported attributes see table below, recognizes newline characters. | iOS:❌ Android:❌ Harmony:❌ |
| anchor | Anchor point of latitude and longitude on the annotation icon, default is bottom center | Object | No | {x, y}, x represents horizontal (0-1), y represents vertical (0-1). {x: .5, y: 1} means bottom center | iOS:✅ Android:✅ Harmony:❌ |
| aria-label | Accessibility description | string | No | iOS:❌ Android:❌ Harmony:❌ | |
| displayWithCallout | Whether to display callout/customCallout/title as marker icon | Boolean | No | Displays callout/customCallout/title as marker icon, making callout/customCallout/title always visible | iOS:✅ Android:✅ Harmony:✅ |
# Callout Bubble on Marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:✅ Android:✅ Harmony:✅ | |
| color | Text color | string | iOS:✅ Android:✅ Harmony:✅ | |
| fontSize | Font size | number | iOS:✅ Android:✅ Harmony:✅ | |
| borderRadius | Border radius | number | iOS:✅ Android:✅ Harmony:✅ | |
| borderWidth | Border width | string | iOS:✅ Android:✅ Harmony:✅ | |
| borderColor | Border color | string | iOS:✅ Android:✅ Harmony:✅ | |
| bgColor | Background color | string | iOS:✅ Android:✅ Harmony:✅ | |
| padding | Text padding | number | iOS:✅ Android:✅ Harmony:✅ | |
| display | 'BYCLICK': Show on click; 'ALWAYS': Always visible | string | iOS:✅ Android:✅ Harmony:✅ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:✅ Android:✅ Harmony:✅ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:❌ Harmony:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ Harmony:✅ |
# Custom Callout Bubble on Marker
When customCallout exists, it will ignore the callout and title attributes. The custom callout uses cover-view for customization, offering higher flexibility.
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| display | 'BYCLICK': Show on click; 'ALWAYS': Always visible | string | iOS:✅ Android:✅ Harmony:✅ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:❌ Harmony:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ Harmony:✅ |
Usage is as follows: Add a slot node named callout under the map component. The internal cover-view binds with the marker via the marker-id attribute. When the marker is created, the content displayed by this cover-view will appear as the callout above the marker point.
<map>
<cover-view slot="callout">
<cover-view marker-id="1"></cover-view>
<cover-view marker-id="2"></cover-view>
<cover-view marker-id="3"></cover-view>
</cover-view>
</map>
# Label Bubble on Marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:❌ Android:❌ Harmony:❌ | |
| color | Text color | string | iOS:❌ Android:❌ Harmony:❌ | |
| fontSize | Font size | number | iOS:❌ Android:❌ Harmony:❌ | |
| anchorX | Label's coordinate, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ Harmony:❌ | |
| anchorY | Label's coordinate, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ Harmony:❌ | |
| borderWidth | Border width | number | iOS:❌ Android:❌ Harmony:❌ | |
| borderColor | Border color | string | iOS:❌ Android:❌ Harmony:❌ | |
| borderRadius | Border radius | number | iOS:❌ Android:❌ Harmony:❌ | |
| bgColor | Background color | string | iOS:❌ Android:❌ Harmony:❌ | |
| padding | Text padding | number | iOS:❌ Android:❌ Harmony:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:❌ Android:❌ Harmony:❌ |
# Polyline
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ Harmony:✅ |
| color | Line color | string | No | Hexadecimal | iOS:✅ Android:✅ Harmony:✅ |
| colorList | Rainbow line | array | No | If present, ignores the color value | iOS:✅ Android:✅ Harmony:✅ |
| width | Line width | number | No | iOS:✅ Android:✅ Harmony:✅ | |
| dottedLine | Whether dashed line | boolean | No | Default false | iOS:❌ Android:✅ Harmony:✅ |
| arrowLine | Line with arrow | boolean | No | Default false | iOS:❌ Android:✅ Harmony:❌ |
| arrowIconPath | Change arrow icon | string | No | Effective when arrowLine is true | iOS:✅ Android:✅ Harmony:❌ |
| borderColor | Line border color | string | No | iOS:❌ Android:❌ Harmony:✅ | |
| borderWidth | Line thickness | number | No | iOS:❌ Android:❌ Harmony:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:❌ Harmony:❌ |
# Polygon
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ Harmony:✅ |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ Harmony:✅ | |
| strokeColor | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ Harmony:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ Harmony:✅ |
| zIndex | Z-axis value for the polygon | number | No | iOS:✅ Android:✅ Harmony:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:❌ Harmony:❌ |
# circle
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| latitude | Latitude | number | Yes | Floating point number, range -90 ~ 90 | iOS:✅ Android:✅ Harmony:✅ |
| longitude | Longitude | number | Yes | Floating point number, range -180 ~ 180 | iOS:✅ Android:✅ Harmony:✅ |
| color | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ Harmony:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ Harmony:✅ |
| radius | Radius | number | Yes | iOS:✅ Android:✅ Harmony:✅ | |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ Harmony:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:❌ Android:❌ Harmony:❌ |
# control
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Control ID | number | No | This ID will be returned in the control click event callback | iOS:❌ Android:❌ Harmony:❌ |
| position | Position of the control on the map | object | Yes | Relative position to the map | iOS:❌ Android:❌ Harmony:❌ |
| iconPath | Displayed icon | string | Yes | Image path in the project directory, supports local path, code package path | iOS:❌ Android:❌ Harmony:❌ |
| clickable | Whether it's clickable | boolean | No | Default is not clickable | iOS:❌ Android:❌ Harmony:❌ |
# position
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| left | Distance from the left boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ Harmony:❌ |
| top | Distance from the top boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ Harmony:❌ |
| width | Control width | number | No | Default is 0 | iOS:❌ Android:❌ Harmony:❌ |
| height | Control height | number | No | Default is 0 | iOS:❌ Android:❌ Harmony:❌ |
# Tencent Map (Only supported on iOS and Android)
| Attribute | Type | Default Value | Required | Description | Support |
|---|---|---|---|---|---|
| longitude | number | 116.46 | Yes | Center longitude | iOS:✅ Android:✅ |
| latitude | number | 39.92 | Yes | Center latitude | iOS:✅ Android:✅ |
| scale | number | 16 | No | Zoom level, range is 3-20 | iOS:✅ Android:✅ |
| min-scale | number | 3 | No | Minimum zoom level | iOS:✅ Android:✅ |
| max-scale | number | 20 | No | Maximum zoom level | iOS:✅ Android:✅ |
| markers | Array.marker | No | Markers | iOS:✅ Android:✅ | |
| polyline | Array.polyline | No | Routes | iOS:✅ Android:✅ | |
| circles | Array.circle | No | Circles | iOS:✅ Android:✅ | |
| controls | Array.control | No | Controls (to be deprecated, recommend using cover-view instead) | iOS:❌ Android:❌ | |
| include-points | Array.point | No | Zoom to include all given coordinate points | iOS:✅ Android:✅ | |
| show-location | boolean | false | No | Show current location with direction | iOS:✅ Android:✅ |
| polygons | Array.polygon | No | Polygons | iOS:✅ Android:✅ | |
| subkey | - | No | Custom map not supported yet | iOS:❌ Android:❌ | |
| layer-style | - | No | Custom map not supported yet | iOS:❌ Android:❌ | |
| rotate | number | 0 | No | Rotation angle, range 0 ~ 360, angle between map north and device y-axis | iOS:✅ Android:✅ |
| skew | number | 0 | No | Tilt angle, range 0 ~ 40, tilt around z-axis | iOS:✅ Android:✅ |
| enable-3D | boolean | false | No | Display 3D buildings | iOS:✅ Android:✅ |
| show-compass | boolean | false | No | Show compass (iOS default enabled, cannot be disabled) | iOS:✅ Android:✅ |
| show-scale | boolean | false | No | Show scale bar | iOS:✅ Android:✅ |
| enable-overlooking | boolean | false | No | Enable bird's eye view | iOS:✅ Android:✅ |
| enable-zoom | boolean | true | No | Whether zooming is supported | iOS:✅ Android:✅ |
| enable-scroll | boolean | true | No | Whether dragging is supported | iOS:✅ Android:✅ |
| enable-rotate | boolean | false | No | Whether rotation is supported | iOS:✅ Android:✅ |
| enable-satellite | boolean | false | No | Whether satellite view is enabled | iOS:✅ Android:✅ |
| enable-traffic | boolean | false | No | Whether real-time traffic is enabled | iOS:✅ Android:✅ |
| enable-poi | boolean | true | No | Whether POI points are displayed | iOS:✅ Android:✅ |
| enable-building | boolean | No | Whether buildings are displayed | iOS:✅ Android:✅ | |
| setting | object | No | Configuration item; when setting content conflicts with property configuration, setting takes precedence | iOS:✅ Android:✅ | |
| bindtap | eventhandle | No | Triggered when the map is clicked, returns latitude and longitude information | iOS:✅ Android:✅ | |
| bindmarkertap | eventhandle | No | Triggered when a marker is clicked, e.detail = {markerId} | iOS:✅ Android:✅ | |
| bindlabeltap | eventhandle | No | Triggered when a label is clicked, e.detail = {markerId} | iOS:❌ Android:❌ | |
| bindcontroltap | eventhandle | No | Triggered when a control is clicked, e.detail = {controlId} | iOS:❌ Android:❌ | |
| bindcallouttap | eventhandle | No | Triggered when the bubble corresponding to a marker is clicked, e.detail = {markerId} (iOS only triggers on first click) | iOS:✅ Android:✅ | |
| bindupdated | eventhandle | No | Triggered when map rendering update is completed | iOS:✅ Only triggered when map loading is completed Android:✅ Only triggered when map loading is completed | |
| bindregionchange | eventhandle | No | Triggered when the field of view changes | iOS:✅ Android:✅ | |
| bindpoitap | eventhandle | No | Triggered when a POI point on the map is clicked, e.detail = {name, longitude, latitude} | iOS:✅ Android:✅ | |
| bindanchorpointtap | eventhandle | No | Triggered when the positioning marker is clicked, e.detail = {longitude, latitude} | iOS:✅ Android:✅ |
# marker
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Marker ID | number | No | This ID will be returned in the marker click event callback. | iOS:✅ Android:✅ |
| clusterId | Cluster ID | number | No | Used for custom point clustering effect | iOS:✅ Android:✅ |
| joinCluster | Whether to participate in point clustering | Boolean | No | Default does not participate in point clustering | iOS:❌ Android:✅ |
| latitude | Latitude | number | Yes | Floating point number, range -90 ~ 90 | iOS:✅ Android:✅ |
| longitude | Longitude | number | Yes | Floating point number, range -180 ~ 180 | iOS:✅ Android:✅ |
| title | Annotation name | string | No | Displayed on click, ignored if callout exists | iOS:✅ Android:✅ |
| zIndex | Display level | number | No | iOS:✅ Android:✅ | |
| iconPath | Displayed icon | string | Yes | Image path in the project directory, supports network path, local path, code package path | iOS:✅ Android:✅ |
| rotate | Rotation angle | number | No | Clockwise rotation angle, range 0 ~ 360, default is 0 | iOS:✅ Android:✅ |
| alpha | Transparency of the annotation | number | No | Default is 1, no transparency, range 0 ~ 1 | iOS:✅ Android:✅ |
| width | Width of the annotation icon | number/string | No | Default is the actual width of the image | iOS:✅ Android:✅ |
| height | Height of the marker | number | No | Default is the actual height of the image | iOS:✅ Android:✅ |
| callout | Bubble window above the marker | Object | No | Supported attributes see table below, recognizes line breaks. | iOS:✅ Android:✅ |
| customCallout | Marker | object | No | iOS:✅ Android:✅ | |
| label | Add a label next to the marker | Object | No | Supported attributes see table below, recognizes line breaks. | iOS:❌ Android:❌ |
| anchor | Anchor point of latitude and longitude on the annotation icon, default is bottom center | Object | No | {x, y}, x represents horizontal (0-1), y represents vertical (0-1). {x: .5, y: 1} means bottom center | iOS:✅ Android:✅ |
| aria-label | Accessibility description | string | No | iOS:❌ Android:❌ | |
| displayWithCallout | Whether to display callout/customCallout/title as marker icon | Boolean | No | Display callout/customCallout/title as marker icon, making callout/customCallout/title always visible | iOS:✅ Android:✅ IDE:❌ |
# Bubble callout on marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:✅ Android:✅ | |
| color | Text color | string | iOS:✅ Android:✅ | |
| fontSize | Font size | number | iOS:✅ Android:✅ | |
| borderRadius | Border radius | number | iOS:✅ Android:✅ | |
| borderWidth | Border width | string | iOS:✅ Android:✅ | |
| borderColor | Border color | string | iOS:✅ Android:✅ | |
| bgColor | Background color | string | iOS:✅ Android:✅ | |
| padding | Padding around text | number | iOS:✅ Android:✅ | |
| display | 'BYCLICK': Click to display; 'ALWAYS': Always display | string | iOS:✅ Android:✅ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:✅ Android:✅ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ |
# Custom bubble customCallout on marker
When customCallout exists, the callout and title attributes will be ignored. The custom bubble uses cover-view for customization, offering higher flexibility.
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| display | 'BYCLICK': Click to display; 'ALWAYS': Always display | string | iOS:✅ Android:✅ | |
| anchorX | Horizontal offset, positive to the right | number | iOS:✅ Android:✅ | |
| anchorY | Vertical offset, positive downwards | number | iOS:✅ Android:✅ |
Usage is as follows: add a slot node named callout under the map component, and its internal cover-view binds to the marker through the marker-id attribute. When the marker is created, the content displayed by this cover-view will appear as a callout above the marker.
<map>
<cover-view slot="callout">
<cover-view marker-id="1"></cover-view>
<cover-view marker-id="2"></cover-view>
<cover-view marker-id="3"></cover-view>
</cover-view>
</map>
# Label bubble on marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | iOS:❌ Android:❌ | |
| color | Text color | string | iOS:❌ Android:❌ | |
| fontSize | Font size | number | iOS:❌ Android:❌ | |
| anchorX | Coordinates of the label, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ | |
| anchorY | Coordinates of the label, origin is the latitude and longitude corresponding to the marker | number | iOS:❌ Android:❌ | |
| borderWidth | Border width | number | iOS:❌ Android:❌ | |
| borderColor | Border color | string | iOS:❌ Android:❌ | |
| borderRadius | Border radius | number | iOS:❌ Android:❌ | |
| bgColor | Background color | string | iOS:❌ Android:❌ | |
| padding | Padding around text | number | iOS:❌ Android:❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | iOS:❌ Android:❌ |
# polyline
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ |
| color | Line color | string | No | Hexadecimal | iOS:✅ Android:✅ |
| colorList | Rainbow line | array | No | If present, ignores color value | iOS:✅ Android:✅ |
| width | Line width | number | No | iOS:✅ Android:✅ | |
| dottedLine | Whether dashed line | boolean | No | Default false | iOS:✅ Android:✅ |
| arrowLine | Line with arrow | boolean | No | Default false | iOS:✅ Android:✅ |
| arrowIconPath | Change arrow icon | string | No | Effective when arrowLine is true | iOS:✅ Android:✅ |
| borderColor | Line border color | string | No | iOS:✅ Android:✅ | |
| borderWidth | Line thickness | number | No | iOS:✅ Android:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:✅ Android:✅ |
# polygon
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | iOS:✅ Android:✅ |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ | |
| strokeColor | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ |
| zIndex | Z-axis value for the polygon | number | No | iOS:✅ Android:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:✅ Android:✅ |
# circle
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| latitude | Latitude | number | Yes | Floating point number, range -90 ~ 90 | iOS:✅ Android:✅ |
| longitude | Longitude | number | Yes | Floating point number, range -180 ~ 180 | iOS:✅ Android:✅ |
| color | Stroke color | string | No | Hexadecimal | iOS:✅ Android:✅ |
| fillColor | Fill color | string | No | Hexadecimal | iOS:✅ Android:✅ |
| radius | Radius | number | Yes | iOS:✅ Android:✅ | |
| strokeWidth | Stroke width | number | No | iOS:✅ Android:✅ | |
| level | Overlay relationship | string | No | Default is abovelabels | iOS:✅ Android:✅ |
# control
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Control ID | number | No | This ID will be returned in the control click event callback | iOS:❌ Android:❌ |
| position | Position of the control on the map | object | Yes | Relative position to the map | iOS:❌ Android:❌ |
| iconPath | Displayed icon | string | Yes | Image path in the project directory, supports local path, code package path | iOS:❌ Android:❌ |
| clickable | Whether it's clickable | boolean | No | Default is not clickable | iOS:❌ Android:❌ |
# position
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| left | Distance from the left boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ |
| top | Distance from the top boundary of the map | number | No | Default is 0 | iOS:❌ Android:❌ |
| width | Control width | number | No | Default is 0 | iOS:❌ Android:❌ |
| height | Control height | number | No | Default is 0 | iOS:❌ Android:❌ |
# Google Maps (Only supported on Android)
| Attribute | Type | Default Value | Required | Description | Support |
|---|---|---|---|---|---|
| longitude | number | 116.46 | Yes | Center longitude | ✅ |
| latitude | number | 39.92 | Yes | Center latitude | ✅ |
| scale | number | 16 | No | Zoom level, range is 3-20 | ✅ |
| min-scale | number | 3 | No | Minimum zoom level | ✅ |
| max-scale | number | 20 | No | Maximum zoom level | ✅ |
| markers | Array.marker | No | Markers | ✅ | |
| polyline | Array.polyline | No | Routes | ✅ | |
| circles | Array.circle | No | Circles | ✅ | |
| controls | Array.control | No | Controls (to be deprecated, recommend using cover-view instead) | ❌ | |
| include-points | Array.point | No | Zoom to include all given coordinate points | ✅ | |
| show-location | boolean | false | No | Show current location with direction | ✅ |
| polygons | Array.polygon | No | Polygons | ✅ | |
| subkey | - | No | Custom map not supported yet | ❌ | |
| layer-style | - | No | Custom map not supported yet | ❌ | |
| rotate | number | 0 | No | Rotation angle, range 0 ~ 360, angle between map north and device y-axis | ✅ |
| skew | number | 0 | No | Tilt angle, range 0 ~ 40, tilt around z-axis | ✅ |
| enable-3D | boolean | false | No | Display 3D buildings | ❌ |
| show-compass | boolean | false | No | Show compass | ✅ |
| show-scale | boolean | false | No | Show scale bar | ❌ |
| enable-overlooking | boolean | false | No | Enable bird's eye view | ✅ |
| enable-zoom | boolean | true | No | Whether zooming is supported | ✅ |
| enable-scroll | boolean | true | No | Whether dragging is supported | ✅ |
| enable-rotate | boolean | false | No | Whether rotation is supported | ✅ |
| enable-satellite | boolean | false | No | Whether satellite view is enabled | ✅ |
| enable-traffic | boolean | false | No | Whether real-time traffic is enabled | ✅ |
| enable-poi | boolean | true | No | Whether POI points are displayed | ✅ |
| enable-building | boolean | No | Whether buildings are displayed | ✅ | |
| setting | object | No | Configuration item; when setting content conflicts with property configuration, setting takes precedence | ✅ | |
| bindtap | eventhandle | No | Triggered when the map is clicked, returns latitude and longitude information | ✅ | |
| bindmarkertap | eventhandle | No | Triggered when a marker is clicked, e.detail = {markerId} | ✅ | |
| bindlabeltap | eventhandle | No | Triggered when a label is clicked, e.detail = {markerId} | ❌ | |
| bindcontroltap | eventhandle | No | Triggered when a control is clicked, e.detail = {controlId} | ❌ | |
| bindcallouttap | eventhandle | No | Triggered when the bubble corresponding to a marker is clicked, e.detail = {markerId} | ✅ | |
| bindupdated | eventhandle | No | Triggered when map rendering update is completed | ✅ Only triggered when map loading is completed | |
| bindregionchange | eventhandle | No | Triggered when the field of view changes | ✅ | |
| bindpoitap | eventhandle | No | Triggered when a POI point on the map is clicked, e.detail = {name, longitude, latitude} | ✅ | |
| bindanchorpointtap | eventhandle | No | Triggered when the positioning marker is clicked, e.detail = {longitude, latitude} | ✅ |
# marker
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Marker point ID | number | No | The marker's click event callback will return this ID. | ✅ |
| clusterId | Cluster ID | number | No | Used for custom point clustering effects | ✅ |
| joinCluster | Whether to participate in point clustering | Boolean | No | Defaults to not participating in point clustering | ✅ |
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | ✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | ✅ |
| title | Annotation point name | string | No | Displayed when clicked; ignored if callout exists | ✅ |
| zIndex | Display level | number | No | ✅ | |
| iconPath | Displayed icon | string | Yes | Image path under the project directory, supports network paths, local paths, and code package paths | ✅ |
| rotate | Rotation angle | number | No | Clockwise rotation angle, range 0 ~ 360, default is 0 | ✅ |
| alpha | Transparency of the annotation | number | No | Default is 1 (no transparency), range 0 ~ 1 | ✅ |
| width | Width of the annotation icon | number/string | No | Defaults to the actual width of the image | ✅ |
| height | Marker point | number | No | Defaults to the actual height of the image | ✅ |
| callout | Bubble window above the marker point | Object | No | Supported attributes are shown in the table below; recognizes line breaks. | ✅ |
| customCallout | Marker point | object | No | ✅ | |
| label | Adds a label next to the marker point | Object | No | Supported attributes are shown in the table below; recognizes line breaks. | ❌ |
| anchor | Anchor point of latitude and longitude on the annotation icon, defaults to the midpoint of the bottom edge | Object | No | {x, y}, where x represents horizontal (0-1) and y represents vertical (0-1). {x: .5, y: 1} indicates the midpoint of the bottom edge | ✅ |
| aria-label | Accessibility description (additional description of the element) | string | No | ❌ |
# Bubble callout on marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | ✅ | |
| color | Text color | string | ✅ | |
| fontSize | Font size | number | ✅ | |
| borderRadius | Border radius | number | ✅ | |
| borderWidth | Border width | string | ✅ | |
| borderColor | Border color | string | ✅ | |
| bgColor | Background color | string | ✅ | |
| padding | Text margin | number | ✅ | |
| display | 'BYCLICK': show on click; 'ALWAYS': always visible | string | ❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | ✅ | |
| anchorX | Horizontal offset, positive to the right | number | ✅ | |
| anchorY | Vertical offset, positive downward | number | ✅ |
# Custom bubble customCallout on marker
When customCallout exists, the callout and title attributes will be ignored. Custom bubbles use cover-view for customization, offering higher flexibility.
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| display | 'BYCLICK': show on click; 'ALWAYS': always visible | string | ❌ | |
| anchorX | Horizontal offset, positive to the right | number | ✅ | |
| anchorY | Vertical offset, positive downward | number | ✅ |
Usage is as follows: Add a slot node named callout under the map component. The internal cover-view is bound to the marker via the marker-id attribute. When the marker is created, the content displayed by this cover-view will appear as the callout above the marker point.
<map>
<cover-view slot="callout">
<cover-view marker-id="1"></cover-view>
<cover-view marker-id="2"></cover-view>
<cover-view marker-id="3"></cover-view>
</cover-view>
</map>
# Label bubble on marker
| Attribute | Description | Type | Remarks | Support |
|---|---|---|---|---|
| content | Text | string | ❌ | |
| color | Text color | string | ❌ | |
| fontSize | Font size | number | ❌ | |
| anchorX | Label coordinates, origin is the latitude and longitude corresponding to the marker | number | ❌ | |
| anchorY | Label coordinates, origin is the latitude and longitude corresponding to the marker | number | ❌ | |
| borderWidth | Border width | number | ❌ | |
| borderColor | Border color | string | ❌ | |
| borderRadius | Border radius | number | ❌ | |
| bgColor | Background color | string | ❌ | |
| padding | Text margin | number | ❌ | |
| textAlign | Text alignment. Valid values: left, right, center | string | ❌ |
# polyline
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | ✅ |
| color | Line color | string | No | Hexadecimal | ✅ |
| colorList | Rainbow line | array | No | If present, the color value is ignored | ❌ |
| width | Line width | number | No | ✅ | |
| dottedLine | Whether it is a dashed line | boolean | No | Defaults to false | ❌ |
| arrowLine | Line with an arrow | boolean | No | Defaults to false | ❌ |
| arrowIconPath | Change arrow icon | string | No | Takes effect when arrowLine is true | ❌ |
| borderColor | Line border color | string | No | ❌ | |
| borderWidth | Line thickness | number | No | ❌ | |
| level | Overlap relationship | string | No | Defaults to abovelabels | ❌ |
# polygon
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| points | Array of latitude and longitude | array | Yes | [{latitude: 0, longitude: 0}] | ✅ |
| strokeWidth | Stroke width | number | No | ✅ | |
| strokeColor | Stroke color | string | No | Hexadecimal | ✅ |
| fillColor | Fill color | string | No | Hexadecimal | ✅ |
| zIndex | Set Z-axis value for the polygon | number | No | ✅ | |
| level | Overlap relationship | string | No | Defaults to abovelabels | ❌ |
# circle
| Attribute | Description | Type | Required | Remarks | Other |
|---|---|---|---|---|---|
| latitude | Latitude | number | Yes | Floating-point number, range -90 ~ 90 | ✅ |
| longitude | Longitude | number | Yes | Floating-point number, range -180 ~ 180 | ✅ |
| color | Stroke color | string | No | Hexadecimal | ✅ |
| fillColor | Fill color | string | No | Hexadecimal | ✅ |
| radius | Radius | number | Yes | ✅ | |
| strokeWidth | Stroke width | number | No | ✅ | |
| level | Overlap relationship | string | No | Defaults to abovelabels | ❌ |
# control
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| id | Control ID | number | No | The control's click event callback will return this ID | ❌ |
| position | Position of the control on the map | object | Yes | Relative position of the control on the map | ❌ |
| iconPath | Displayed icon | string | Yes | Image path under the project directory, supports local paths and code package paths | ❌ |
| clickable | Whether it is clickable | boolean | No | Defaults to not clickable | ❌ |
# position
| Attribute | Description | Type | Required | Remarks | Support |
|---|---|---|---|---|---|
| left | Distance from the left boundary of the map | number | No | Defaults to 0 | ❌ |
| top | Distance from the top boundary of the map | number | No | Defaults to 0 | ❌ |
| width | Control width | number | No | Defaults to 0 | ❌ |
| height | Control height | number | No | Defaults to 0 | ❌ |