# colorAxis

Tilemap: value→colour axis (`true`/`'auto'`/object). Property-only; off by default.

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

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

## Definition

| Item | Value |
| --- | --- |
| JavaScript property | `colorAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `TilemapColorAxisInput` |
| Default | `undefined` |
| Literals in the type | `auto` |

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

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

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

## Configuration example

```javascript
// Register sy-tilemap and create the element before configuring it.
chart.colorAxis = "auto";
```

- [Tilemap · Complete examples and API](https://chart.syidax.com/docs/components/tilemap.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-tilemap](https://chart.syidax.com/docs/components/tilemap.md#property-colorAxis)
- [sy-wafer-map](https://chart.syidax.com/docs/components/wafer-map.md#property-colorAxis)
- [sy-wafer-stack](https://chart.syidax.com/docs/components/wafer-stack.md#property-colorAxis)
- [sy-wafer-correlation](https://chart.syidax.com/docs/components/wafer-correlation.md#property-colorAxis)
