[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [util](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util) / [DiscreteGradientColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider) / DiscreteGradientColorProvider
# Class: DiscreteGradientColorProvider
[util](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util).[DiscreteGradientColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider).DiscreteGradientColorProvider
This class implements a colorprovider that use discretization to emulate a gradient.
It's main purpose is to simplify a gradient by reducing the amount of possible colors (mostly for performance reasons).
The discretization process can be controlled through the given 'bins' parameter that defines how many discrete colors will be used.
**`Example`**
```ts
// Discrete Gradient Color Provider allows for limited number of bins
const discreteCP = new DiscreteGradientColorProvider({
'values' : [ -2 , -1 , 0 , 1 , 2 ],
'colors' : ['orange', 'yellow', 'blue', 'green', 'gray']
'bins': 16
});
```
## Hierarchy
- [`DefaultColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider)
↳ **`DiscreteGradientColorProvider`**
↳↳ [`ColorMap`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.contour.util-2.colormap.colormap)
↳↳ [`LogColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.logcolorprovider.logcolorprovider)
## Table of contents
Constructors
- [new DiscreteGradientColorProvider(values, colors, bins)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider.md#new discretegradientcolorprovider(values, colors, bins))
Methods
| [addColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#addcolor) | [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#clone) | [copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#copyconstructor) |
| --- | --- | --- |
| [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#dispose) | [exportToImage](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#exporttoimage) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getclassname) |
| [getColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getcolor) | [getColorNumber](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getcolornumber) | [getColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getcolors) |
| [getColorsProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getcolorsproperties) | [getDataMaxValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getdatamaxvalue) | [getDataMinValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getdataminvalue) |
| [getMaxValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getmaxvalue) | [getMinValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getminvalue) | [getNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getnamedcolor) |
| [getNamedColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getnamedcolors) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getproperties) | [getRaster](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getraster) |
| [getScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getscale) | [getStopPoints](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getstoppoints) | [getValues](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getvalues) |
| [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#haseventlistener) | [hasNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#hasnamedcolor) | [invalidate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#invalidate) |
| [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#isdisposed) | [isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#isnotificationenabled) | [isReversed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#isreversed) |
| [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#issilent) | [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#off) |
| [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#on) | [removeColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#removecolor) | [reverse](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#reverse) |
| [scaleTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#scaleto) | [setColorNumber](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setcolornumber) | [setColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setcolors) |
| [setNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setnamedcolor) | [setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setnotification) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setproperties) |
| [setScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setscale) | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#setsilent) | [fromObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#fromobject) |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getclassname-1) | [getColorProviderType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider#getcolorprovidertype) |
Css Properties
| Name | Type | Description |
| --- | --- | --- |
| `bins` | `number` | Number of bins |
| `max` | `number` | |
| `max` | `number` | End value for the scale |
| `min` | `number` | |
| `min` | `number` | Start value for the scale |
| `reversed` | `boolean` | Boolean to define the sorting direction |
| `scale` | [`KnownScales`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#knownscales) | |
| `scale` | [`KnownScales`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#knownscales) | A predefined set of colors |
## Contents
Constructors
#### new DiscreteGradientColorProvider(values, colors, bins)
• **new DiscreteGradientColorProvider**(`values?`, `colors?`, `bins?`)
Creates color provider
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `values` | `number`[] | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider#options) | list of values |
| `Optional` `colors` | (`string` | [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor))[] | list of colors |
| `Optional` `bins` | `number` | number of bins |
#### Overrides
DefaultColorProvider.constructor
Methods
#### addColor
▸ **addColor**(`value`, `color`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Add color to the collection
Compatibility: old JSON format `{'value': 0, 'red': 255, 'green': 255, 'blue': 255, 'alpha': 1}` is supported,
but new parameter list is recommended
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `value` | `number` | index of this color on the colorbar |
| `color` | `string` | [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor) | CSS color string or RgbaColor object |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[addColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#addcolor)
▸ **addColor**(`json`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
**`Deprecated`**
#### Parameters
| Name | Type |
| --- | --- |
| `json` | `Object` |
| `Optional` `json.alpha` | `number` |
| `Optional` `json.blue` | `number` |
| `json.color` | `string` | [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor) |
| `Optional` `json.green` | `number` |
| `Optional` `json.red` | `number` |
| `json.value` | `number` |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[addColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#addcolor)
#### clone
▸ **clone**(): [`ColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.colorprovider.colorprovider)
Returns clone of color provider
#### Returns
[`ColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.colorprovider.colorprovider)
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#clone)
#### copyConstructor
▸ `Protected` **copyConstructor**(`src`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Copy constructor
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `src` | [`ColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.colorprovider.colorprovider) | Source to copy from |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#copyconstructor)
#### dispose
▸ **dispose**(): `void`
Dispose.
#### Returns
`void`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#dispose)
#### exportToImage
▸ **exportToImage**(`width`, `height`, `isVertical`, `surface?`): [`Surface`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.surface.surface)
returns surface that represents color map
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `width` | `number` | The image width |
| `height` | `number` | The image height |
| `isVertical` | `boolean` | True if image is oriented vertically |
| `Optional` `surface` | [`Surface`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.surface.surface) | output surface |
#### Returns
[`Surface`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.surface.surface)
surface The canvas surface
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[exportToImage](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#exporttoimage)
#### getClassName
▸ **getClassName**(): `string`
#### Returns
`string`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getclassname)
#### getColor
▸ **getColor**(`value`): [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor)
Return color for the current value
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `value` | `number` | value |
#### Returns
[`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor)
color
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getcolor)
#### getColorNumber
▸ **getColorNumber**(): `number`
Returns how many colors can be provided
#### Returns
`number`
#### getColors
▸ **getColors**(): [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor)[]
#### Returns
[`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor)[]
an array of the colors
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getcolors)
#### getColorsProperties
▸ `Protected` **getColorsProperties**(): [`ColorsOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#defaultcolorprovider#colorsoptions)
Returns colors and values to be serialized
#### Returns
[`ColorsOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#defaultcolorprovider#colorsoptions)
colors and values
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getColorsProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getcolorsproperties)
#### getDataMaxValue
▸ `Protected` **getDataMaxValue**(): `number`
Returns the maximum data value set in this collection
#### Returns
`number`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getDataMaxValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getdatamaxvalue)
#### getDataMinValue
▸ `Protected` **getDataMinValue**(): `number`
Returns the minimum data value set in this collection
#### Returns
`number`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getDataMinValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getdataminvalue)
#### getMaxValue
▸ **getMaxValue**(): `number`
Returns the maximum value set in this collection
#### Returns
`number`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getMaxValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getmaxvalue)
#### getMinValue
▸ **getMinValue**(): `number`
Returns minimum value set in the collection
#### Returns
`number`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getMinValue](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getminvalue)
#### getNamedColor
▸ **getNamedColor**(`colorName`): `string` | [`NamedColorValue`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#namedcolorvalue)
Returns known color value
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `colorName` | `string` | color name, if not specified then returns list of known colors |
#### Returns
`string` | [`NamedColorValue`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#namedcolorvalue)
color
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getnamedcolor)
#### getNamedColors
▸ **getNamedColors**(): [`NamedColor`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#namedcolor)[]
Returns known colors
#### Returns
[`NamedColor`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#namedcolor)[]
array of color pair
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getNamedColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getnamedcolors)
#### getProperties
▸ **getProperties**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider#optionsout)
get Properties
#### Returns
[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider#optionsout)
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getproperties)
#### getRaster
▸ **getRaster**(`xMin?`, `yMin?`, `xMax?`, `yMax?`): [`Raster`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.raster.raster)
Returns a new instance of [Raster](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.raster.raster)
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `xMin` | `number` | x Min position to get color |
| `Optional` `yMin` | `number` | y Min position to get color |
| `Optional` `xMax` | `number` | x Max position to get color |
| `Optional` `yMax` | `number` | y Max position to get color |
#### Returns
[`Raster`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.raster.raster)
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getRaster](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getraster)
#### getScale
▸ **getScale**(): [`KnownScales`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#knownscales)
#### Returns
[`KnownScales`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#knownscales)
scale scale being used
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getscale)
#### getStopPoints
▸ **getStopPoints**(): { `color`: `string` ; `value`: `number` }[]
#### Returns
{ `color`: `string` ; `value`: `number` }[]
an array of the `{color,values}` couples
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getStopPoints](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getstoppoints)
#### getValues
▸ **getValues**(): `number`[]
Always return a reference to sorted array of values.
Don't change this array.
#### Returns
`number`[]
an array of the values
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getValues](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getvalues)
#### hasEventListener
▸ **hasEventListener**(`type`, `callback?`): `boolean`
Check if a list of event listeners for this type contains this listener
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `type` | `string` | type of event or property |
| `Optional` `callback` | `Function` | to be called, if null, check if any callback is registered |
#### Returns
`boolean`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#haseventlistener)
#### hasNamedColor
▸ **hasNamedColor**(`colorName`): `boolean`
Check if specified named color exists
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `colorName` | `string` | color name |
#### Returns
`boolean`
true if color exists
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[hasNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#hasnamedcolor)
#### invalidate
▸ **invalidate**(): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Invalidate Default ColorProvider and notify visuals for update
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[invalidate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#invalidate)
#### isDisposed
▸ **isDisposed**(): `boolean`
Returns whether this object has been disposed
#### Returns
`boolean`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#isdisposed)
#### isNotificationEnabled
▸ **isNotificationEnabled**(): `boolean`
Return state of notification
#### Returns
`boolean`
current notification state
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#isnotificationenabled)
#### isReversed
▸ **isReversed**(): `boolean`
return true if the min / max is reversed
#### Returns
`boolean`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[isReversed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#isreversed)
#### isSilent
▸ **isSilent**(): `boolean`
Return true if the event dispatcher doesn't notify any events
#### Returns
`boolean`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#issilent)
#### notify
▸ **notify**<`E`>(`type`, `source`, `args?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Notify listeners
#### Type parameters
| Name | Type |
| --- | --- |
| `E` | extends `string` |
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `type` | `E` | event types |
| `source` | [`ColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.colorprovider.colorprovider) | of the event |
| `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#eventmap)[`E`] | arguments of the event |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#notify)
#### off
▸ **off**<`E`>(`type?`, `callback?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Detach listener on event.
Calling .off() with no arguments removes all attached listeners.
Calling .off(type) with no callback removes all attached listeners for specific type.
#### Type parameters
| Name | Type |
| --- | --- |
| `E` | extends `string` |
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `type` | `E` | type of the event |
| `Optional` `callback` | (`eventType`: `E`, `sender`: [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#eventmap)[`E`]) => `void` | function to be called |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#off)
#### on
▸ **on**<`E`>(`type`, `callback`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target,
the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a
certain target, and then later in the code, an identical anonymous function is given
in an "on" call, the second function will also be added to the list of
event listeners for that target.
#### Type parameters
| Name | Type |
| --- | --- |
| `E` | extends `string` |
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `type` | `E` | type of event or property |
| `callback` | (`eventType`: `E`, `sender`: [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#eventmap)[`E`]) => `void` | to be called |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#on)
#### removeColor
▸ **removeColor**(`value`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Remove color from the collection
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `value` | `number` | value to remove color |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[removeColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#removecolor)
#### reverse
▸ **reverse**(): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
reverse the axis
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[reverse](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#reverse)
#### scaleTo
▸ **scaleTo**(`start`, `end`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
set the min/max of the color provider, interpolating all values on the way.
**`Throws`**
if start or end is NaN
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `start` | `number` | Start value to use |
| `end` | `number` | End value to use |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[scaleTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#scaleto)
#### setColorNumber
▸ **setColorNumber**(`colorNumber`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Sets how many colors can be provided
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `colorNumber` | `number` | number of colors that can be provided |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### setColors
▸ **setColors**(`values`, `colors?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `values` | [`Colors`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#defaultcolorprovider#colors) | new values |
| `Optional` `colors` | (`string` | [`RgbaColor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rgbacolor.rgbacolor))[] | new colors |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setColors](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setcolors)
#### setNamedColor
▸ **setNamedColor**(`colorName`, `colorValue`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Set color value
**`Example`**
```ts
import {KnownColors} from '@int/geotoolkit/util/ColorProvider';
colorProvider.setNamedColor(KnownColors.NaN, { // set color for NaN values
'title': 'absent', // title to use when displaying, e.g. by ColorBar shape
'enabled': true, // enable state (default is not false)
'value': 'black' // color to use for NaNs
});
```
**`Example`**
```ts
// use 'red' color for values greater than maxValue (default '+∞' title is used)
colorProvider.setNamedColor(KnownColors.PositiveInfinity, 'red');
```
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `colorName` | `string` | color name |
| `colorValue` | `string` | [`NamedColorValue`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#colorprovider#namedcolorvalue) | color or title/value settings object |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setNamedColor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setnamedcolor)
#### setNotification
▸ **setNotification**(`enable`, `force?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Enable / disable notification
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `enable` | `boolean` | enable or disable notifications |
| `Optional` `force` | `boolean` | true if parent should be invalidated immediately |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setnotification)
#### setProperties
▸ **setProperties**(`properties?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
set Properties of the object
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider#options) | color provider properties |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setproperties)
#### setScale
▸ **setScale**(`scale`, `min?`, `max?`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Replace all colors in the collection by this scale
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `scale` | `string` | Scale to use |
| `Optional` `min` | `number` | Minimum to use |
| `Optional` `max` | `number` | Maximum to use |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setscale)
#### setSilent
▸ **setSilent**(`bool`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Set silent mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `bool` | `boolean` | flag to enable silent mode |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
this
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#setsilent)
#### fromObject
▸ `Static` **fromObject**(`object`): [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
Create or get DiscreteGradientColorProvider from an object
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `object` | [`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider) | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#discretegradientcolorprovider#options) | gradient provider properties or instance |
#### Returns
[`DiscreteGradientColorProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.discretegradientcolorprovider.discretegradientcolorprovider)
provider
#### Overrides
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[fromObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#fromobject)
#### getClassName
▸ `Static` **getClassName**(): `string`
#### Returns
`string`
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getclassname-1)
#### getColorProviderType
▸ `Static` **getColorProviderType**(`objectType?`): [`ClassType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.base#classtype)<`any`>
Return ColorProvider constructor from the object class name or type.
**`Deprecated`**
since 4.1 Use ColorProvider implementation directly
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `objectType` | `string` | ColorProvider class name |
#### Returns
[`ClassType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.base#classtype)<`any`>
ColorProvider constructor
#### Inherited from
[DefaultColorProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider).[getColorProviderType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.defaultcolorprovider.defaultcolorprovider#getcolorprovidertype)