shootismoke/common

[@shootismoke/convert](../README.md) / [Exports](../modules.md) / PollutantMeta

# Interface: PollutantMeta

Metadata for each pollutant.

## Table of contents

### Properties

- [description](PollutantMeta.md#description)
- [displayName](PollutantMeta.md#displayname)
- [isCore](PollutantMeta.md#iscore)
- [maxColorValue](PollutantMeta.md#maxcolorvalue)
- [name](PollutantMeta.md#name)
- [preferredUnit](PollutantMeta.md#preferredunit)

## Properties

### description

• **description**: `string`

#### Defined in

[util/pollutant.ts:35](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L35)

___

### displayName

• **displayName**: `string`

#### Defined in

[util/pollutant.ts:34](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L34)

___

### isCore

• **isCore**: `boolean`

#### Defined in

[util/pollutant.ts:37](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L37)

___

### maxColorValue

• **maxColorValue**: ``null`` \| `number`

#### Defined in

[util/pollutant.ts:38](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L38)

___

### name

• **name**: [`Pollutant`](../modules.md#pollutant)

#### Defined in

[util/pollutant.ts:33](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L33)

___

### preferredUnit

• **preferredUnit**: [`Unit`](../modules.md#unit)

#### Defined in

[util/pollutant.ts:36](https://github.com/shootismoke/common//blob/dff4dfe/packages/convert/src/util/pollutant.ts#L36)