# colorLegend

Tilemap: show the colour-axis gradient legend (on while the axis is on).

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

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

## Definition

| Item | Value |
| --- | --- |
| JavaScript property | `colorLegend` |
| HTML attribute | `color-legend` |
| Type | `boolean` |
| Default | `undefined` |

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

<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-tilemap](https://chart.syidax.com/docs/components/tilemap.md#property-colorLegend)