# mapBackground

Geo Map: bundled Natural Earth land/coastlines, or no background.

Canonical: https://chart.syidax.com/docs/options/mapBackground/

<a id="definition"></a>

## Definition

| Item | Value |
| --- | --- |
| JavaScript property | `mapBackground` |
| HTML attribute | `map-background` |
| Type | `GeoMapBackground` |
| Default | `undefined` |
| Allowed values | `none`, `natural-earth` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GeoMapBackground](https://chart.syidax.com/docs/types/GeoMapBackground.md) — Type definition

<a id="example"></a>

## Configuration example

```javascript
// Register sy-geo-map and create the element before configuring it.
chart.mapBackground = "natural-earth";
```

- [Geo Map · Complete examples and API](https://chart.syidax.com/docs/components/geo-map.md)

<a id="related"></a>

## Related documentation

A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below.

- [Shared facade and direct tags](https://chart.syidax.com/docs/concepts.md)
- [sy-geo-map](https://chart.syidax.com/docs/components/geo-map.md#property-mapBackground)
- [sy-flow-lines](https://chart.syidax.com/docs/components/flow-lines.md#property-mapBackground)
